A ui5-side-navigation-search-field is a search field,
used to filter the items of a ui5-side-navigation.
ES6 Module Import
import "@ui5/webcomponents-fiori/dist/SideNavigationSearchField.js";
Properties
accessibleDescriptionRef
| Description | Receives id (or many ids) of the elements that describe the component. |
| Type | string | undefined |
| Default | undefined |
accessibleName
| Description | Defines the accessible ARIA name of the component. |
| Type | string | undefined |
| Default | undefined |
accessibleNameRef
| Description | Receives id (or many ids) of the elements that label the component. |
| Type | string | undefined |
| Default | undefined |
hideClearIcon
| Description | Defines whether the clear icon of the search will be hidden.
Note: When not set, the clear icon is displayed while the component has a value. |
| Type | boolean |
| Default | false |
placeholder
| Description | Defines a short hint intended to aid the user with data entry when the component has no value. |
| Type | string | undefined |
| Default | undefined |
value
| Description | Defines the value of the component.
Note: The property is updated upon typing. |
| Type | string |
| Default | "" |
Slots
No slots available for this component.
Events
| Description | Fired when typing in input or clear icon is pressed. |
| Type | CustomEvent |
| Bubbles | Yes |
| Cancelable | No |
search
| Description | Fired when the user has triggered search with Enter key or Search Button press. |
| Type | CustomEvent |
| Bubbles | Yes |
| Cancelable | Yes - via preventDefault() |
Methods
No methods available for this component.
CSS Parts
No CSS parts available for this component.
CSS Custom States
No CSS custom states available for this component.