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.

Preview

Rendering the live preview…

default

Rendering the live preview…

with color

Rendering the live preview…

filter

Structure

Anatomy

Visual breakdown of the component's internal structure with BEM class call-outs.

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

All props accepted by this component, with their type, default value and 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

Content slots exposed by this component.

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

API

Emits

Events emitted by this component.

@update:modelValue
any
Fired when the selected chip(s) change. Emits the new value or array of values.

API

Exposed members

Properties and methods accessible via template ref (defineExpose). Use them for programmatic control.

<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.

Customisation

CSS variables

CSS custom properties exposed by this component. Override them to customise the component without losing theme compatibility.

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

Accessibility

ARIA roles, keyboard navigation and focus management. Sourced from the real component template.

ARIA roles

group

Keyboard interactions

Keyboard interactions
KeyAction
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.

Foundation

Design tokens

Excerpt from this component's token declarations — the --origam-<component>---<property> variables, declared in its hand-maintained token sheet with no build step.

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).

Interactive

Playground

Edit props live and see the component update in real time. The generated code snippet updates as you change values.

Rendering the live preview…

Usage

Examples

Ready-to-paste code snippets for your templates.

Filter chips

vue

Single select (mandatory)

vue

Column layout

vue