Documentation

@kanunilabs/pivotgrid-react


@kanunilabs/pivotgrid-react / usePivotDnD

Function: usePivotDnD()

usePivotDnD<TRow>(__namedParameters): object

Defined in: packages/react/src/hooks/usePivotDnD.ts:12

Type Parameters

TRow

TRow

Parameters

__namedParameters

UsePivotDnDProps<TRow>

Returns

object

activeDragId

activeDragId: string | null

handleDragEnd

handleDragEnd: (event) => Promise<void>

Parameters

event

DragEndEvent

Returns

Promise<void>

handleDragMove

handleDragMove: (event) => void

Parameters

event

DragMoveEvent

Returns

void

handleDragStart

handleDragStart: (event) => void

Parameters

event

any

Returns

void

handleMoveField

handleMoveField: (fieldId, direction) => void

Parameters

fieldId

string

direction

"start" | "end" | "left" | "right"

Returns

void

handleRemoveField

handleRemoveField: (id) => void

Parameters

id

string

Returns

void

sensors

sensors: SensorDescriptor<SensorOptions>[]