Skip to content

TransferList ​

Moves options between available and selected panels with search, grouping, drag reordering, and keyboard reordering.

Import ​

ts
import { TransferList } from '@astryx-vue/lab'

Props ​

NameTypeDefaultDescription
modelValuereadonly T[][]Selected values in order, bound with v-model.
optionsreadonly TransferListOption<T>[]RequiredAll options with unique values.
labelstringRequiredAccessible control name.
selectedLabel / availableLabelstringBuilt-in textPanel headings.
descriptionstringundefinedSupporting text below the label.
isLabelHiddenbooleanfalseHides the label visually.
hasSearchbooleanfalseShows shared search.
searchLabel / searchPlaceholderstringBuilt-in textSearch label and placeholder.
isReorderablebooleantrueAllows selected-option reordering.
hasSelectAll / hasClearbooleanfalseShows bulk add and clear actions.
selectedEmptyText / availableEmptyText / noResultsTextstringBuilt-in textEmpty-state text.

Options support group, description, isTransferDisabled, isReorderDisabled, and disabledMessage. change emits the latest value; use #option="{ option }" to customize rows.