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 '@getufy/flint-ui'; // auto-registers all
// or
import { FlintTransferList } from '@getufy/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.
leftTitleleftTitlestring'Options'Title displayed above the left (available) list.
rightTitlerightTitlestring'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
flint-transfer-list-change&#123; value: string[] &#125;Dispatched when items are moved between lists. detail: &#123; value: string[] &#125;

CSS Parts ​

NameDescription
actionsThe actions container.
baseThe component's base wrapper element.
headerThe header element.
left-listThe left list element.
right-listThe right list element.

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—