MultiSelectProps

Interface

The MultiSelect component props

Properties

appendToBody optional

appendToBody: boolean

Whether to put the selected items to body

buttonProps optional

buttonProps: Pick<DropdownButtonPropsvoid | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void | void>

Exploiting properties from the internal DropdownButton component, except the property 'size'.

className optional

className: string

add a class name for multi-select

defaultValues optional

defaultValues: ImmutableArray<string | number>

The values of the items selected by default

displayByValues optional

displayByValues: function

Display the result text in the input box. Examples of the result texts are as "label1, label2, label3..."

Type declaration
    (valuesstring | number[]): string
    Parameters
    • valuesstring | number[]
    Returns 
    string

fluid optional

fluid: boolean

if it is true, the dropdown will fill the width of its parent container.

items

items: ImmutableArray<MultiSelectItem>

Options for selecting. and the contents of each option can be customized by rendering method

menuProps: DropdownMenuProps

Exploiting properties from the internal DropdownMenu component.

onClickItem optional

onClickItem: function

Callback fired when the item is clicked.

Type declaration
    (evtMouseEvent<ElementMouseEvent>, valuestring | number, selectedValuesstring | number[]): void
    Parameters
    • evtMouseEvent<ElementMouseEvent>
    • valuestring | number
    • selectedValuesstring | number[]
    Returns 
    void

placeHolder optional

placeHolder: string

The hint text displayed when the input is empty

size optional

size: ButtonSize

Defines the size of the dropdown button. The value will be 'default' when it is undefined.

values optional

values: ImmutableArray<string | number>

Selected values array

zIndex optional

zIndex: number

Control multi-select's z-index, but if the value of appendTo is "body", it'll be invalid

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.