ReferenceComponentsTransfer list
TransferListProps
TransferListProps component contract.
Type
export interface TransferListProps<TData = unknown>
extends CommonComponentProps,
SlottedComponentProps<
TransferListSlots,
{
readonly focused: boolean;
readonly side: TransferSide;
readonly activeIndex: number;
}
> {
readonly items: readonly TransferListItem<TData>[];
readonly value?: readonly string[];
readonly defaultValue?: readonly string[];
readonly onValueChange?: (
selectedIds: readonly string[],
) => void | Promise<void>;
readonly onTransfer?: (
item: TransferListItem<TData>,
direction: "select" | "remove",
) => void | Promise<void>;
readonly availableTitle?: string;
readonly selectedTitle?: string;
readonly height?: number;
readonly autoFocus?: boolean;
}Members
| Member | Type | Required | Description | Related types |
|---|---|---|---|---|
items | readonly TransferListItem<TData>[] | Yes | The items member uses the readonly TransferListItem<TData>[] contract. | — |
value | readonly string[] | undefined | No | The value member uses the readonly string[] | undefined contract. | — |
defaultValue | readonly string[] | undefined | No | The defaultValue member uses the readonly string[] | undefined contract. | — |
onValueChange | ((selectedIds: readonly string[]) => void | Promise<void>) | undefined | No | The onValueChange member uses the ((selectedIds: readonly string[]) => void | Promise<void>) | undefined contract. | — |
onTransfer | ((item: TransferListItem<TData>, direction: "select" | "remove") => void | Promise<void>) | undefined | No | The onTransfer member uses the ((item: TransferListItem<TData>, direction: "select" | "remove") => void | Promise<void>) | undefined contract. | — |
availableTitle | string | undefined | No | The availableTitle member uses the string | undefined contract. | — |
selectedTitle | string | undefined | No | The selectedTitle member uses the string | undefined contract. | — |
height | number | undefined | No | The height member uses the number | undefined contract. | — |
autoFocus | boolean | undefined | No | The autoFocus member uses the boolean | undefined contract. | — |
variant | string | undefined | No | The variant member uses the string | undefined contract. | — |
size | "sm" | "md" | "lg" | undefined | No | The size member uses the "sm" | "md" | "lg" | undefined contract. | — |
unstyled | boolean | undefined | No | The unstyled member uses the boolean | undefined contract. | — |
className | string | undefined | No | The className member uses the string | undefined contract. | — |
layout | Partial<Omit<LayoutNodeInput, "children" | "id" | "semantics">> | undefined | No | The layout member uses the Partial<Omit<LayoutNodeInput, "children" | "id" | "semantics">> | undefined contract. | — |
id | string | undefined | No | The id member uses the string | undefined contract. | — |
testId | string | undefined | No | The testId member uses the string | undefined contract. | — |
role | SemanticRole | undefined | No | The role member uses the SemanticRole | undefined contract. | SemanticRole |
label | string | undefined | No | The label member uses the string | undefined contract. | — |
description | string | undefined | No | The description member uses the string | undefined contract. | — |
disabled | boolean | undefined | No | The disabled member uses the boolean | undefined contract. | — |
readOnly | boolean | undefined | No | The readOnly member uses the boolean | undefined contract. | — |
selected | boolean | undefined | No | The selected member uses the boolean | undefined contract. | — |
checked | boolean | undefined | No | The checked member uses the boolean | undefined contract. | — |
expanded | boolean | undefined | No | The expanded member uses the boolean | undefined contract. | — |
valueText | string | undefined | No | The valueText member uses the string | undefined contract. | — |
slots | Partial<SlotComponents<{ root: import("ink").BoxProps; panel: import("ink").BoxProps; title: import("ink").TextProps; item: import("ink").TextProps; controls: import("ink").TextProps; empty: import("ink").TextProps; overflow: import("ink").TextProps; }>> | undefined | No | The slots member uses the Partial<SlotComponents<{ root: import("ink").BoxProps; panel: import("ink").BoxProps; title: import("ink").TextProps; item: import("ink").TextProps; controls: import("ink").TextProps; empty: import("ink").TextProps; overflow: import("ink").TextProps; }>> | undefined contract. | BoxProps, SlotComponents, TextProps |
slotProps | Partial<SlotProps<{ root: import("ink").BoxProps; panel: import("ink").BoxProps; title: import("ink").TextProps; item: import("ink").TextProps; controls: import("ink").TextProps; empty: import("ink").TextProps; overflow: import("ink").TextProps; }, { readonly focused: boolean; readonly side: "available" | "selected"; readonly activeIndex: number; }>> | undefined | No | The slotProps member uses the Partial<SlotProps<{ root: import("ink").BoxProps; panel: import("ink").BoxProps; title: import("ink").TextProps; item: import("ink").TextProps; controls: import("ink").TextProps; empty: import("ink").TextProps; overflow: import("ink").TextProps; }, { readonly focused: boolean; readonly side: "available" | "selected"; readonly activeIndex: number; }>> | undefined contract. | BoxProps, SlotProps, TextProps |