Skip to main content

computeShadowQuery()

computeShadowQuery(__namedParameters: { draggedItem: DraggedItem; draggedPath: Path; dropEffect: DropEffect; groupItems: boolean; originalQuery: RuleGroupTypeAny; quadrant: "upper" | "lower"; targetPath: Path; targetType: DndDropTargetType; }): { previewPath: Path; shadowQuery: RuleGroupTypeAny; } | null

Defined in: dnd/src/shadowQuery.ts:73

Computes a shadow query given the current drag state and target position.

Uses the existing move() and group() utilities from @react-querybuilder/core to produce an immutable preview of the query with the dragged item at its prospective position.

Parameters

ParameterType
__namedParameters{ draggedItem: DraggedItem; draggedPath: Path; dropEffect: DropEffect; groupItems: boolean; originalQuery: RuleGroupTypeAny; quadrant: "upper" | "lower"; targetPath: Path; targetType: DndDropTargetType; }
__namedParameters.draggedItemDraggedItem
__namedParameters.draggedPathPath
__namedParameters.dropEffectDropEffect
__namedParameters.groupItemsboolean
__namedParameters.originalQueryRuleGroupTypeAny
__namedParameters.quadrant"upper" | "lower"
__namedParameters.targetPathPath
__namedParameters.targetTypeDndDropTargetType

Returns

{ previewPath: Path; shadowQuery: RuleGroupTypeAny; } | null

The shadow query and the path where the dragged item now lives, or null if the move would be a no-op.


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.