ISelectionControlGroupProps
Props for <OrigamSelectionControlGroup>, the container that manages a group of checkboxes, radios, or switch controls. Extends commons, color, density, and ripple surfaces with group-specific props: input type, inline layout, icons, multiple selection, name grouping, readonly/disabled state, and a custom value comparator.
TypeScript
Définition
La définition TypeScript de l'interface telle que trouvée dans le code source d'origam. Cliquez sur l'icône de copie pour copier l'extrait.
Héritage
Hérite de
Interfaces parentes dont celle-ci hérite. Leurs propriétés sont disponibles pour tout consommateur de cette interface.
API
Propriétés
Chaque propriété déclarée par cette interface, avec son type, son caractère optionnel et sa valeur par défaut.
- disabledboolean
- Disables all controls in the group.
- errorstring | boolean
- Puts all controls in the error visual state.
- inlineboolean
- Lays out controls horizontally instead of vertically.
- falseIconTIcon
- Icon used for the unchecked/false state of each control.
- trueIconTIcon
- Icon used for the checked/true state of each control.
- multipleboolean
- Allows multiple items to be selected simultaneously. modelValue becomes an array.
- namestring
- Shared HTML name attribute applied to all child inputs — groups them for native form submission.
- readonlyboolean
- Makes all controls non-interactive while keeping normal visual appearance.
- modelValueany
- The current value(s) bound with v-model. A single value for single-select, an array for multiple.
- typestring
- HTML input type forwarded to each child control — "checkbox", "radio", or "switch".
- valueComparator(a: any, b: any) => boolean
- Custom equality function used to match modelValue against item values. Defaults to strict equality.
- itemsArray<any> | Record<string, any>
- Data source for generating child controls. Accepts an array of values or a key/value record.
Écosystème
Utilisé par
Composants et composables qui étendent ou consomment cette interface.
Usage
Exemples
Extraits de code prêts à coller utilisant cette interface.
Generating a checkbox group from an items array