Suggest Input API
API Reference e-suggest-input
This component features render debouncing.
You may have to wait for the next browser tick after rendering in your integration/E2E tests.
HTML Attributes API
| Name | Description | Type | Required | Default value |
|---|---|---|---|---|
options |
An array of strings to use as suggestions | array * | [] |
|
value |
A predefined value for the input field | string | ||
placeholder |
Placeholder text for the input field | string | ||
disabled |
Disable input, preventing entering or selected values | boolean | false |
|
readonly |
Makes the input readonly, preventing entering or selected values | boolean | false |
|
loading |
Sets the list of options into a loading state with a spinner | boolean | false |
|
error |
Sets the input into error state | boolean | false |
*: An array of strings that will be used as options
JavaScript API
| Name | Type | Description | Arguments |
|---|---|---|---|
open() |
Open the list of suggestions | ||
close() |
Close the list of suggestions |
Events
| Event | Description | Returns |
|---|---|---|
change |
Signals a change in value of the input field either by typing or by selecting an option | |
blur |
Dispatches an event when the component loses focus |