Skip to components
DEVELOPER REFERENCE · v4.0.0

ChoiceChips API

Props, callbacks and methods. Select an underlined type to explore its fields, allowed values and callback arguments.

ChoiceChips10 props1 callbacks0 methods

Props10

ChoiceChips props
NameTypeDescription
valueOptional
T | readonly T[] | undefinedInspect type
Value to display or edit. The declared type identifies the supported representation; change callbacks describe how edited values are emitted.
optionsRequired
readonly ChoiceChipOption<T>[]Inspect type
Available choices or control configuration, according to the declared type; expand it to inspect each field.
ariaLabelRequiredstringAccessible name announced by assistive technology.
appearanceOptional"soft" | "outlined" | undefinedSelects a soft-filled or outlined chip presentation.
scrollableOptionalboolean | undefinedKeep choices on one scrollable row, with hidden scrollbars and soft edge fades.
sizeOptional"small" | "medium" | undefinedVisual size of this component; numeric icon/avatar sizes are in pixels, while controls use the declared named sizes.
classNameOptionalstring | undefinedAdditional CSS classes applied to the component root.
itemClassNameOptionalstring | undefinedAdditional CSS classes for the item part of the component.
disabledOptionalboolean | undefinedDisables user interaction with the control.
testIdOptionalstring | undefinedStable data attribute for locating the control in automated tests.

Events and callbacks1

ChoiceChips events and callbacks
NameTypeDescription
onChangeRequired
(value: T, option: ChoiceChipOption<T>) => voidInspect type
Receives the new value when the user changes the control. Update the corresponding value prop for controlled use.

Methods0

No component-specific imperative methods. Use props and callbacks to control this component.