Editor / API / DropDownListToolProps
material theme

DropDownListToolProps

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

accessKey? string

Specifies the accessKey of the DropDownList.

className? string

Sets additional classes to the DropDownList.

data? any[]

Sets the data of the DropDownList (see example).

dataItemKey? string

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? any

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

defaultValue? any

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

delay? number

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

dir? string

Represents the dir HTML attribute.

disabled? boolean

Sets the disabled state of the DropDownList.

filter? string

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

filterable? boolean

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

focusedItemIndex? (data: any, inputText: string, textField?: string) => number

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.

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

<DropDownList focusedItemIndex={focusedItemIndex} />

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

header? React.ReactNode

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

iconClassName? string

Sets CSS classes to the expand icon DOM element.

ignoreCase? boolean

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

itemRender? (li: ReactElement<HTMLLIElement>, itemProps: ListItemProps) => React.ReactNode

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

label? string

Renders a floating label for the DropDownList.

listNoDataRender? (element: ReactElement<HTMLDivElement>) => React.ReactNode

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? boolean

Sets the loading state of the DropDownList.

name? string

Specifies the name property of the select DOM element.

onBlur? (event: DropDownListBlurEvent) => void

Fires each time the DropDownList gets blurred.

onChange? (event: DropDownListChangeEvent) => void

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

onClose? (event: DropDownListCloseEvent) => void

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

onFilterChange? (event: DropDownListFilterChangeEvent) => void

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

onFocus? (event: DropDownListFocusEvent) => void

Fires each time the user focuses the DropDownList.

onOpen? (event: DropDownListOpenEvent) => void

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

onPageChange? (event: DropDownListPageChangeEvent) => void

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

opened? boolean

Sets the opened and closed state of the DropDownList.

popupSettings? DropDownsPopupSettings

Configures the popup of the DropDownList.

render? (tool: ReactElement<any>, args?: any) => React.ReactNode

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

required? boolean

Specifies if null is a valid value for the component.

This property is part of the FormComponentProps interface.

style? CSSProperties

The styles that are applied to the DropDownList.

tabIndex? number

Specifies the tabIndex of the DropDownList.

textField? string

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

valid? boolean

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? string

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? boolean

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? any

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

valueMap? (value: any) => any

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

class 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? (element: ReactElement<HTMLSpanElement>, value: any) => React.ReactNode

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? EditorView

The EditorView object of the Editor component.

virtual? VirtualizationSettings

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

 /