Skip to main content

MultiselectProps

MultiselectProps = object & VariantProps<typeof multiSelectVariants>

Props of Multiselect

Type Declaration​

children?​

optional children: React.ReactNode

className?​

optional className: string

dir?​

optional dir: string

disabled​

disabled: boolean

Whether the multiselect is disabled

displayValues?​

optional displayValues: Map<string, string>

Map of display values for the selected options

id?​

optional id: string

loop?​

optional loop: boolean

Whether the multiselect should loop

onOpenChange?​

optional onOpenChange: VoidFunc<boolean>

Event handler called when the multiselect's open state changes

onValuesChange​

onValuesChange: VoidFunc<string[]>

Event handler called when the selected values change

ref?​

optional ref: React.RefObject<WithOpen | null>

Ref for the open trigger element

showSelectAll?​

optional showSelectAll: boolean

Whether the multiselect should show a "Select All" option

values​

values: string[]

Values selected in the multiselect