Transfer
Moves selected items between available and chosen collections.
See it and copy it
Framework example
Choose Astro, React, or Elements to compare native usage against the shared visual output. Each example assumes the framework-level setup is already complete.
Source
Target
View Transfer code
Framework usage
Switch targets to compare the adapter code. This live preview runs the Astro example. React and Elements use their own behavior APIs; complete the matching framework setup before copying an example.---
import { Transfer } from '@santi020k/lumen-astro'
---
<Transfer
sourceTitle="Source"
targetTitle="Target"
items={[{ key: '1', label: 'Item 1' }, { key: '2', label: 'Item 2' }]}
/>import { Transfer } from '@santi020k/lumen-react'
export const Example = () => (
<>
<Transfer
sourceTitle="Source"
targetTitle="Target"
items={[{ key: '1', label: 'Item 1' }, { key: '2', label: 'Item 2' }]}
/>
</>
)<script type="module">
import { defineLumenElements } from '@santi020k/lumen-elements/define'
defineLumenElements()
</script>
<lumen-transfer
source-title="Source"
target-title="Target"
items={[{ key: '1', label: 'Item 1' }, { key: '2', label: 'Item 2' }]}></lumen-transfer>Choose your target
Add this component
Choose the package for your runtime. All adapters share the Lumen stylesheet. Use the matching registry command when you want a local wrapper for that framework.
pnpm add @santi020k/lumen-astropnpm add @santi020k/lumen-astrolumen add Transferlumen add Transferpnpm add @santi020k/lumen-reactpnpm add @santi020k/lumen-reactlumen add Transfer --target reactlumen add Transfer --target reactpnpm add @santi020k/lumen-elementspnpm add @santi020k/lumen-elementslumen add Transfer --target elementslumen add Transfer --target elementsAPI reference
Lumen-specific props and runtime attributes for the Astro primitive. Use the framework differences above and the copyable examples for React composition and Elements attributes; the public adapter types define their supported contracts.
| Attribute | Values | Default | Description |
|---|---|---|---|
| items, targetItems | TransferItem[] | [] | Defines the available and initially chosen collections. |
| sourceTitle, targetTitle | string | "Available", "Selected" | Labels the two collections. |
| name | string | - | Sets the submitted values field name. |
| class, className | string | "" | Merges custom classes with the generated ui-* root classes. |
| ...native attributes | HTML attributes | - | Forwards standard attributes to the root element unless the component consumes them. |
Runtime events
CustomEvents dispatched by the Astro UIPrimitives runtime for this component.
| Event | Target | Detail | When |
|---|---|---|---|
| ui:transfer-change | Transfer root ([data-ui-transfer]) | { from: string, to: string, values: string[] } | Fires after checked items move between the source and target collections. |