structyl

Transfer List

stable

Moves options between available and selected lists.

Basic usage

Available
Selected

Examples

Custom panel titles

Rename the source and target panels to match the workflow.

Available frameworks
Selected

Disabled options

Disable options that cannot be moved.

Available
Selected

Controlled transfer

Use value and onValueChange when app state owns the selected side.

Available
Chosen

Features

  • Controlled or uncontrolled.
  • Checkbox selection.

Installation

bash
pnpm dlx structyl add transfer-list

API Reference

TransferList

Two-list transfer control.

PropTypeDefault
options{ value: string; label: React.ReactNode; disabled?: boolean }[]

Available options.

value | defaultValuestring[]

Controlled or uncontrolled selected values.

onValueChange(value: string[]) => void

Called after moving values.

sourceTitle | targetTitleReact.ReactNode

Panel headings.

classNamestring

Additional Tailwind classes merged with the component defaults.

Transfer List | structyl