Methane@methane-ui/*
CSS LayoutsComponentsSkillsTheme BuilderGitHub
← All Components

<mth-transfer-list>

@methane-ui/ui~10.1 KB brotli (cold + Lit)~3.2 KB marginal

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

Interactive StageLive Custom Element · <mth-transfer-list> (@methane-ui/ui)
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>

Properties & Attributes

PropertyAttributeTypeDefaultDescription
namenamestring""Form field name submitted with FormData.
valuevaluestring""Comma-separated list of target item keys.
defaultValuedefault-valuestring""Initial target keys used when resetting the form.
options—ReadonlyArray<unknown> | nullnullFull list of TransferListItem options distributed across source and target panes.
labellabelstring""Accessible group label.
sourceTitlesource-titlestring""Heading shown above the source pane.
targetTitletarget-titlestring""Heading shown above the target pane.
searchPlaceholdersearch-placeholderstring""Placeholder shown in pane search inputs.
searchablesearchablebooleantrueWhether each pane renders a search filter input.
hinthintstring""Helper text displayed below the control.
errorerrorstring""Explicit error message displayed below the control.
disableddisabledbooleanfalseDisables all pane checkboxes, search fields, and transfer buttons.
requiredrequiredbooleanfalseRequires at least one target item for form validity.

Events

EventDetail TypeDescription
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

KeyDirectionWhenExpected Behavior
Tabbothnavigating componentmoves focus between search inputs, checkboxes, and transfer buttons
Spacebothcheckbox focusedtoggles item or pane select-all selection
Enter / Spacebothtransfer button focusedmoves checked or all eligible items between panes

Accessibility Checklist

CategoryRequirementVerified By
ariaAll aria-* IDREFs resolve within the same DOM root (ADR-003).scanSameRootAria
focusdelegatesFocus: true with zero host internals.role (ADR-014).lint-plugin & spec-compiler
contrastRenders legible borders, focus outlines, and selection indicators under forced-colors: active.Playwright forced-colors matrix
keyboardImplements all 3 APG keyboard transitions across LTR/RTL.mth-transfer-list.spec.test.ts
statesExposes ElementInternals CustomStateSet flags: :state(dirty), :state(touched), :state(user-invalid), :state(disabled), :state(required).Conformance suite
i18nRoutes 10 UI/ARIA strings through @methane-ui/core i18n catalog.Locale context test