Listbox

BsListbox is a component that let users select one or more items from a displayed list.

Added since v2.0.0

Overview

BsListbox component mimics the HTML List Box: <select size="number"> element. This means that you can add attributes like readonly, or disabled and it will react to them to give the best experience. You can also use v-model directive to create two-way data bindings on the model-value property.

Selected value:

IMPORTANT

Do not use the model-value property when using v-model.

Multiple Selection

<bs-listbox> support multiple selection. Multiple selection mode feature can be enabled using the multiple property explicitly.

Selected values:

Using Checkbox

In multiple selection mode, the checkbox can be enabled via use-checkbox property.

No data to display.

Selected values:

Checkbox Position and Color

In multiple selection mode, the checkbox color can be changed via checkbox-color property and the position can be changed via checkbox-position property. Valid values for this property are: left (default), right. If these property is not defined, then default value will be used.

No data to display.

Selected values:

TIP

Any MDBootstrap Color variants and Material Color variants can be applied to the checkbox-color property.

Image Support

<bs-listbox> component supports displaying images or avatars. This feature can be enabled using the show-image property explicitly and use the imageField property on the configuration schema to point to the image field in the datasource. By default, the value of property imageField is set to image.

Selected value:

Image Size And Shape

The size of images can be controlled via image-size property. Sets this property to the desired numbers of pixels and the image will displayed according to this value. And use rounded-image or circle-image property to change its shape.

Selected value:

Custom List Items

<bs-listbox> list items can be organized in different ways by providing the custom template option-item slot.

No data to display.

Selected value:

CSS Variables

--md-searchbox-padding-x: 0.75rem;
--md-searchbox-padding-y: 0.5rem;
--md-searchbox-border-color: #{$gray-500};
--md-searchbox-focused-border-color: #{$default-active-bgcolor};
--md-searchbox-font-size: 14px;
--md-searchbox-text-color: #{$gray-900};
--md-searchbox-focused-shadow-rgba: #{rgba($default-active-bgcolor, 0.2)};

API Reference

Property	Type	Default	Description
autoload	Boolean	true	Autoload data from the configured dataSource, default is true. v2.0.5
borderless	Boolean	false	Hide the Listbox container borders.
checkbox-color	String	'default-color'	Sets the Listbox checkbox color. Any MDBootstrap Color variants and Material Color variants can be used.
checkbox-position	String	'left'	Sets the Listbox checkbox position. Valid values are: left, right.
circle-image	Boolean	false	Display image with circle shape for each item that has image property.
color	String	'white'	Define the Listbox background color. Any MDBootstrap Color variants and Material Color variants can be used.
data-source required	TDataSource		Sets the data source configuration.
disabled	Boolean	false	Put the component in disabled state and sets the <select> element disabled attribute.
empty-data-message	String	'No data to display.'	Sets the no data message when the Listbox is empty.
image-size	Number	48	Define the image size for each Listbox items when show-image is enabled.
item-separator	Boolean	false	Show or hide the Listbox item separator.
max-height	Number	300	Sets the Listbox container maximum height.
min-search-chars	Number	2	Minimum characters to check before start filtering the Listbox items.
min-search-length	Number	15	Minimum number of items to activate the search box.
model-value v-model	String/Number/Array		Monitored by v-model to maintain this field value.
multiple	Boolean	false	Enable/disable multi selection mode.
not-found-message	String	'Data not found.'	Sets the not found message when searching returns no result.
readonly	Boolean	false	Put the component in readonly state and sets the <select> element readonly attribute.
rounded-image	Boolean	false	Display image with rounded shape for each item that has image property.
search-label	String	'Search...'	The search box text label.
search-text v-model	String		Monitored by v-model to maintain the search box keyword.
show-image	Boolean	false	Show or hide image if Listbox item's object contains image property.
use-checkbox	Boolean	false	Use checkbox for multi selection mode.

Name	Arguments	Description
data-bind	( items:Object[])	Triggers after the data has been fetched.
data-error	( error:Object)	Triggers when error loading data items.
data-filter	( items:Object[])	Triggers after the Listbox data items is filtered.
deselect	( value:Object)	Triggers when an item is deselected.
select	( value:Object)	Triggers when an item is selected.
update:model-value	( value:String/Number/Array)	Triggers when the Listbox value is updated.
update:search-text	( value:String)	Triggers when the Listbox search value is updated.
update:selected-value	( selected:Object[])	Triggers when the Listbox selected value is updated.

Name	Arguments	Description
option-item	( item:Object, index:Number)	The outlet slot used to customize listbox items appearance.
empty-data-msg		The outlet slot used to place custom message when listbox is empty.
not-found-msg		The outlet slot used to place custom message when filtering listbox items returns no result.