ChipGroup

Data Display
stable

Scrollable group of Chip elements with single or multi-select, filter support, and column layout option. Propagates color/bgColor tokens to descendant chips via OrigamDefaultsProvider.

Aperçu

Rendu de l’aperçu en cours…

default

Rendu de l’aperçu en cours…

with color

Rendu de l’aperçu en cours…

filter

Structure

Anatomie

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

Anatomy of OrigamChipGroupSchematic of the ChipGroup component with 4 numbered internal parts. origam-chip-group ① origam-slide-group ② Vue ✓ TypeScript CSS origam-chip ③ (slot default) OrigamDefaultsProvider propagates color/bgColor to chip children ④
Anatomy of <origam-chip-group> — 4 internal parts. The root ① wraps a origam-slide-group ② which contains chip children ③. An origam-defaults-provider ④ propagates visual token props to all descendant chips.
1.origam-chip-group
Root element. BEM modifier --column switches to a wrapping grid layout.
2origam-slide-group
Horizontal scrollable container with prev/next navigation buttons. Receives filtered SlideGroup props.
3origam-chip (slot children)
Child chip elements provided via the default slot. Receive selection state from the group context (ORIGAM_CHIP_GROUP_KEY).
4origam-defaults-provider
Injects default color, bgColor and other visual props into all descendant origam-chip elements.

API

Props

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

column
boolean
false
Switches the layout from horizontal scrollable row to a wrapping column grid.
filter
boolean
false
Activates filter mode: selected chips display a check icon (passed down to chip children as a default prop).
valueComparator
(a: any, b: any) => boolean
Custom comparator used to determine if a chip value matches the modelValue. Defaults to strict equality.
active
IActiveState
hover
IHoverState
id
string
class
string | Array<string> | object
style
string | Array<string> | object | StyleValue
tag
string
'div'
HTML element for the root wrapper.
disabled
boolean
false
Disables all chips inside the group.
modelValue
any
Currently selected chip value(s). Supports v-model with a single value or an array in multiple mode.
multiple
boolean
false
Allows multiple chips to be selected simultaneously.
mandatory
boolean
false
At least one chip must remain selected; deselecting the last chip is prevented.
max
number
Maximum number of chips that can be selected when multiple=true.
selectedClass
string
'origam-chip--selected'
CSS class added to active/selected chips. Passed down to children via group context.
color
Default foreground colour propagated to all descendant chips via OrigamDefaultsProvider.
bgColor
Default background colour propagated to all descendant chips.
margin
boolean | number | string
marginTop
boolean | number | string
marginLeft
boolean | number | string
marginBottom
boolean | number | string
marginRight
boolean | number | string
marginBlock
boolean | number | string
marginInline
boolean | number | string
marginInlineStart
boolean | number | string
marginInlineEnd
boolean | number | string
marginBlockStart
boolean | number | string
marginBlockEnd
boolean | number | string
padding
boolean | number | string
paddingTop
boolean | number | string
paddingLeft
boolean | number | string
paddingBottom
boolean | number | string
paddingRight
boolean | number | string
paddingBlock
boolean | number | string
paddingInline
boolean | number | string
paddingInlineStart
boolean | number | string
paddingInlineEnd
boolean | number | string
paddingBlockStart
boolean | number | string
paddingBlockEnd
boolean | number | string
border
boolean | number | string | TDirectionBoth | Array<TDirectionBoth>
borderTop
boolean | number | string
borderLeft
boolean | number | string
borderBottom
boolean | number | string
borderRight
boolean | number | string
borderBlock
boolean | number | string
borderInline
boolean | number | string
borderInlineStart
boolean | number | string
borderInlineEnd
boolean | number | string
borderBlockStart
boolean | number | string
borderBlockEnd
boolean | number | string
borderColor
string
borderStyle
string
borderTopColor
TColor
borderRightColor
TColor
borderBottomColor
TColor
borderLeftColor
TColor
borderInlineStartColor
TColor
borderInlineEndColor
TColor
borderBlockStartColor
TColor
borderBlockEndColor
TColor
Border-radius token or boolean applied to the group wrapper.
roundedTopRight
boolean | number | string
roundedTopLeft
boolean | number | string
roundedBottomLeft
boolean | number | string
roundedBottomRight
boolean | number | string
roundedStartStart
boolean | number | string
roundedStartEnd
boolean | number | string
roundedEndStart
boolean | number | string
roundedEndEnd
boolean | number | string
centerActive
boolean
nextIcon
MDI_ICONS.CHEVRON_RIGHT
Icon for the "scroll next" navigation button of the SlideGroup.
prevIcon
MDI_ICONS.CHEVRON_LEFT
Icon for the "scroll previous" navigation button of the SlideGroup.
showArrows
boolean | string
direction
TDirection
'horizontal'
Scrolling direction of the underlying SlideGroup: horizontal or vertical.
mobileBreakpoint
number | TBreakpoint

API

Slots

Emplacements de contenu exposés par ce composant.

#default
Default slot for origam-chip children. Receives group helpers (isSelected, select, next, prev, selected) to build custom layouts.

API

Emits

Événements émis par ce composant.

@update:modelValue
any
Fired when the selected chip(s) change. Emits 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 component.
Ref<string>
Reactive CSS string generated by useStyle.
string
Unique style-sheet ID for this instance.
() => void
Injects the computed style sheet. Called on mount.
() => void
Removes the injected style sheet. Called on unmount.
Ref<boolean>
True once the style sheet has been injected into the DOM.

Personnalisation

Variables CSS

Propriétés CSS personnalisées exposées par ce composant. Surchargez-les pour personnaliser sans perdre la compatibilité avec le thème.

Default chip background propagated to all chips in the group.
Chip border radius (pill by default).
Selected chip background colour.
Selected chip foreground colour.

Inclusion

Accessibilité

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

Rôles ARIA

group

Interactions clavier

Interactions clavier
ToucheAction
TabMoves focus between chips inside the group.
Enter / SpaceSelects or deselects the focused chip.
Arrow Left / RightScrolls the slide group when overflow is present (handled by OrigamSlideGroup).

Notes

  • The slide group container exposes a logical grouping of selectable chip controls. Each chip carries its own role and aria-selected.
  • Color tokens are propagated via OrigamDefaultsProvider — children that set their own color still take precedence over the group defaults.

Fondation

Design tokens

Extrait des tokens de ce composant — les variables --origam-<composant>---<propriété>, déclarées dans sa feuille de tokens tenue à la main, sans étape de build.

Source
color
var(--origam-color__surface---overlay)
Default chip background (propagated to children).
color
var(--origam-color__action--primary---bg)
Background of the selected chip state.
dimension
var(--origam-radius---full)
Chip border radius.
duration
var(--origam-motion__duration---medium)
Chip transition duration (hover, selection).

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.

Filter chips

vue

Single select (mandatory)

vue

Column layout

vue