Skip to content

Design system

Documentation

DesignComponents / Transfer

Components / Transfer

Stable

Transfer

Select and move multiple records between two searchable lists in batches.

On this page

Examples

Move records in batches

Select multiple available values and move them in one action.

Available

3

Selected

1

Workspace permission transfer

Disabled item

Unavailable values remain visible but cannot be selected or moved.

Available

2

Selected

1

Transfer with a disabled item

Try the transfer

Inspect the two bounded lists and batch controls.

Available modules

2

Enabled modules

1

Transfer property playground

Usage

import { Transfer } from "@phuctech/ui/components/transfer";

<Transfer label="Workspace permissions" items={items} value={member.accessIds} onValueChange={setAccessIds} />

Behavior

Available and selected lists derive from the complete items collection and the controlled destination value. Search is local and separate for each list. Selection is interaction state; moving uses one batch callback. Select-all changes only visible enabled items and preserves hidden selections.

API

Component API
PropTypeDefaultDescriptionConstraints
label / itemsstring / readonly TransferItem[]requiredAccessible transfer group name and complete fixture/data set.Item keys must be stable and unique.
value / defaultValuereadonly string[][]Controlled target keys or initial target keys.Keep the controlled value synchronized with onValueChange.
onValueChange(keys: readonly string[]) => void—Reports the complete next target key set after a batch move.The feature owns persistence and business authorization.
sourceTitle / targetTitlestring"Available" / "Selected"Names each list and its search field.Use short, distinct titles.
emptyMessagestring"No items in this list."Message shown when the complete data set is empty.A filtered list instead explains that no items match.
disabledbooleanfalseDisables selection, search, and movement.An individual item may also be disabled.

Accessibility

The root has a name, each list is a named section, search fields and checkboxes identify their target, and move buttons state the destination. Selection is exposed through shared Checkbox semantics. Long lists scroll inside their panels while titles and search controls remain fixed.

  • List presents one collection without transfer behavior.
  • Checkbox provides the shared selection control.