QueryBuilderDndContextProps

Properties

baseControls

baseControls: Pick<Controls<FullField<string, string, string, Option<string>, Option<string>>, string>, "rule" | "ruleGroup" | "combinatorSelector">

Source

packages/dnd/src/types.ts:87

---

canDrop()?

optional canDrop: (params) => boolean

Parameters

Parameter	Type
params	CustomCanDropParams

Returns

boolean

Source

packages/dnd/src/types.ts:88

---

useDrag()?

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

useDragSource hook

Type parameters

Type parameter	Value
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]

Source

packages/dnd/src/types.ts:84

---

useDrop()?

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

useDropTarget Hook

Type parameters

Type parameter	Value
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]

Source

packages/dnd/src/types.ts:86

---

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.