Skip to main content

DragPreviewState

Defined in: dnd/src/types.ts:118

State provided during an active drag with updateWhileDragging enabled.

Properties​

draggedPath​

draggedPath: Path

Defined in: dnd/src/types.ts:124

Path of the dragged item in the original query.

dropEffect​

dropEffect: DropEffect

Defined in: dnd/src/types.ts:128

Current drop effect based on modifier keys.

groupItems​

groupItems: boolean

Defined in: dnd/src/types.ts:130

Whether group mode is active.

originalQuery​

originalQuery: RuleGroupTypeAny

Defined in: dnd/src/types.ts:122

The original query before the drag started (for cancel/revert).

previewPath​

previewPath: Path

Defined in: dnd/src/types.ts:126

Path of the dragged item in the shadow query (its preview position).

qbId​

qbId: string

Defined in: dnd/src/types.ts:132

The qbId of the query builder being dragged within.

shadowQuery​

shadowQuery: RuleGroupTypeAny

Defined in: dnd/src/types.ts:120

The shadow/preview query showing the dragged item at its prospective position.

caution

API documentation is generated from the latest commit on the main branch. It may be somewhat inconsistent with official releases of React Query Builder.