Обзор
SearchInput предоставляет значок поиска и текстовое поле ввода. onValueChange получает новую строку; onChange получает нативное событие изменения React. Фильтрация, получение данных и устранение дребезга относятся к вашему приложению.
Использование
aria-label или aria-labelledby для доступного имени.
Нативные свойства input, className, style и ref применяются к самому полю ввода. Общий InputGroup отвечает за оформление поиска и фокуса. Обертка, которая размещает поле и его действия, не принимает свойств; поместите SearchInput в собственный контейнер, чтобы задать его размер или положение. Используйте size="sm" для компактного поля поиска.
Действия
actions отображает элементы управления после поля поиска. Создайте всплывающее окно фильтра с Dropdown, триггером которого является IconButton, и задайте этой кнопке доступное имя.
disabled отключает только текстовое поле; элементы управления действиями отключаются отдельно. При size="sm" также передайте size="sm" элементам управления действиями.
Свойства
ReactNode
Controls rendered after the search field, such as a filter Dropdown. Set their size and accessible names on the controls.
string
Accessible name when aria-labelledby is absent.
string
ID of the element that labels the input. Takes precedence over aria-label.
boolean
Focuses the input when mounted.
string | ((state: InputState) => string | undefined)
Class applied to the input.
string | number | readonly string[]
The default value of the input. Use when uncontrolled.
boolean
Disables the text input. Controls in actions keep their own state.
boolean
по умолчанию:"false"
Shows the group focus border. Defaults to false for all search inputs. Set true to opt in. Error styling remains visible.
string
Input ID, generated when omitted.
((event: BaseUIEvent<ChangeEvent<HTMLInputElement, HTMLInputElement>>) => void)
Native input change event handler.
((value: string, eventDetails: { reason: "none"; event: Event; cancel: () => void; allowPropagation: () => void; isCanceled: boolean; isPropagationAllowed: boolean; trigger: Element | undefined; }) => void)
Called with the new text. The application owns filtering.
string
Hint shown when the input is empty. Also used as the accessible name if no explicit label is supplied.
Ref<HTMLInputElement>
Ref to the native input element.
ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, InputState>
Allows you to replace the component’s HTML element
with a different tag, or compose it with another component.Accepts a
ReactElement or a function that returns the element to render."md" | "sm"
по умолчанию:"md"
Visual size of the input group.
CSSProperties | ((state: InputState) => CSSProperties | undefined)
Style applied to the element, or a function that
returns a style object based on the component’s state.
"end" | "start"
Aligns text to the logical start or end of the input. Follows the text direction.
string | number | readonly string[]
Current search text.