QueryBuilderDndContextProps

Properties

baseControls

baseControls: Pick<Required<SetNonNullable<Partial<object>, "notToggle" | "dragHandle" | "valueSourceSelector" | "ruleGroup" | "rule" | "shiftActions" | "actionElement" | "addGroupAction" | "addRuleAction" | "cloneGroupAction" | "cloneRuleAction" | "combinatorSelector" | "fieldSelector" | "inlineCombinator" | "lockGroupAction" | "lockRuleAction" | "operatorSelector" | "removeGroupAction" | "removeRuleAction" | "ruleGroupBodyElements" | "ruleGroupHeaderElements" | "valueEditor" | "valueSelector">>, "ruleGroup" | "rule" | "combinatorSelector">

Defined in

packages/dnd/src/types.ts:42

---

canDrop()?

optional canDrop: (params) => boolean

Parameters

Parameter	Type
params	CustomCanDropParams

Returns

boolean

Defined in

packages/dnd/src/types.ts:43

---

useDrag()?

optional useDrag: <DragObject, DropResult, CollectedProps>(specArg, deps?) => [CollectedProps, ConnectDragSource, ConnectDragPreview]

useDragSource hook

Type Parameters

Type Parameter	Default type
DragObject	unknown
DropResult	unknown
CollectedProps	unknown

Parameters

Parameter	Type	Description
specArg	FactoryOrInstance<DragSourceHookSpec<DragObject, DropResult, CollectedProps>>	-
deps?	unknown[]	The memoization deps array to use when evaluating spec changes

Returns

[CollectedProps, ConnectDragSource, ConnectDragPreview]

Defined in

packages/dnd/src/types.ts:39

---

useDrop()?

optional useDrop: <DragObject, DropResult, CollectedProps>(specArg, deps?) => [CollectedProps, ConnectDropTarget]

useDropTarget Hook

Type Parameters

Type Parameter	Default type
DragObject	unknown
DropResult	unknown
CollectedProps	unknown

Parameters

Parameter	Type	Description
specArg	FactoryOrInstance<DropTargetHookSpec<DragObject, DropResult, CollectedProps>>	-
deps?	unknown[]	The memoization deps array to use when evaluating spec changes

Returns

[CollectedProps, ConnectDropTarget]

Defined in

packages/dnd/src/types.ts:41

---

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.