ItemGroup

Layout & Structure
stable

Renderless selection container that tracks which child OrigamItem elements are selected. Single, multiple and mandatory selection modes.

Structure

Anatomie

Décomposition visuelle de la structure interne du composant avec les appels de classes BEM.

Anatomy of OrigamItemGroupSchematic of the ItemGroup renderless container with three child items. origam-item ① origam-item ② selected origam-item ③ 1 origam-item-group 2 3
Anatomy of <origam-item-group> — renderless root (①) wrapping child <origam-item> elements (②③). The selected item carries the selectedClass.
1.origam-item-group
Root element. Renderless — no visual chrome. Provides group context via ORIGAM_ITEM_GROUP_KEY.
2origam-item (unselected)
Child item not currently selected. Exposes isSelected=false to its default slot.
3origam-item (selected)
Child item that is currently selected. Receives selectedClass and exposes isSelected=true.

API

Props

Toutes les props acceptées par ce composant, avec leur type, valeur par défaut et description.

id
string
class
string | Array<string> | object
style
string | Array<string> | object | StyleValue
tag
string
'div'
Root HTML element tag.
disabled
boolean
false
Disables all items in the group.
modelValue
any
Currently selected item value(s). Bind with v-model.
multiple
boolean
false
Allows multiple items to be selected at once.
mandatory
boolean
false
Forces at least one item to remain selected. Deselecting the last item is ignored.
max
number
Maximum number of simultaneously selected items (multiple mode only).
selectedClass
string
'origam-item--selected'
CSS class injected on each OrigamItem when it is selected. Propagated down via OrigamDefaultsProvider.

API

Slots

Emplacements de contenu exposés par ce composant.

#default
Default slot. Exposes group selection helpers: isSelected(id), select(id, value), next(), prev(), selected (read-only ref).

API

Emits

Événements émis par ce composant.

@update:modelValue
any
Emitted when the selected item(s) change. Carries the new value or array of values.

API

Membres exposés

Propriétés et méthodes accessibles via ref template (defineExpose). Utilisés pour le contrôle programmatique.

<T extends object>(props: T, exclude?: string[]) => Partial<T>
Utility to forward a filtered subset of props to a child.
() => void
Selects the next item in DOM order.
() => void
Selects the previous item in DOM order.
(id: number, value: boolean) => void
Programmatically toggle the selected state of an item by its internal id.
Ref<string>
Reactive CSS string generated by useStyle.
string
Unique style-sheet ID for this instance.
() => void
Injects the computed style sheet. Called automatically on mount.
() => void
Removes the injected style sheet. Called automatically on unmount.
Ref<boolean>
True once the style sheet has been injected into the DOM.

Inclusion

Accessibilité

Rôles ARIA, navigation clavier et gestion du focus. Sourcé depuis le template réel du composant.

Interactions clavier

Interactions clavier
ToucheAction
TabMoves focus through the child items. Keyboard navigation is delegated to the rendered child elements (e.g. origam-btn with role="button").

Notes

  • OrigamItemGroup is renderless and carries no ARIA role itself. Consumers must ensure the rendered children have appropriate roles (button, tab, radio, etc.).
  • The selectedClass is injected as a CSS class — not an ARIA attribute. Consumers are responsible for mapping the selected state to aria-pressed, aria-selected or aria-checked on their child elements.

Interactif

Playground

Modifiez les props en direct et observez le composant se mettre à jour. Le snippet de code généré suit vos changements.

Rendu de l’aperçu en cours…

Usage

Exemples

Extraits de code prêts à coller dans vos templates.

Single selection

vue

Multiple selection

vue

Écosystème

Famille

Composants du même dossier qui partagent les conventions et se composent souvent ensemble.