Skip to content

Transfer List ​

Loading...

A premium Transfer List component for moving items between two lists.

  • Tag: <flint-transfer-list>
  • Class: FlintTransferList

Import ​

ts
import 'flint-ui'; // auto-registers all
// or
import { FlintTransferList } from 'flint-ui';

Usage ​

html
<flint-transfer-list></flint-transfer-list>

Properties ​

PropertyAttributeTypeDefaultDescription
optionsoptionsTransferOption[][]Available options to display in the transfer list.
valuevaluestring[][]Currently selected values (items in the right list).
defaultValuedefault-valuestring[][]Initial value for uncontrolled usage. Applied once on first render.
leftTitleleft-titlestring'Options'Title displayed above the left (available) list.
rightTitleright-titlestring'Selected'Title displayed above the right (selected) list.
disableddisabledbooleanfalseWhether the transfer list is disabled.
searchablesearchablebooleanfalseWhether to show search inputs for filtering each list.

Events ​

EventDetailDescription
change—Dispatched when items are moved between lists. Detail: { value: string[] }

CSS Custom Properties ​

PropertyDefault
--flint-transfer-list-width—
--flint-transfer-list-height—
--flint-font-family—
--flint-text-color—
--flint-text-color-muted—
--flint-text-color-on-primary—
--flint-primary-color—
--flint-surface-2—
--flint-border-color—
--flint-border-radius-md6px
--flint-primary-focus-ring—
--flint-surface-1—
--flint-border-radius-lg—
--flint-shadow-sm—
--flint-hover-color—
--flint-primary-color-light—
--flint-shadow-md—