Header Drag
- Configure the
headerDragproperty to enable column dragging for reordering. columnsneeds to be updated via theonUpdateColumnscallback.
js
<StkTable
headerDrag
columns={columns}
onUpdateColumns={newCols => setColumns(newCols)}
/>Try dragging the headers
loading
Change Order via Event
ts
/**
* Header column drag event
* ```(dragStartKey: string, targetColKey: string)```
*/
onColOrderChange?: (dragStartKey: string, targetColKey: string) => void;This way, you don't need to update via the onUpdateColumns callback; you can manually update the order of the columns array.
API
props.headerDrag
ts
/** header drag config */
export type HeaderDragConfig<DT extends Record<string, any> = any> =
| boolean
| {
/**
* Column exchange mode
* - none - Do nothing
* - insert - Insert (default)
* - swap - Swap
*/
mode?: 'none' | 'insert' | 'swap';
/** Columns to disable dragging */
disabled?: (col: StkTableColumn<DT>) => boolean;
};props
ts
/**
* Header column drag event
* ```(dragStartKey: string, targetColKey: string)```
*/
onColOrderChange?: (dragStartKey: string, targetColKey: string) => void;
/**
* Header column drag start
* ```(dragStartKey: string)```
*/
onThDragStart?: (dragStartKey: string) => void;
/**
* Header column drag drop
* ```(targetColKey: string)```
*/
onThDrop?: (targetColKey: string) => void;