For AI agents: the complete documentation index is available at https://rickyshin93.github.io/tao-ui/llms.txt, the full documentation bundle is available at https://rickyshin93.github.io/tao-ui/llms-full.txt, and this page is available as Markdown at https://rickyshin93.github.io/tao-ui/components/transfer.md.
v0.0.57
  • English
  • Transfer

    Data Entry@rockshin/tao-ui

    Moves records between available and selected collections.

    When to use

    Use for selecting several records while keeping both collections visible. Keep targetKeys in application state and use stable item keys.

    Examples

    Controlled target records

    Select records, then use the middle action to move them. Disabled records cannot be selected.

    390 × 640
    TSX

    Controlled selection and events

    selectedKeys controls checkbox state independently from targetKeys. onChange also reports the direction and moved keys.

    1/12 itemsSource
    0 itemsTarget
    • No data
    No records moved
    TSX

    Search by multiple fields

    filterOption receives the search text, item and list direction. The rendered label can differ from the searchable value.

    12 itemsSource
    0 itemsTarget
    • No data
    TSX

    One-way transfer and pagination

    oneWay moves records right and removes them from the target list individually. Pagination applies to each list.

    10 itemsSource
    • /3
    2 itemsTarget
    • Member 2
    • Member 4
    • /1
    TSX

    Footers and selection labels

    Provide a footer for each direction and show selected counts with selectAllLabels.

    0 / 12 availableSource
    Choose team members
    0 / 0 selectedTarget
    • No data
    Members added to this project
    TSX

    Custom list body

    The render function receives filteredItems, selectedKeys and selection callbacks. Preserve disabled behavior in your custom controls.

    12 itemsSource
    0 itemsTarget
    TSX

    Custom keys, status and disabled state

    rowKey supports records whose identifier is not named key. Source and target semantic styles can be configured separately.

    3 itemsSource
    0 itemsTarget
    • No data
    Select at least one team.
    TSX

    API

    Transfer

    PropertyDescriptionTypeDefault Value
    disabledWhether to disableboolean | undefined-
    renderItem content; defaults to the title, or the key when the title is omitted.((item: T) => RenderResult) | undefined-