DropDownListProps

Specifies the accessKey of the DropDownList.

<DropDownList accessKey="d" />

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

<DropDownList adaptive={true} />

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

<DropDownList adaptiveSubtitle="Adaptive Popup Subtitle" />



</td>
</tr>
<tr>
<td class="table-cell-name">


#### adaptiveTitle?


</td>
<td type class="table-cell-type">


<code>


string


</code>


</td>
<td class="table-cell-default">




</td>
<td class="table-cell-comment">


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.

```jsx
<DropDownList 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.

<DropDownList ariaDescribedBy="error-message-id" />

The accessible label of the component. By default is set to value of label prop.

<DropDownList ariaLabel="Accessible Label" />

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

<DropDownList ariaLabelledBy="label-id" />

Sets additional classes to the DropDownList.

<DropDownList className="custom-class" />

Sets the data of the DropDownList (see example).

<DropDownList data={['Item1', 'Item2', 'Item3']} />

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).

<DropDownList dataItemKey="id" />

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

<DropDownList defaultItem="Select an item" />

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

<DropDownList defaultValue="Item1" />

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

<DropDownList delay={300} />

Represents the dir HTML attribute.

<DropDownList dir="rtl" />

Sets the disabled state of the DropDownList.

<DropDownList disabled={true} />

Configures the fillMode of the DropDownList.

The available options are:

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

<DropDownList fillMode="flat" />

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

<DropDownList filter="search text" />

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

<DropDownList filterable={true} />

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).

<DropDownList footer={<div>Footer Content</div>} />

Sets the data item field that represents the start of a group. Applicable to objects data.

<DropDownList groupField="category" />

Fires when a DropDownList's group header item is about to be rendered. Used to override the default appearance of the group's headers.

<DropDownList groupHeaderItemRender={(li, itemProps) => <li>{itemProps.dataItem}</li>} />

Fires when a DropDownList's sticky group header item is about to be rendered. Used to override the default appearance of the sticky group header of the component.

<DropDownList groupStickyHeaderItemRender={(div, stickyHeaderProps) => <div>{stickyHeaderProps.dataItem}</div>} />

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

<DropDownList header={<div>Header Content</div>} />

Sets CSS classes to the expand icon DOM element.

<DropDownList iconClassName="custom-icon-class" />

Specifies the id of the component.

<DropDownList id="dropdown-id" />

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

<DropDownList ignoreCase={true} />

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

<DropDownList itemRender={(li, itemProps) => <li>{itemProps.dataItem}</li>} />

Renders a floating label for the DropDownList.

<DropDownList label="Dropdown Label" />

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.

<DropDownList leftRightKeysNavigation={false} />

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.

<DropDownList listNoDataRender={(element) => <div>No data available</div>} />

Sets the loading state of the DropDownList.

<DropDownList loading={true} />

Specifies the name property of the select DOM element.

<DropDownList name="dropdown-name" />

Fires each time the DropDownList gets blurred.

<DropDownList onBlur={(event) => console.log('Blurred')} />

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

<DropDownList onChange={(event) => console.log('Value changed')} />

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

<DropDownList onClose={(event) => console.log('Popup closed')} />

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

<DropDownList onFilterChange={(event) => console.log('Filter changed')} />

Fires each time the user focuses the DropDownList.

<DropDownList onFocus={(event) => console.log('Focused')} />

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

<DropDownList onOpen={(event) => console.log('Popup opened')} />

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

<DropDownList onPageChange={(event) => console.log('Page changed')} />

Sets the opened and closed state of the DropDownList.

<DropDownList opened={true} />

Configures the popup of the DropDownList.

<DropDownList 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 DropDownList.

The available options are:

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

<DropDownList rounded="large" />

Configures the size of the DropDownList.

The available options are:

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

<DropDownList size="small" />

Defines if DropDownList's disabled items will be skipped or focused when navigating through the list of items using a keyboard. Defaults to true.

<DropDownList skipDisabledItems={false} />

The styles that are applied to the DropDownList.

<DropDownList style={{ width: '200px' }} />

Sets the specified SVG icon.

<DropDownList svgIcon={{ name: 'custom-icon' }} />

Specifies the tabIndex of the DropDownList.

<DropDownList tabIndex={0} />

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

<DropDownList textField="name" />

Sets the title attribute to the DropDownList DOM element.

<DropDownList title="Dropdown Title" />

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 DropDownList (see example). It can either be of the primitive (string, numbers) or of the complex (objects) type.

<DropDownList value="Item1" />

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'));

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

<DropDownList valueRender={(element, value) => <span>{value}</span>} />

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

<DropDownList virtual={{ pageSize: 20 }} />