Skip to main content

Board Types

Types for the cross-container sortable board API.

SortableBoardTransferEvent<TItem>​

Fired when an item is transferred between containers.

interface SortableBoardTransferEvent<TItem> {
  item: TItem;              // The transferred item
  fromContainerId: string;  // Source column id
  fromIndex: number;        // Original index in source
  toContainerId: string;    // Target column id
  toIndex: number;          // Insertion index in target
}

UseSortableBoardOptions<TItem>​

Options for useSortableBoard.

interface UseSortableBoardOptions<TItem> {
  keyExtractor: (item: TItem) => string;
  onTransfer: (event: SortableBoardTransferEvent<TItem>) => void;
}

SortableBoardHandle<TItem>​

Handle returned by useSortableBoard. Pass to SortableBoardContainer.

interface SortableBoardHandle<TItem> {
  _internal: SortableBoardInternal<TItem>;
}

SortablePhantomSlot​

Virtual space reserved in a target column during cross-container drag.

interface SortablePhantomSlot {
  atDisplayIndex: number;
  width: number;
  height: number;
}