Transfer list

Transfer list is used to organize and select items

JavaScript

Props

Property
Description
Interface
Default
config
To customize Transfer list details
{
  checkbox?: boolean;
  columns: {
    from: {
      title: string;
      description?: string;
    };
    to: {
      title: string;
      description?: string;
    };
  };
  searchInput?: boolean;
}
undefined
transferListData
To provide Transfer list with data
TransferListItem[]
undefined
modal
To define transfer list as modal or add modal configuration
TransferListModalConfig | boolean
undefined

Interfaces and types

Name
Interface
TransferListItem
interface TransferListItem {
  label: string;
  locked?: boolean;
  selected: boolean;
  value: string;
  wildcard?: boolean;
}
TransferListModalConfig
interface TransferListModalConfig {
  ariaLabel?: boolean;
  icon?: string;
  title?: boolean;
  tooltipMsg?: string;
}

Accessibility

Accessibility guidelines coming soon