Interface TransferProps<RecordType>

interface TransferProps<RecordType> {
    children?: ((props) => ReactNode);
    className?: string;
    dataSource?: RecordType[];
    disabled?: boolean;
    filterOption?: ((inputValue, item, direction) => boolean);
    footer?: ((props, info?) => ReactNode);
    listStyle?: CSSProperties | ((style) => CSSProperties);
    locale?: Partial<TransferLocale>;
    onChange?: ((targetKeys, direction, moveKeys) => void);
    onScroll?: ((direction, e) => void);
    onSearch?: ((direction, value) => void);
    onSelectChange?: ((sourceSelectedKeys, targetSelectedKeys) => void);
    oneWay?: boolean;
    operationStyle?: CSSProperties;
    operations?: string[];
    pagination?: PaginationType;
    prefixCls?: string;
    render?: TransferRender<RecordType>;
    rootClassName?: string;
    rowKey?: ((record) => string);
    selectAllLabels?: SelectAllLabel[];
    selectedKeys?: string[];
    selectionsIcon?: ReactNode;
    showSearch?: boolean;
    showSelectAll?: boolean;
    status?: "" | "error" | "warning";
    style?: CSSProperties;
    targetKeys?: string[];
    titles?: ReactNode[];
}

Type Parameters

  • RecordType = any

Properties

children? className? dataSource? disabled? filterOption? footer? listStyle? locale? onChange? onScroll? onSearch? onSelectChange? oneWay? operationStyle? operations? pagination? prefixCls? render? rootClassName? rowKey? selectAllLabels? selectedKeys? selectionsIcon? showSearch? showSelectAll? status? style? targetKeys? titles?

Properties

Optional children

children?: ((props) => ReactNode)

Type declaration

    • (props): ReactNode

    • Parameters

      Returns ReactNode

Optional className

className?: string

Optional dataSource

dataSource?: RecordType[]

Optional disabled

disabled?: boolean

Optional filterOption

filterOption?: ((inputValue, item, direction) => boolean)

Type declaration

    • (inputValue, item, direction): boolean

    • Parameters

      • inputValue: string
      • item: RecordType
      • direction: TransferDirection

      Returns boolean

Optional footer

footer?: ((props, info?) => ReactNode)

Type declaration

    • (props, info?): ReactNode

    • Parameters

      • props: TransferListProps<RecordType>
      • Optional info: {
            direction: TransferDirection;
        }
        • direction: TransferDirection

      Returns ReactNode

Optional listStyle

listStyle?: CSSProperties | ((style) => CSSProperties)

Type declaration

    • (style): CSSProperties

    • Parameters

      • style: ListStyle

      Returns CSSProperties

Optional locale

locale?: Partial<TransferLocale>

Optional onChange

onChange?: ((targetKeys, direction, moveKeys) => void)

Type declaration

    • (targetKeys, direction, moveKeys): void

    • Parameters

      • targetKeys: string[]
      • direction: TransferDirection
      • moveKeys: string[]

      Returns void

Optional onScroll

onScroll?: ((direction, e) => void)

Type declaration

    • (direction, e): void

    • Parameters

      Returns void

Optional onSearch

onSearch?: ((direction, value) => void)

Type declaration

    • (direction, value): void

    • Parameters

      • direction: TransferDirection
      • value: string

      Returns void

Optional onSelectChange

onSelectChange?: ((sourceSelectedKeys, targetSelectedKeys) => void)

Type declaration

    • (sourceSelectedKeys, targetSelectedKeys): void

    • Parameters

      • sourceSelectedKeys: string[]
      • targetSelectedKeys: string[]

      Returns void

Optional oneWay

oneWay?: boolean

Optional operationStyle

operationStyle?: CSSProperties

Optional operations

operations?: string[]

Optional pagination

pagination?: PaginationType

Optional prefixCls

prefixCls?: string

Optional render

render?: TransferRender<RecordType>

Optional rootClassName

rootClassName?: string

Optional rowKey

rowKey?: ((record) => string)

Type declaration

    • (record): string

    • Parameters

      Returns string

Optional selectAllLabels

selectAllLabels?: SelectAllLabel[]

Optional selectedKeys

selectedKeys?: string[]

Optional selectionsIcon

selectionsIcon?: ReactNode

Optional showSearch

showSearch?: boolean

Optional showSelectAll

showSelectAll?: boolean

Optional status

status?: "" | "error" | "warning"

Optional style

style?: CSSProperties

Optional targetKeys

targetKeys?: string[]

Optional titles

titles?: ReactNode[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc