Перейти к содержимому
v2.5.0
English
Русский
Документация

Listbox

Listbox — всегда видимый список, в котором выбирают один или несколько вариантов, как в нативном select с size.

Пропсы корня

ПропТипПо умолчанию
multipleM—
Позволяет выбирать несколько вариантов. Определяет форму value: массив, когда true.
valueM extends true ? V[] : V | null—
Текущее выбранное значение (контролируемо). Без multiple значение null очищает выбор, а undefined делает список неконтролируемым.
defaultValueListboxValue<V, M>—
Значение, выбранное по умолчанию (неконтролируемо).
onChangeValue(value: ListboxValue<V, M>) => void—
Колбэк, вызываемый при изменении выбора.
disabledboolean—
Запрещает взаимодействие и убирает список из порядка обхода по Tab.
sizeOptionSize'md'
Визуальный размер вариантов.
typeaheadbooleantrue
Включает переход к варианту при наборе начала его подписи.
refRef<HTMLDivElement>—
Ref, передаваемый на элемент списка.

Также принимает все атрибуты <div>.

Дочерние части

ListboxOption

  • value: значение, которое передаётся в onChangeValue при выборе варианта. Обязательный.
  • label: простой текст для поиска при вводе, используется вместо текста содержимого.
  • disabled: делает вариант недоступным.
  • size: переопределяет размер списка.

ListboxGroup

Группирует связанные варианты, как нативный optgroup. Назовите группу через aria-labelledby, указывающий на ваш заголовок, или через aria-label.

ListboxOption

ПропТипПо умолчанию
valueобязательныйV—
Значение этого варианта, которое передаётся в колбэк изменения при его выборе.
labelstring—
Простой текст варианта для поиска при наборе; используется вместо текста его содержимого.
childrenReactNode—
Содержимое, отображаемое для этого варианта. Может включать текст, иконки или сложную разметку.
sizeOptionSize—
Размер варианта для визуальной стилизации.
disabledboolean—
Отключает весь Option.
refRef<HTMLDivElement>—
Ref, передаваемый на корневой div варианта.

Также принимает все атрибуты <div>.

ListboxGroup

ПропТипПо умолчанию
refRef<HTMLDivElement>—
Ref, передаваемый на элемент группы.

Также принимает все атрибуты <div>.

Типы

  • ListboxProps<V, M>: V — тип значений, M равен true при multiple
  • ListboxOptionProps<V>
  • ListboxGroupProps
  • ListboxValue<V, M>

Модель состояния

  • Список владеет выбором, активным вариантом и поиском при вводе.
  • Без multiple значение — один вариант, с multiple — массив.