MultiSelect

MultiSelect is a component used for allowing users to select multiple values from a list of options.

Source @yamada-ui/select

Props

MultiSelectProps

Description

The animation of the popover.

Type

Default

'scale'

Description

The boundary area for the popper. Used within the preventOverflow modifier.

Type

HTMLElement | "clippingParents" | "scrollParent"

Default

'clippingParents'

Description

Props for multi select clear icon element.

Type

SelectIconProps

Description

The number of delay time to close.

Type

number

Default

200

Description

If true, the popover will close when you blur out it by clicking outside or tabbing out.

Type

boolean

Default

true

Description

If true, the popover will close when you hit the Esc key.

Type

boolean

Default

true

Description

If true, the list element will be closed when value is selected.

Type

boolean

Default

true

Description

The visual color appearance of the component.

Type

"blackAlpha" | "whiteAlpha" | "amber" | "blue" | "info" | "link" | "primary" | "cyan" | "emerald" | "flashy" | "fuchsia" | "gray" | "green" | "success" | "indigo" | "lime" | "neutral" | "orange" | "warning" | "pink" | "purple" | "red" | "danger" | "rose" | "sky" | "teal" | "violet" | "secondary" | "yellow"

Description

The custom display value to use.

Type

FC<{
index: number
label: string
value: string
onRemove: MouseEventHandler<HTMLElement>
}>

Description

Props for multi select container element.

Type

Omit<HTMLUIProps, "children">

Description

If true, the popover will be initially opened.

Type

boolean

Description

The initial value of the select.

Type

string[]

Description

The animation duration.

Type

number | MotionLifecycleProps<number>

Description

The border color when the input is invalid.

Type

string

Description

If provided, determines whether the popper will reposition itself on scroll and resize of the window.

Type

type ONLY_FOR_FORMAT =
| boolean
| { resize?: boolean | undefined; scroll?: boolean | undefined }

Default

true

Description

Props for multi select field element.

Type

Omit<MultiSelectFieldProps, "children">

Description

If true, the popper will change its placement and flip when it's about to overflow its boundary area.

Type

boolean

Default

true

Description

The border color when the input is focused.

Type

string

Description

The distance or margin between the reference and popper. It is used internally to create an offset modifier.

Type

UIValue<number>

Default

8

Description

The header of the multi select content element.

Type

string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | FC<...>

Description

Props for multi select icon element.

Type

SelectIconProps

Description

If true, display the multi select clear icon.

Type

boolean

Default

true

Description

If true, the form control will be disabled.

Type

boolean

Default

false

Description

If true, the form control will be invalid.

Type

boolean

Default

false

Description

If true, the PopoverContent rendering will be deferred until the popover is open.

Type

boolean

Default

false

Description

If true, the popover will be opened.

Type

boolean

Description

If true, the form control will be readonly.

Type

boolean

Default

false

Description

If true, the form control will be required.

Type

boolean

Default

false

Description

If provided, generate options based on items.

Type

SelectItem[]

Description

The lazy behavior of popover's content when not visible. Only works when isLazy={true} - unmount: The popover's content is always unmounted when not open. - keepMounted: The popover's content initially unmounted, but stays mounted when popover is open.

Type

LazyMode

Default

'unmount'

Description

Props for multi select list element.

Type

Omit<SelectListProps, "children">

Description

If true, the popper will match the width of the reference at all times. It's useful for autocomplete, date-picker and select patterns.

Type

boolean

Default

false

Description

The maximum selectable value.

Type

number

Description

Array of popper.js modifiers. Check the docs to see the list of possible modifiers you can pass.

Type

Partial<Modifier<string, any>>[]

Docs

https://popper.js.org/docs/v2/modifiers/

Description

The HTML name attribute used for forms.

Type

string

Description

The main and cross-axis offset to displace popper element from its reference element.

Type

[number, number]

Description

If true, the selected item(s) will be excluded from the list.

Type

boolean

Default

false

Description

The callback invoked when value state changes.

Type

(value: string[]) => void

Description

Callback fired when the popover closes.

Type

() => void

Description

Callback fired when the popover opens.

Type

() => void

Description

The number of delay time to open.

Type

number

Default

200

Description

Props for select option element.

Type

Omit<OptionProps, "children" | "value">

Description

The placeholder of the select.

Type

string

Description

The placement of the popper relative to its reference.

Type

UIValue<Placement>

Default

'bottom'

Description

Props to be forwarded to the portal component.

Type

Omit<PortalProps, "children">

Default

'{ isDisabled: true }'

Description

If true, will prevent the popper from being cut off and ensure it's visible within the boundary area.

Type

boolean

Default

true

Description

The visual separator between each value.

Type

string

Default

','

Description

The size of the MultiSelect.

Type

"xs" | "sm" | "md" | "lg" | "xl"

Default

"md"

Description

The CSS positioning strategy to use.

Type

"fixed" | "absolute"

Default

'absolute'

Description

The value of the select.

Type

string[]

Description

The variant of the MultiSelect.

Type

"filled" | "flushed" | "outline" | "unstyled"

Default

"outline"

Edit this page on GitHub

PreviousSelect NextNativeSelect