SiSearchBarComponent documentation¶
selector
si-search-barInput Properties¶
| Name | Type | Default | Description |
|---|---|---|---|
| clearButtonAriaLabel ¶ | TranslatableString | $localize`:@@SI_SEARCH_BAR.CLEAR_BUTTON:Clear` | Aria label for the clear button. |
| colorVariant ¶ | BackgroundColorVariant | 'base-1' | Color to use for component background |
| debounceTime ¶ | number | 400 | Time unit change of search input takes effect. |
| disabled ¶ | boolean | false | Whether the input is disabled. |
| maxlength ¶ | number | undefined | Defines the maximum length of the search input. |
| placeholder ¶ | string | '' | Define search input placeholder. |
| prohibitedCharacters ¶ | string | Prohibited characters restricting search. | |
| readonly ¶ | boolean | false | Whether the input can be focused but not edited. |
| showIcon ¶ | boolean | false | Display search icon before search input. |
| value ¶ | string | Define search input content. |
Output Properties¶
| Name | Type | Description |
|---|---|---|
| searchChange ¶ | string | Output callback event will provide you with search term if search input changes. |
Types Documentation¶
| Represents a translatable string. This can either be a translation key, e.g. ACTIONS.EDIT that will be automatically translated when displayed on the UI or a pre-translated string, e.g. Edit . Equivalent to a normal string in usage and functionality. |
|---|
| Use this type with filter components colorVariant to render component variants based on background of container |
|---|
Except where otherwise noted, content on this site is licensed under MIT License.