← All Components
<mth-transfer-list>
Form-associated dual-pane shuttle transfer list with per-pane filtering, select-all, and directional move controls.
When NOT to use: Use a lightweight @methane-ui/css layout class instead of a custom element when static CSS suffices.
Live Interactive Preview
Ready · interact with <mth-transfer-list>, or toggle Theme, Direction (LTR/RTL), or props above.
Multi-Framework Playground & Snippets
<script type="module" src="@methane-ui/ui/transfer-list"></script>
<mth-transfer-list searchable></mth-transfer-list>import '@methane-ui/ui/transfer-list';
import '@methane-ui/react';
export function Example() {
return <mth-transfer-list searchable></mth-transfer-list>;
}<script setup lang="ts">
import '@methane-ui/ui/transfer-list';
</script>
<template>
<mth-transfer-list searchable></mth-transfer-list>
</template>import { Component, CUSTOM_ELEMENTS_SCHEMA } from '@angular/core';
import '@methane-ui/ui/transfer-list';
import { MthTransferListDirective } from '@methane-ui/angular';
@Component({
standalone: true,
schemas: [CUSTOM_ELEMENTS_SCHEMA],
imports: [MthTransferListDirective],
template: `<mth-transfer-list searchable></mth-transfer-list>`,
})
export class ExampleComponent {}<script lang="ts">
import '@methane-ui/ui/transfer-list';
import MthTransferList from '@methane-ui/svelte/MthTransferList.svelte';
</script>
<MthTransferList searchable></MthTransferList>Properties & Attributes
| Property | Attribute | Type | Default | Description |
|---|---|---|---|---|
name | name | string | "" | Form field name submitted with FormData. |
value | value | string | "" | Comma-separated list of target item keys. |
defaultValue | default-value | string | "" | Initial target keys used when resetting the form. |
options | — | ReadonlyArray<unknown> | null | null | Full list of TransferListItem options distributed across source and target panes. |
label | label | string | "" | Accessible group label. |
sourceTitle | source-title | string | "" | Heading shown above the source pane. |
targetTitle | target-title | string | "" | Heading shown above the target pane. |
searchPlaceholder | search-placeholder | string | "" | Placeholder shown in pane search inputs. |
searchable | searchable | boolean | true | Whether each pane renders a search filter input. |
hint | hint | string | "" | Helper text displayed below the control. |
error | error | string | "" | Explicit error message displayed below the control. |
disabled | disabled | boolean | false | Disables all pane checkboxes, search fields, and transfer buttons. |
required | required | boolean | false | Requires at least one target item for form validity. |
Events
| Event | Detail Type | Description |
|---|---|---|
mth-change | { value: string; targetKeys: ReadonlyArray<string>; movedKeys: ReadonlyArray<string>; direction: 'left' | 'right' } | Fired when items are shuttled between the source and target panes. |
APG Keyboard Matrix
| Key | Direction | When | Expected Behavior |
|---|---|---|---|
| Tab | both | navigating component | moves focus between search inputs, checkboxes, and transfer buttons |
| Space | both | checkbox focused | toggles item or pane select-all selection |
| Enter / Space | both | transfer button focused | moves checked or all eligible items between panes |
Accessibility Checklist
| Category | Requirement | Verified By |
|---|---|---|
| aria | All aria-* IDREFs resolve within the same DOM root (ADR-003). | scanSameRootAria |
| focus | delegatesFocus: true with zero host internals.role (ADR-014). | lint-plugin & spec-compiler |
| contrast | Renders legible borders, focus outlines, and selection indicators under forced-colors: active. | Playwright forced-colors matrix |
| keyboard | Implements all 3 APG keyboard transitions across LTR/RTL. | mth-transfer-list.spec.test.ts |
| states | Exposes ElementInternals CustomStateSet flags: :state(dirty), :state(touched), :state(user-invalid), :state(disabled), :state(required). | Conformance suite |
| i18n | Routes 10 UI/ARIA strings through @methane-ui/core i18n catalog. | Locale context test |