MultiSelect
MultiSelect<
T>(__namedParameters):Element
Defined in: src/components/controls/MultiSelect/MultiSelect.tsx:108
Multi-value select that lets the user pick several options from a dropdown. Selected values are rendered as inline chips inside the trigger; the rest collapse into a “+N more” badge.
Supports searchable mode, grouped options, controlled and uncontrolled
modes, keyboard navigation, an optional max cap, and a clear-all button.
Type Parameters
Section titled “Type Parameters”T extends string = string
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”about?
Section titled “about?”string
accessKey?
Section titled “accessKey?”string
aria-activedescendant?
Section titled “aria-activedescendant?”string
Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
aria-atomic?
Section titled “aria-atomic?”Booleanish
Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
aria-autocomplete?
Section titled “aria-autocomplete?”"none" | "inline" | "both" | "list"
Indicates whether inputting text could trigger display of one or more predictions of the user’s intended value for an input and specifies how predictions would be presented if they are made.
aria-braillelabel?
Section titled “aria-braillelabel?”string
Defines a string value that labels the current element, which is intended to be converted into Braille.
See
aria-label.
aria-brailleroledescription?
Section titled “aria-brailleroledescription?”string
Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.
See
aria-roledescription.
aria-busy?
Section titled “aria-busy?”Booleanish
aria-checked?
Section titled “aria-checked?”boolean | "mixed" | "false" | "true"
Indicates the current “checked” state of checkboxes, radio buttons, and other widgets.
See
- aria-pressed
- aria-selected.
aria-colcount?
Section titled “aria-colcount?”number
Defines the total number of columns in a table, grid, or treegrid.
See
aria-colindex.
aria-colindex?
Section titled “aria-colindex?”number
Defines an element’s column index or position with respect to the total number of columns within a table, grid, or treegrid.
See
- aria-colcount
- aria-colspan.
aria-colindextext?
Section titled “aria-colindextext?”string
Defines a human readable text alternative of aria-colindex.
See
aria-rowindextext.
aria-colspan?
Section titled “aria-colspan?”number
Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
See
- aria-colindex
- aria-rowspan.
aria-controls?
Section titled “aria-controls?”string
Identifies the element (or elements) whose contents or presence are controlled by the current element.
See
aria-owns.
aria-current?
Section titled “aria-current?”boolean | "location" | "page" | "false" | "true" | "step" | "date" | "time"
Indicates the element that represents the current item within a container or set of related elements.
aria-describedby?
Section titled “aria-describedby?”string
Identifies the element (or elements) that describes the object.
See
aria-labelledby
aria-description?
Section titled “aria-description?”string
Defines a string value that describes or annotates the current element.
See
related aria-describedby.
aria-details?
Section titled “aria-details?”string
Identifies the element that provides a detailed, extended description for the object.
See
aria-describedby.
aria-disabled?
Section titled “aria-disabled?”Booleanish
Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
See
- aria-hidden
- aria-readonly.
aria-dropeffect?
Section titled “aria-dropeffect?”"none" | "link" | "copy" | "move" | "execute" | "popup"
Indicates what functions can be performed when a dragged object is released on the drop target.
aria-errormessage?
Section titled “aria-errormessage?”string
Identifies the element that provides an error message for the object.
See
- aria-invalid
- aria-describedby.
aria-expanded?
Section titled “aria-expanded?”Booleanish
Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
aria-flowto?
Section titled “aria-flowto?”string
Identifies the next element (or elements) in an alternate reading order of content which, at the user’s discretion, allows assistive technology to override the general default of reading in document source order.
aria-grabbed?
Section titled “aria-grabbed?”Booleanish
Indicates an element’s “grabbed” state in a drag-and-drop operation.
aria-haspopup?
Section titled “aria-haspopup?”boolean | "grid" | "listbox" | "menu" | "false" | "true" | "dialog" | "tree"
Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
aria-hidden?
Section titled “aria-hidden?”Booleanish
Indicates whether the element is exposed to an accessibility API.
See
aria-disabled.
aria-invalid?
Section titled “aria-invalid?”boolean | "false" | "true" | "grammar" | "spelling"
Indicates the entered value does not conform to the format expected by the application.
See
aria-errormessage.
aria-keyshortcuts?
Section titled “aria-keyshortcuts?”string
Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
aria-label?
Section titled “aria-label?”string
Defines a string value that labels the current element.
See
aria-labelledby.
aria-labelledby?
Section titled “aria-labelledby?”string
Identifies the element (or elements) that labels the current element.
See
aria-describedby.
aria-level?
Section titled “aria-level?”number
Defines the hierarchical level of an element within a structure.
aria-live?
Section titled “aria-live?”"off" | "assertive" | "polite"
Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
aria-modal?
Section titled “aria-modal?”Booleanish
Indicates whether an element is modal when displayed.
aria-multiline?
Section titled “aria-multiline?”Booleanish
Indicates whether a text box accepts multiple lines of input or only a single line.
aria-multiselectable?
Section titled “aria-multiselectable?”Booleanish
Indicates that the user may select more than one item from the current selectable descendants.
aria-orientation?
Section titled “aria-orientation?”"horizontal" | "vertical"
Indicates whether the element’s orientation is horizontal, vertical, or unknown/ambiguous.
aria-owns?
Section titled “aria-owns?”string
Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.
See
aria-controls.
aria-placeholder?
Section titled “aria-placeholder?”string
Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.
aria-posinset?
Section titled “aria-posinset?”number
Defines an element’s number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
See
aria-setsize.
aria-pressed?
Section titled “aria-pressed?”boolean | "mixed" | "false" | "true"
Indicates the current “pressed” state of toggle buttons.
See
- aria-checked
- aria-selected.
aria-readonly?
Section titled “aria-readonly?”Booleanish
Indicates that the element is not editable, but is otherwise operable.
See
aria-disabled.
aria-relevant?
Section titled “aria-relevant?”"text" | "all" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"
Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
See
aria-atomic.
aria-required?
Section titled “aria-required?”Booleanish
Indicates that user input is required on the element before a form may be submitted.
aria-roledescription?
Section titled “aria-roledescription?”string
Defines a human-readable, author-localized description for the role of an element.
aria-rowcount?
Section titled “aria-rowcount?”number
Defines the total number of rows in a table, grid, or treegrid.
See
aria-rowindex.
aria-rowindex?
Section titled “aria-rowindex?”number
Defines an element’s row index or position with respect to the total number of rows within a table, grid, or treegrid.
See
- aria-rowcount
- aria-rowspan.
aria-rowindextext?
Section titled “aria-rowindextext?”string
Defines a human readable text alternative of aria-rowindex.
See
aria-colindextext.
aria-rowspan?
Section titled “aria-rowspan?”number
Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
See
- aria-rowindex
- aria-colspan.
aria-selected?
Section titled “aria-selected?”Booleanish
Indicates the current “selected” state of various widgets.
See
- aria-checked
- aria-pressed.
aria-setsize?
Section titled “aria-setsize?”number
Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
See
aria-posinset.
aria-sort?
Section titled “aria-sort?”"none" | "ascending" | "descending" | "other"
Indicates if items in a table or grid are sorted in ascending or descending order.
aria-valuemax?
Section titled “aria-valuemax?”number
Defines the maximum allowed value for a range widget.
aria-valuemin?
Section titled “aria-valuemin?”number
Defines the minimum allowed value for a range widget.
aria-valuenow?
Section titled “aria-valuenow?”number
Defines the current value for a range widget.
See
aria-valuetext.
aria-valuetext?
Section titled “aria-valuetext?”string
Defines the human readable text alternative of aria-valuenow for a range widget.
autoCapitalize?
Section titled “autoCapitalize?”"none" | string & object | "off" | "on" | "sentences" | "words" | "characters"
autoCorrect?
Section titled “autoCorrect?”string
autoFocus?
Section titled “autoFocus?”boolean
autoSave?
Section titled “autoSave?”string
className?
Section titled “className?”string
Additional CSS class names
clearable?
Section titled “clearable?”boolean = false
Show a clear-all button when at least one value is selected
closeOnSelect?
Section titled “closeOnSelect?”boolean = false
Close the dropdown after each selection.
Default
falsecolor?
Section titled “color?”string
content?
Section titled “content?”string
contentEditable?
Section titled “contentEditable?”"inherit" | Booleanish | "plaintext-only"
contextMenu?
Section titled “contextMenu?”string
dangerouslySetInnerHTML?
Section titled “dangerouslySetInnerHTML?”{ __html: string | TrustedHTML; }
dangerouslySetInnerHTML.__html
Section titled “dangerouslySetInnerHTML.__html”string | TrustedHTML
datatype?
Section titled “datatype?”string
defaultChecked?
Section titled “defaultChecked?”boolean
defaultValue?
Section titled “defaultValue?”T[]
Default selection (uncontrolled)
string
disabled?
Section titled “disabled?”boolean = false
Disable the entire control
draggable?
Section titled “draggable?”Booleanish
emptyMessage?
Section titled “emptyMessage?”string = 'No results found'
Message shown when search yields no results
enterKeyHint?
Section titled “enterKeyHint?”"search" | "next" | "enter" | "done" | "go" | "previous" | "send"
error?
Section titled “error?”boolean = false
Error state
errorMessage?
Section titled “errorMessage?”string
Error message — overrides helperText when error is true
exportparts?
Section titled “exportparts?”string
See
https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts
filterFn?
Section titled “filterFn?”(option, query) => boolean
Custom filter for searchable mode
helperText?
Section titled “helperText?”string
Helper text rendered below
hidden?
Section titled “hidden?”boolean
string
Unique identifier for the component
inert?
Section titled “inert?”boolean
See
https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert
inlist?
Section titled “inlist?”any
inputMode?
Section titled “inputMode?”"text" | "none" | "search" | "tel" | "url" | "email" | "numeric" | "decimal"
Hints at the type of data that might be entered by the user while editing the element or its contents
See
https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute
string
Specify that a standard HTML element should behave like a defined custom built-in element
See
https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is
itemID?
Section titled “itemID?”string
itemProp?
Section titled “itemProp?”string
itemRef?
Section titled “itemRef?”string
itemScope?
Section titled “itemScope?”boolean
itemType?
Section titled “itemType?”string
label?
Section titled “label?”string
Label rendered above the trigger
string
number
Maximum number of selected items
maxDropdownHeight?
Section titled “maxDropdownHeight?”number = 240
Maximum dropdown height in pixels
maxInlineChips?
Section titled “maxInlineChips?”number = 3
Cap of inline chips rendered in the trigger before falling back to a
“+N more” badge. Infinity to render every chip. Set to 0 to never
render chips and only show the count.
Default
3minDropdownWidth?
Section titled “minDropdownWidth?”number
Minimum dropdown width in pixels
string
Hidden form-input name. Selected values are joined by ,.
nonce?
Section titled “nonce?”string
onAbort?
Section titled “onAbort?”ReactEventHandler<HTMLButtonElement>
onAbortCapture?
Section titled “onAbortCapture?”ReactEventHandler<HTMLButtonElement>
onAnimationEnd?
Section titled “onAnimationEnd?”AnimationEventHandler<HTMLButtonElement>
onAnimationEndCapture?
Section titled “onAnimationEndCapture?”AnimationEventHandler<HTMLButtonElement>
onAnimationIteration?
Section titled “onAnimationIteration?”AnimationEventHandler<HTMLButtonElement>
onAnimationIterationCapture?
Section titled “onAnimationIterationCapture?”AnimationEventHandler<HTMLButtonElement>
onAnimationStart?
Section titled “onAnimationStart?”AnimationEventHandler<HTMLButtonElement>
onAnimationStartCapture?
Section titled “onAnimationStartCapture?”AnimationEventHandler<HTMLButtonElement>
onAuxClick?
Section titled “onAuxClick?”MouseEventHandler<HTMLButtonElement>
onAuxClickCapture?
Section titled “onAuxClickCapture?”MouseEventHandler<HTMLButtonElement>
onBeforeInput?
Section titled “onBeforeInput?”InputEventHandler<HTMLButtonElement>
onBeforeInputCapture?
Section titled “onBeforeInputCapture?”InputEventHandler<HTMLButtonElement>
onBeforeToggle?
Section titled “onBeforeToggle?”ToggleEventHandler<HTMLButtonElement>
onBlur?
Section titled “onBlur?”FocusEventHandler<HTMLButtonElement>
onBlurCapture?
Section titled “onBlurCapture?”FocusEventHandler<HTMLButtonElement>
onCanPlay?
Section titled “onCanPlay?”ReactEventHandler<HTMLButtonElement>
onCanPlayCapture?
Section titled “onCanPlayCapture?”ReactEventHandler<HTMLButtonElement>
onCanPlayThrough?
Section titled “onCanPlayThrough?”ReactEventHandler<HTMLButtonElement>
onCanPlayThroughCapture?
Section titled “onCanPlayThroughCapture?”ReactEventHandler<HTMLButtonElement>
onChange?
Section titled “onChange?”(values) => void
Selection change handler
onChangeCapture?
Section titled “onChangeCapture?”ChangeEventHandler<HTMLButtonElement, Element>
onClick?
Section titled “onClick?”MouseEventHandler<HTMLButtonElement>
onClickCapture?
Section titled “onClickCapture?”MouseEventHandler<HTMLButtonElement>
onCompositionEnd?
Section titled “onCompositionEnd?”CompositionEventHandler<HTMLButtonElement>
onCompositionEndCapture?
Section titled “onCompositionEndCapture?”CompositionEventHandler<HTMLButtonElement>
onCompositionStart?
Section titled “onCompositionStart?”CompositionEventHandler<HTMLButtonElement>
onCompositionStartCapture?
Section titled “onCompositionStartCapture?”CompositionEventHandler<HTMLButtonElement>
onCompositionUpdate?
Section titled “onCompositionUpdate?”CompositionEventHandler<HTMLButtonElement>
onCompositionUpdateCapture?
Section titled “onCompositionUpdateCapture?”CompositionEventHandler<HTMLButtonElement>
onContextMenu?
Section titled “onContextMenu?”MouseEventHandler<HTMLButtonElement>
onContextMenuCapture?
Section titled “onContextMenuCapture?”MouseEventHandler<HTMLButtonElement>
onCopy?
Section titled “onCopy?”ClipboardEventHandler<HTMLButtonElement>
onCopyCapture?
Section titled “onCopyCapture?”ClipboardEventHandler<HTMLButtonElement>
onCut?
Section titled “onCut?”ClipboardEventHandler<HTMLButtonElement>
onCutCapture?
Section titled “onCutCapture?”ClipboardEventHandler<HTMLButtonElement>
onDoubleClick?
Section titled “onDoubleClick?”MouseEventHandler<HTMLButtonElement>
onDoubleClickCapture?
Section titled “onDoubleClickCapture?”MouseEventHandler<HTMLButtonElement>
onDrag?
Section titled “onDrag?”DragEventHandler<HTMLButtonElement>
onDragCapture?
Section titled “onDragCapture?”DragEventHandler<HTMLButtonElement>
onDragEnd?
Section titled “onDragEnd?”DragEventHandler<HTMLButtonElement>
onDragEndCapture?
Section titled “onDragEndCapture?”DragEventHandler<HTMLButtonElement>
onDragEnter?
Section titled “onDragEnter?”DragEventHandler<HTMLButtonElement>
onDragEnterCapture?
Section titled “onDragEnterCapture?”DragEventHandler<HTMLButtonElement>
onDragExit?
Section titled “onDragExit?”DragEventHandler<HTMLButtonElement>
onDragExitCapture?
Section titled “onDragExitCapture?”DragEventHandler<HTMLButtonElement>
onDragLeave?
Section titled “onDragLeave?”DragEventHandler<HTMLButtonElement>
onDragLeaveCapture?
Section titled “onDragLeaveCapture?”DragEventHandler<HTMLButtonElement>
onDragOver?
Section titled “onDragOver?”DragEventHandler<HTMLButtonElement>
onDragOverCapture?
Section titled “onDragOverCapture?”DragEventHandler<HTMLButtonElement>
onDragStart?
Section titled “onDragStart?”DragEventHandler<HTMLButtonElement>
onDragStartCapture?
Section titled “onDragStartCapture?”DragEventHandler<HTMLButtonElement>
onDrop?
Section titled “onDrop?”DragEventHandler<HTMLButtonElement>
onDropCapture?
Section titled “onDropCapture?”DragEventHandler<HTMLButtonElement>
onDurationChange?
Section titled “onDurationChange?”ReactEventHandler<HTMLButtonElement>
onDurationChangeCapture?
Section titled “onDurationChangeCapture?”ReactEventHandler<HTMLButtonElement>
onEmptied?
Section titled “onEmptied?”ReactEventHandler<HTMLButtonElement>
onEmptiedCapture?
Section titled “onEmptiedCapture?”ReactEventHandler<HTMLButtonElement>
onEncrypted?
Section titled “onEncrypted?”ReactEventHandler<HTMLButtonElement>
onEncryptedCapture?
Section titled “onEncryptedCapture?”ReactEventHandler<HTMLButtonElement>
onEnded?
Section titled “onEnded?”ReactEventHandler<HTMLButtonElement>
onEndedCapture?
Section titled “onEndedCapture?”ReactEventHandler<HTMLButtonElement>
onError?
Section titled “onError?”ReactEventHandler<HTMLButtonElement>
onErrorCapture?
Section titled “onErrorCapture?”ReactEventHandler<HTMLButtonElement>
onFocus?
Section titled “onFocus?”FocusEventHandler<HTMLButtonElement>
onFocusCapture?
Section titled “onFocusCapture?”FocusEventHandler<HTMLButtonElement>
onGotPointerCapture?
Section titled “onGotPointerCapture?”PointerEventHandler<HTMLButtonElement>
onGotPointerCaptureCapture?
Section titled “onGotPointerCaptureCapture?”PointerEventHandler<HTMLButtonElement>
onInput?
Section titled “onInput?”InputEventHandler<HTMLButtonElement>
onInputCapture?
Section titled “onInputCapture?”InputEventHandler<HTMLButtonElement>
onInvalid?
Section titled “onInvalid?”ReactEventHandler<HTMLButtonElement>
onInvalidCapture?
Section titled “onInvalidCapture?”ReactEventHandler<HTMLButtonElement>
onKeyDown?
Section titled “onKeyDown?”KeyboardEventHandler<HTMLButtonElement>
onKeyDownCapture?
Section titled “onKeyDownCapture?”KeyboardEventHandler<HTMLButtonElement>
onKeyPress?
Section titled “onKeyPress?”KeyboardEventHandler<HTMLButtonElement>
onKeyPressCapture?
Section titled “onKeyPressCapture?”KeyboardEventHandler<HTMLButtonElement>
onKeyUp?
Section titled “onKeyUp?”KeyboardEventHandler<HTMLButtonElement>
onKeyUpCapture?
Section titled “onKeyUpCapture?”KeyboardEventHandler<HTMLButtonElement>
onLoad?
Section titled “onLoad?”ReactEventHandler<HTMLButtonElement>
onLoadCapture?
Section titled “onLoadCapture?”ReactEventHandler<HTMLButtonElement>
onLoadedData?
Section titled “onLoadedData?”ReactEventHandler<HTMLButtonElement>
onLoadedDataCapture?
Section titled “onLoadedDataCapture?”ReactEventHandler<HTMLButtonElement>
onLoadedMetadata?
Section titled “onLoadedMetadata?”ReactEventHandler<HTMLButtonElement>
onLoadedMetadataCapture?
Section titled “onLoadedMetadataCapture?”ReactEventHandler<HTMLButtonElement>
onLoadStart?
Section titled “onLoadStart?”ReactEventHandler<HTMLButtonElement>
onLoadStartCapture?
Section titled “onLoadStartCapture?”ReactEventHandler<HTMLButtonElement>
onLostPointerCapture?
Section titled “onLostPointerCapture?”PointerEventHandler<HTMLButtonElement>
onLostPointerCaptureCapture?
Section titled “onLostPointerCaptureCapture?”PointerEventHandler<HTMLButtonElement>
onMouseDown?
Section titled “onMouseDown?”MouseEventHandler<HTMLButtonElement>
onMouseDownCapture?
Section titled “onMouseDownCapture?”MouseEventHandler<HTMLButtonElement>
onMouseEnter?
Section titled “onMouseEnter?”MouseEventHandler<HTMLButtonElement>
onMouseLeave?
Section titled “onMouseLeave?”MouseEventHandler<HTMLButtonElement>
onMouseMove?
Section titled “onMouseMove?”MouseEventHandler<HTMLButtonElement>
onMouseMoveCapture?
Section titled “onMouseMoveCapture?”MouseEventHandler<HTMLButtonElement>
onMouseOut?
Section titled “onMouseOut?”MouseEventHandler<HTMLButtonElement>
onMouseOutCapture?
Section titled “onMouseOutCapture?”MouseEventHandler<HTMLButtonElement>
onMouseOver?
Section titled “onMouseOver?”MouseEventHandler<HTMLButtonElement>
onMouseOverCapture?
Section titled “onMouseOverCapture?”MouseEventHandler<HTMLButtonElement>
onMouseUp?
Section titled “onMouseUp?”MouseEventHandler<HTMLButtonElement>
onMouseUpCapture?
Section titled “onMouseUpCapture?”MouseEventHandler<HTMLButtonElement>
onOpenChange?
Section titled “onOpenChange?”(open) => void
Open state change handler
onPaste?
Section titled “onPaste?”ClipboardEventHandler<HTMLButtonElement>
onPasteCapture?
Section titled “onPasteCapture?”ClipboardEventHandler<HTMLButtonElement>
onPause?
Section titled “onPause?”ReactEventHandler<HTMLButtonElement>
onPauseCapture?
Section titled “onPauseCapture?”ReactEventHandler<HTMLButtonElement>
onPlay?
Section titled “onPlay?”ReactEventHandler<HTMLButtonElement>
onPlayCapture?
Section titled “onPlayCapture?”ReactEventHandler<HTMLButtonElement>
onPlaying?
Section titled “onPlaying?”ReactEventHandler<HTMLButtonElement>
onPlayingCapture?
Section titled “onPlayingCapture?”ReactEventHandler<HTMLButtonElement>
onPointerCancel?
Section titled “onPointerCancel?”PointerEventHandler<HTMLButtonElement>
onPointerCancelCapture?
Section titled “onPointerCancelCapture?”PointerEventHandler<HTMLButtonElement>
onPointerDown?
Section titled “onPointerDown?”PointerEventHandler<HTMLButtonElement>
onPointerDownCapture?
Section titled “onPointerDownCapture?”PointerEventHandler<HTMLButtonElement>
onPointerEnter?
Section titled “onPointerEnter?”PointerEventHandler<HTMLButtonElement>
onPointerLeave?
Section titled “onPointerLeave?”PointerEventHandler<HTMLButtonElement>
onPointerMove?
Section titled “onPointerMove?”PointerEventHandler<HTMLButtonElement>
onPointerMoveCapture?
Section titled “onPointerMoveCapture?”PointerEventHandler<HTMLButtonElement>
onPointerOut?
Section titled “onPointerOut?”PointerEventHandler<HTMLButtonElement>
onPointerOutCapture?
Section titled “onPointerOutCapture?”PointerEventHandler<HTMLButtonElement>
onPointerOver?
Section titled “onPointerOver?”PointerEventHandler<HTMLButtonElement>
onPointerOverCapture?
Section titled “onPointerOverCapture?”PointerEventHandler<HTMLButtonElement>
onPointerUp?
Section titled “onPointerUp?”PointerEventHandler<HTMLButtonElement>
onPointerUpCapture?
Section titled “onPointerUpCapture?”PointerEventHandler<HTMLButtonElement>
onProgress?
Section titled “onProgress?”ReactEventHandler<HTMLButtonElement>
onProgressCapture?
Section titled “onProgressCapture?”ReactEventHandler<HTMLButtonElement>
onRateChange?
Section titled “onRateChange?”ReactEventHandler<HTMLButtonElement>
onRateChangeCapture?
Section titled “onRateChangeCapture?”ReactEventHandler<HTMLButtonElement>
onReset?
Section titled “onReset?”ReactEventHandler<HTMLButtonElement>
onResetCapture?
Section titled “onResetCapture?”ReactEventHandler<HTMLButtonElement>
onScroll?
Section titled “onScroll?”UIEventHandler<HTMLButtonElement>
onScrollCapture?
Section titled “onScrollCapture?”UIEventHandler<HTMLButtonElement>
onScrollEnd?
Section titled “onScrollEnd?”UIEventHandler<HTMLButtonElement>
onScrollEndCapture?
Section titled “onScrollEndCapture?”UIEventHandler<HTMLButtonElement>
onSeeked?
Section titled “onSeeked?”ReactEventHandler<HTMLButtonElement>
onSeekedCapture?
Section titled “onSeekedCapture?”ReactEventHandler<HTMLButtonElement>
onSeeking?
Section titled “onSeeking?”ReactEventHandler<HTMLButtonElement>
onSeekingCapture?
Section titled “onSeekingCapture?”ReactEventHandler<HTMLButtonElement>
onSelect?
Section titled “onSelect?”ReactEventHandler<HTMLButtonElement>
onSelectCapture?
Section titled “onSelectCapture?”ReactEventHandler<HTMLButtonElement>
onStalled?
Section titled “onStalled?”ReactEventHandler<HTMLButtonElement>
onStalledCapture?
Section titled “onStalledCapture?”ReactEventHandler<HTMLButtonElement>
onSubmit?
Section titled “onSubmit?”SubmitEventHandler<HTMLButtonElement>
onSubmitCapture?
Section titled “onSubmitCapture?”SubmitEventHandler<HTMLButtonElement>
onSuspend?
Section titled “onSuspend?”ReactEventHandler<HTMLButtonElement>
onSuspendCapture?
Section titled “onSuspendCapture?”ReactEventHandler<HTMLButtonElement>
onTimeUpdate?
Section titled “onTimeUpdate?”ReactEventHandler<HTMLButtonElement>
onTimeUpdateCapture?
Section titled “onTimeUpdateCapture?”ReactEventHandler<HTMLButtonElement>
onToggle?
Section titled “onToggle?”ToggleEventHandler<HTMLButtonElement>
onTouchCancel?
Section titled “onTouchCancel?”TouchEventHandler<HTMLButtonElement>
onTouchCancelCapture?
Section titled “onTouchCancelCapture?”TouchEventHandler<HTMLButtonElement>
onTouchEnd?
Section titled “onTouchEnd?”TouchEventHandler<HTMLButtonElement>
onTouchEndCapture?
Section titled “onTouchEndCapture?”TouchEventHandler<HTMLButtonElement>
onTouchMove?
Section titled “onTouchMove?”TouchEventHandler<HTMLButtonElement>
onTouchMoveCapture?
Section titled “onTouchMoveCapture?”TouchEventHandler<HTMLButtonElement>
onTouchStart?
Section titled “onTouchStart?”TouchEventHandler<HTMLButtonElement>
onTouchStartCapture?
Section titled “onTouchStartCapture?”TouchEventHandler<HTMLButtonElement>
onTransitionCancel?
Section titled “onTransitionCancel?”TransitionEventHandler<HTMLButtonElement>
onTransitionCancelCapture?
Section titled “onTransitionCancelCapture?”TransitionEventHandler<HTMLButtonElement>
onTransitionEnd?
Section titled “onTransitionEnd?”TransitionEventHandler<HTMLButtonElement>
onTransitionEndCapture?
Section titled “onTransitionEndCapture?”TransitionEventHandler<HTMLButtonElement>
onTransitionRun?
Section titled “onTransitionRun?”TransitionEventHandler<HTMLButtonElement>
onTransitionRunCapture?
Section titled “onTransitionRunCapture?”TransitionEventHandler<HTMLButtonElement>
onTransitionStart?
Section titled “onTransitionStart?”TransitionEventHandler<HTMLButtonElement>
onTransitionStartCapture?
Section titled “onTransitionStartCapture?”TransitionEventHandler<HTMLButtonElement>
onVolumeChange?
Section titled “onVolumeChange?”ReactEventHandler<HTMLButtonElement>
onVolumeChangeCapture?
Section titled “onVolumeChangeCapture?”ReactEventHandler<HTMLButtonElement>
onWaiting?
Section titled “onWaiting?”ReactEventHandler<HTMLButtonElement>
onWaitingCapture?
Section titled “onWaitingCapture?”ReactEventHandler<HTMLButtonElement>
onWheel?
Section titled “onWheel?”WheelEventHandler<HTMLButtonElement>
onWheelCapture?
Section titled “onWheelCapture?”WheelEventHandler<HTMLButtonElement>
options
Section titled “options”(MultiSelectOption<T> | MultiSelectOptionGroup<T>)[]
Options — flat list or grouped
string
See
https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part
placeholder?
Section titled “placeholder?”string = 'Select...'
Placeholder shown when nothing is selected
popover?
Section titled “popover?”"" | "auto" | "manual" | "hint"
popoverTarget?
Section titled “popoverTarget?”string
popoverTargetAction?
Section titled “popoverTargetAction?”"toggle" | "hide" | "show"
prefix?
Section titled “prefix?”string
property?
Section titled “property?”string
radioGroup?
Section titled “radioGroup?”string
Ref<HTMLButtonElement>
string
required?
Section titled “required?”boolean = false
Mark the field as required
resource?
Section titled “resource?”string
results?
Section titled “results?”number
string
AriaRole
searchable?
Section titled “searchable?”boolean = false
Whether to render a search input inside the dropdown
searchPlaceholder?
Section titled “searchPlaceholder?”string = 'Search...'
Placeholder for the search input
security?
Section titled “security?”string
Size = 'md'
Component size
string
spellCheck?
Section titled “spellCheck?”Booleanish
style?
Section titled “style?”CSSProperties
Custom inline styles
suppressContentEditableWarning?
Section titled “suppressContentEditableWarning?”boolean
suppressHydrationWarning?
Section titled “suppressHydrationWarning?”boolean
tabIndex?
Section titled “tabIndex?”number
testId?
Section titled “testId?”string
Test identifier for automated testing
title?
Section titled “title?”string
translate?
Section titled “translate?”"yes" | "no"
typeof?
Section titled “typeof?”string
unselectable?
Section titled “unselectable?”"off" | "on"
value?
Section titled “value?”T[]
Controlled list of selected values
variant?
Section titled “variant?”MultiSelectVariant = 'default'
Visual variant
vocab?
Section titled “vocab?”string
Returns
Section titled “Returns”Element
Example
Section titled “Example”<MultiSelect label="Tags" options={[ { value: 'react', label: 'React' }, { value: 'vue', label: 'Vue' }, { value: 'svelte', label: 'Svelte' }, ]} value={tags} onChange={setTags}/>