Skip to content

Latest commit

 

History

History
151 lines (103 loc) · 3.97 KB

README.md

File metadata and controls

151 lines (103 loc) · 3.97 KB

ComboboxControl

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

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.

Development guidelines

Usage

import { useState } from 'react';
import { ComboboxControl } from '@wordpress/components';

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

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

Props

label

The label for the control.

  • Type: String
  • Required: Yes

hideLabelFromVision

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

  • Type: Boolean
  • Required: No

help

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

  • Type: String
  • Required: No

options

The options that can be chosen from.

  • Type: Array<{ value: string, label: string, disabled?: boolean }>
  • Required: Yes

onFilterValueChange

Function called when the control's search input value changes. The argument contains the next input value.

  • Type: ( value: string ) => void
  • Required: No

onChange

Function called with the selected value changes.

  • Type: ( value: string | null | undefined ) => void
  • Required: No

value

The current value of the control.

  • Type: string | null
  • Required: No

expandOnFocus

Automatically expand the dropdown when the control is focused. If the control is clicked, the dropdown will expand regardless of this prop.

  • Type: Boolean
  • Required: No
  • Default: true

placeholder

If passed, the combobox input will show a placeholder string if no values are present.

  • Type: string
  • Required: No

__experimentalRenderItem

Custom renderer invoked for each option in the suggestion list. The render prop receives as its argument an object containing, under the item key, the single option's data (directly from the array of data passed to the options prop).

  • Type: ( args: { item: object } ) => ReactNode
  • Required: No

__next40pxDefaultSize

Start opting into the larger default height that will become the default size in a future version.

  • Type: Boolean
  • Required: No
  • Default: false

__nextHasNoMarginBottom

Start opting into the new margin-free styles that will become the default in a future version.

  • Type: Boolean
  • Required: No
  • Default: false

Related components

  • 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 RadioControl 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.