ComboboxControl Edit

ComboboxControl is an enhanced version of a SelectControl, with the addition of being able to search for options using a search input.

Table of contents Table of contents

  1. Design guidelines
  2. Development guidelines
  3. Related components

Top ↑

Design guidelines Design guidelines

These are the same as the ones for SelectControls, but this component is better suited for when there are too many items to scroll through or load at once so you need to filter them based on user input.

Top ↑

Development guidelines Development guidelines

Usage Usage

/**
 * WordPress dependencies
 */
import { ComboboxControl } from "@wordpress/components";
import { useState } from "@wordpress/compose";

const options = [
    {
        value: "small",
        label: "Small"
    },
    {
        value: "normal",
        label: "Normal"
    },
    {
        value: "large",
        label: "Large"
    },
    {
        value: "huge",
        label: "Huge"
    }
];

function MyComboboxControl() {
    const [fontSize, setFontSize] = useState();
    const [filteredOptions, setFilteredOptions] = useState(options);
    return (
        <ComboboxControl
            label="Font Size"
            value={fontSize}
            onChange={setFontSize}
            options={filteredOptions}
            onInputChange={(inputValue) =>
                setFilteredOptions(
                    options.filter(option =>
                        option.label.toLowerCase().startsWith(inputValue.toLowerCase())
                    )
                )
            }
        />
    );
}

Top ↑

Props Props

label label

The label for the control.

  • Type: String
  • Required: Yes

Top ↑

hideLabelFromVision hideLabelFromVision

If true, the label will only be visible to screen readers.

  • Type: Boolean
  • Required: No

Top ↑

help help

If this property is added, a help text will be generated using help property as the content.

  • Type: String
  • Required: No

Top ↑

options options

The options that can be chosen from.

  • Type: Array<{ value: String, label: String }>
  • Required: Yes

Top ↑

onInputChange onInputChange

Function called with the control’s search input value changes. The argument contains the next input value.

  • Type: Function
  • Required: No

Top ↑

onChange onChange

Function called with the selected value changes.

  • Type: Function
  • Required: No

Top ↑

value value

The current value of the input.

  • Type: mixed
  • Required: Yes

Top ↑

  • Like this component, but without a search input, the CustomSelectControl component.

  • To select one option from a set, when you want to show all the available options at once, use the Radio component.

  • To select one or more items from a set, use the CheckboxControl component.
  • To toggle a single setting on or off, use the ToggleControl component.