UI: SearchField
A search input whose label is only announced. Import the token file once (@pithyx/ui/tokens.css) and wrap the app in UiProvider; see @pithyx/ui.
Generated from the TSDoc comments of @pithyx/ui 1.0.0-rc.9 at build time; the text below the headings is the comment in the source.
Interfaces
Section titled “Interfaces”SearchFieldProps
Section titled “SearchFieldProps”The props of SearchField; label is announced, not shown.
Extends
Section titled “Extends”Omit<AriaSearchFieldProps,"className"|"children">
Properties
Section titled “Properties”label: string;The accessible name, announced but not shown.
placeholder?
Section titled “placeholder?”optional placeholder?: string;The visible hint inside the empty input.
className?
Section titled “className?”optional className?: string;Extra class names, added after the field’s own.
Functions
Section titled “Functions”SearchField()
Section titled “SearchField()”function SearchField(props): Element;A search input whose label is only announced; the placeholder carries the visible hint. Escape and the clear button empty it.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
props |
SearchFieldProps |
React Aria’s search field props (value, onChange, onSubmit) plus label and placeholder. |
Returns
Section titled “Returns”Element
The search field.