IGroupProps
interface
Group & Selection
Props for a selectable group container — controls the v-model, multiplicity, mandatory selection and the selected-class propagated to items.
TypeScript
Definition
The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- disabledboolean
- When true, disables all items in the group preventing any selection change.
- modelValueany
- The current selection — a single value or an array in multiple mode.
- multipleboolean
- Allows more than one item to be selected at the same time.
- mandatoryboolean
- Enforces that at least one item is always selected; deselecting the last item is blocked.
- maxnumber
- Maximum number of items that can be selected simultaneously (only meaningful in multiple mode).
- selectedClassstring
- CSS class propagated to every selected item, overridable per-item via IGroupItemProps.selectedClass.
Usage
Examples
Ready-to-paste code snippets using this interface.
Extending IGroupProps on a tab bar