DropDownListToolProps

The props for the DropDownList tool component for inline styling of the Editor.

accessKey?

Specifies the accessKey of the DropDownList.

ariaDescribedBy?

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.

ariaLabelledBy?

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

className?

Sets additional classes to the DropDownList.

data?

Sets the data of the DropDownList (see example).

dataItemKey?

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

defaultItem?

Sets the text of the default empty item. The type of the defined value has to match the data type.

defaultValue?

Sets the default value of the DropDownList (see example). Similar to the native select HTML element.

delay?

Sets the delay before an item search is performed. When filtration is disabled, use this option.

dir?

Represents the dir HTML attribute.

disabled?

Sets the disabled state of the DropDownList.

filter?

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

filterable?

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

focusedItemIndex?

If set, the DropDownList will use it to get the focused item index.

Default functionality returns the first item which starts with the input text.

Copy Codeconst focusedItemIndex = (data, inputText, textField) => {
    let text = inputText.toLowerCase();
    return data.findIndex(item =>
        String(textField ? item[textField] : item).toLowerCase().includes(text));
};

<DropDownList focusedItemIndex={focusedItemIndex} />

footer?

Sets the footer component of the DropDownList (see example).

header?

Sets the header component of the DropDownList (see example).

iconClassName?

Sets CSS classes to the expand icon DOM element.

id?

Specifies the id of the component.

ignoreCase?

Enables a case-insensitive search. When filtering is disabled, use this option.

itemRender?

Fires when a DropDownList item is about to be rendered (see example). Used to override the default appearance of the list items.

label?

Renders a floating label for the DropDownList.

leftRightKeysNavigation?

If set to false, the DropDownList will not navigate over its data through left and right keys. Useful when the DropDownList is placed inside a toolbar which needs to handle left and right keys.

listNoDataRender?

Fires when the element which indicates no data in the popup is about to be rendered (see example). Used to override the default appearance of the element.

loading?

Sets the loading state of the DropDownList.

name?

Specifies the name property of the select DOM element.

onBlur?

Fires each time the DropDownList gets blurred.

onChange?

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

onClose?

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

onFilterChange?

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

onFocus?

Fires each time the user focuses the DropDownList.

onOpen?

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

onPageChange?

Fires when both the virtual scrolling of the DropDownList is enabled and the component requires data for another page (see example).

opened?

Sets the opened and closed state of the DropDownList.

popupSettings?

Configures the popup of the DropDownList.

render?

Fires when a tool is about to be rendered. Used to override the default appearance of the tool.

required?

Specifies if null is a valid value for the component.

This property is part of the FormComponentProps interface.

style?

The styles that are applied to the DropDownList.

tabIndex?

Specifies the tabIndex of the DropDownList.

textField?

Sets the data item field that represents the item text (see example). If the data contains only primitive values, do not define it.

valid?

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.

validationMessage?

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.

validityStyles?

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.

value?

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

valueMap?

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

Copy Codeclass App extends React.Component {
   render() {
      return (
         <form>
             <DropDownList
                 data={[ { text: "Austria", id: 1 } , { text: "Belarus", id: 2 } ]}
                 valueMap={value => value && value.id}
             />
             <button type="submit">Submit</button>
         </form>
      );
   }
}
ReactDOM.render(<App />, document.querySelector('my-app'));

valueRender?

Fires when the element which renders the value is about to be rendered (see example). Used to override the default appearance of the element.

view?

The EditorView object of the Editor component.

virtual?

Configures the virtual scrolling of the DropDownList (see example).