Documentation

Radius

The listbox is a component that renders a list of items. It can be used to render a list of text, media or complex objects. The default shape is rounded.

Default props of all <BaseListbox> can be set in your <app>/app.config.ts.
Show code
vue

Size

The listbox is a component that renders a list of items. It can be used to render a list of text, media or complex objects. The default size is md.

Show code
vue

Contrast:default+

The listbox can be rendered in different contrast modes. The default contrast mode is default. Contrast can affect the color of the text and the background of the element, as well as the light or the dark mode.

Show code
vue

Contrast:muted

The listbox can be rendered in different contrast modes. Contrast can affect the color of the text and the background of the element, as well as the light or the dark mode.

Show code
vue

Contrast:muted+

The listbox can be rendered in different contrast modes. Contrast can affect the color of the text and the background of the element, as well as the light or the dark mode.

Show code
vue

Error

The listbox can be shown in an error state using the error prop. You can also set a custom error message using the same prop.

This field is required
This field is required
This field is required
Show code
vue

Disabled

Listbox can be shown in a disabled state using the disabled prop.

Show code
vue

Loading

Listbox can be shown in a loading state using the loading prop.

Show code
vue

Label:float

Listbox can have a material design style floating label using the labelFloat prop.

Show code
vue

Listbox items can have a sublabel using the sublabel prop of the properties object.

Show code
vue

Listbox with icon

Listbox items can have an icon using the icon prop of the properties object.

Show code
vue

Listbox with media

Listbox items can have a media using the media prop of the properties object.

Show code
vue

Multiple selection

Listbox can be used to select multiple items using the multiple prop.

Show code
vue
v-model
Show example
vue
items
The items to display in the multiselect.
Required
Show example
vue
classes
Optional CSS classes to apply to the wrapper, label, input, addon, error, and icon elements.
Show example
vue
color-focus
Wether the border should change color when focused
Show example
vue
disabled
Whether the multiselect is disabled.
Show example
vue
error
An error message or boolean value indicating whether the input is in an error state.
Show example
vue
fixed
Used a fixed strategy to float the component
Show example
vue
icon
The icon to display for the multiselect.
Show example
vue
label
The label to display for the multiselect.
Show example
vue
label-float
If the label should be floating.
Show example
vue
loading
Whether the multiselect is in a loading state.
Show example
vue
multiple
Whether the multiselect allows multiple selections.
Show example
vue
multiple-label
The label to display for multiple selections, or a function that returns the label.
Show example
vue
placeholder
The placeholder text to display when no selection has been made.
Show example
vue
properties
The properties to use for the value, label, sublabel, media, and icon of the options items.
Show example
vue
selected-icon
The icon to show when the component is selected.
Show example
vue
rounded
The radius of the multiselect.

@since

2.0.0

Show example
vue
placement
The placement of the component via floating-ui.
Show example
vue
contrast
The contrast of the listbox.
Show example
vue
size
The size of the listbox.
Show example
vue
#label
Show example
vue
#icon
Show example
vue
#listbox-button
Show example
vue
#listbox-item
Show example
vue
active
Whether the item is focus/hover or not.
Show example
vue
selected
Whether the item is selected or not.
Show example
vue
selected-icon
The icon to show when the component is selected.
Show example
vue
value
The values to display in the component.
Show example
vue