FilterMenuSearchField API
API reference docs for theFilterMenuSearchFieldcomponent. For examples and details on the usage of this component, visit the component demo page.
Props
The FilterMenuSearchField internally uses Field component. It inherits most of the Field props and adds few more functionalities.
| Prop | Type | Description | Default |
|---|---|---|---|
children | ReactNode | The content to be displayed inside the field. | _ |
label | ReactNode | Label for the input. | _ |
controlId? | string | Specifies the unique identifier for the form control within the component. See Field API for more details. | _ |
counter? | string | Counter object containing maxValue and value. "maxValue:" maximum value the counter can reach. "value:" current value of the counter. | _ |
description? | ReactNode | Provide additional information that will aid user input. | _ |
errorMessage? | ReactNode | Message to show when the field is invalid. | _ |
isDisabled? | boolean | Whether the field is disabled. | false |
isRequired? | boolean | Whether user input is required on the field. | false |
labelVisibility? | 'visible' | 'hidden' | A label must always be provided for assistive technology, but you may hide it from sighted users when the intent can be inferred from context. | 'hidden' |
secondaryLabel? | ReactNode | Additional context, typically used to indicate that the field is optional. | _ |