MultiSelectTreeProps

Specifies the accessKey of the MultiSelectTree.

<MultiSelectTree accessKey="m" />

Providing different rendering of the popup element based on the screen dimensions.

<MultiSelectTree adaptive={true} />

Specifies the text that is rendered as subtitle in the adaptive popup(action sheet). Applicable only when adaptive is set to true.

<MultiSelectTree adaptiveSubtitle="Adaptive Popup Subtitle" />

Specifies the text that is rendered as title in the adaptive popup(action sheet). Applicable only when adaptive is set to true. If not provided, the title will be the same as the label.

<MultiSelectTree adaptiveTitle="Adaptive Popup Title" />

Identifies the element(s) which will describe the component, similar to HTML aria-describedby attribute. For example these elements could contain error or hint message.

<MultiSelectTree ariaDescribedBy="description" />

Identifies the element(s) which will label the component.

<MultiSelectTree ariaLabelledBy="label" />

Specifies the name of the field which will provide a Boolean representation of the checked state of the item.

<MultiSelectTree checkField="checked" />

Specifies the name of the field which will provide a Boolean representation of the checked indeterminate state of the item.

<MultiSelectTree checkIndeterminateField="indeterminate" />

Sets additional classes to the MultiSelectTree.

<MultiSelectTree className="custom-class" />

Sets the data of the MultiSelectTree (see example).

<MultiSelectTree data={[{ text: 'Node1' }, { text: 'Node2' }]} />

Sets the key for comparing the data items of the MultiSelectTree (see example). If dataItemKey is not set, the MultiSelectTree compares the items by reference.

<MultiSelectTree dataItemKey="id" />

Represents the dir HTML attribute.

<MultiSelectTree dir="rtl" />

Sets the disabled state of the MultiSelectTree.

<MultiSelectTree disabled={true} />

Specifies the name of the field which will provide a Boolean representation of the expanded state of the item.

<MultiSelectTree expandField="expanded" />

Configures the fillMode of the MultiSelectTree.

The available options are:

• solid
• flat
• outline
• null—Does not set a fillMode className.

<MultiSelectTree fillMode="outline" />

Sets the value of filtering input. Useful for making the filtering input a controlled component.

<MultiSelectTree filter="search text" />

Enables the filtering functionality of the MultiSelectTree (more information and examples).

<MultiSelectTree filterable={true} />

Specifies the id of the component.

<MultiSelectTree id="multi-select-tree" />

Defines the component that will be used for rendering each of the MultiSelectTree items (see example).

<MultiSelectTree item={(props) => <div>{props.item.text}</div>} />

Renders a floating label for the MultiSelectTree.

<MultiSelectTree label="Select items" />

Defines the component that will be rendered in the MultiSelectTree popup when no data is available (see example).

<MultiSelectTree listNoData={() => <div>No data available</div>} />

Sets the loading state of the MultiSelectTree (see example).

<MultiSelectTree loading={true} />

Specifies the name property of the input DOM element.

This property is part of the FormComponentProps interface.

Fires each time the MultiSelectTree gets blurred.

<MultiSelectTree onBlur={(event) => console.log(event)} />

Fires each time the popup of the MultiSelectTree is about to cancel in (adaptive mode).

<MultiSelectTree onCancel={(event) => console.log(event)} />

Fires each time the value of the MultiSelectTree is about to change (see examples).

<MultiSelectTree onChange={(event) => console.log(event)} />

Fires each time the popup of the MultiSelectTree is about to close.

<MultiSelectTree onClose={(event) => console.log(event)} />

Fires when the expanding or collapsing of an item is requested (see examples).

<MultiSelectTree onExpandChange={(event) => console.log(event)} />

Fires each time the user types in the filter input (see example). You can filter the source based on the passed filtration value.

<MultiSelectTree onFilterChange={(event) => console.log(event)} />

Fires each time the user focuses the MultiSelectTree.

<MultiSelectTree onFocus={(event) => console.log(event)} />

Fires each time the popup of the MultiSelectTree is about to open.

<MultiSelectTree onOpen={(event) => console.log(event)} />

Sets the opened state of the MultiSelectTree.

<MultiSelectTree opened={true} />

The hint that is displayed when the MultiSelectTree is empty.

<MultiSelectTree placeholder="Select items" />

Configures the popup of the MultiSelectTree.

<MultiSelectTree popupSettings={{ animate: true }} />

Specifies if null is a valid value for the component.

This property is part of the FormComponentProps interface.

Configures the roundness of the MultiSelectTree.

The available options are:

• small
• medium
• large
• full
• null—Does not set a rounded className.

<MultiSelectTree rounded="full" />

Configures the size of the MultiSelectTree.

The available options are:

• small
• medium
• large
• null—Does not set a size className.

<MultiSelectTree size="large" />

The styles that are applied to the MultiSelectTree.

<MultiSelectTree style={{ width: '400px' }} />

Specifies the name of the field which will provide an array representation of the item subitems. Defaults to 'items'.

<MultiSelectTree subItemsField="children" />

Specifies the tabIndex of the MultiSelectTree.

<MultiSelectTree tabIndex={0} />

Defines the component that will be used for rendering each of the MultiSelectTree tags.

<MultiSelectTree tag={(props) => <span>{props.tagData.text}</span>} />

Sets the tags of the MultiSelect (see example).

<MultiSelectTree tags={[{ text: 'Tag1' }, { text: 'Tag2' }]} />

Sets the data item field that represents the item text (see example).

<MultiSelectTree textField="name" />

Overrides the validity state of the component. If valid is set, the required property will be ignored.

This property is part of the FormComponentProps interface.

Controls the form error message of the component. If set to an empty string, no error will be thrown.

This property is part of the FormComponentProps interface.

If set to false, no visual representation of the invalid state of the component will be applied.

This property is part of the FormComponentProps interface.

Sets the value of the MultiSelectTree. It can either be of the primitive (string, numbers) or of the complex (objects) type.

<MultiSelectTree value={['Node1']} />

Represents a callback function, which returns the value for submitting. The returned value will be rendered in an option of a hidden select element.

<MultiSelectTree valueMap={value => value && value.id} />