Skip to content 
Multiselect
Help text
Multiselect 🟠 Not ready
The Multiselect component can be used imported from:
Playground
Parameters
Events
This component has events. Check the documentation about how to use the events.
| Name | Payload | Description |
|---|---|---|
ngModelChange | string[] | Returns the new value of the model |
validated | boolean | Returns the validation status of the input |
blur | void | Fires when the input loses focus |
search | string | Returns the search query |
restarted | void | Fires when the input is reset |
Slots
This component has slots. Check the documentation about how to use the slots.
| Name | Tags | Description |
|---|---|---|
label | span | Slot for the input label |
help-text | span | Slot for the help text |
Parameters use
Check the documentation about how to use the parameters.
ngModel
Attention!
If you hardcode this value, it will not be reactive and the selection won't change. Use a variable instead and, ideally, a closed loop.
Controls the selected value of the input. The value needs to be one of the provided via options
config
The config parameter is used to set the shape of the input between lined and shaped. Being omitted will render the default shaped shape.
label
The label parameter is used to set the text label of the component. Make sure you always use it.
It can also use the label slot:
help-text
The help-text parameter is used to provide additional assistance to the user.
It can also use the help-text slot:
options
The options attribute is an array of objects that represent the chips. Each object inside the array should have the following properties:
text: The text that will be displayed inside the chip.value: The value of the option.disabled: A boolean that indicates if the chip is disabled.
We can use <option> tags to define the values of options
We can use slots to define the content of the cards with the option-<value> slot.
name
The name parameter is used to set the name of the component. This is useful when the component is part of a form.
Flags
readonly
The readonly parameter is used to set the input in a read-only state. It's commonly used to display information.
disabled
The disabled parameter is used to block the interaction with the component. Not to be confused with readonly.
required
The required parameter is used to set the component as required.
invalid
The invalid parameter is used to set the component as invalid.
The default text adapts to the localization:
with-search
The with-search parameter is used to apply an internal search feature to filter the available options.
You can change the label of the search using search-placeholder.
The input emits a search event that can be used for external filtering.
search-autofocus
The search-autofocus parameter (requires with-search) is used to apply autofocus in the search when this is visible.
Browser support
Detected engine:
Chromium
Webkit
Gecko
CodeSandbox example
Sorry, not available yet ☹️