Skip to main content

Interface: QueryBuilderDndContextProps

@react-querybuilder/dnd.QueryBuilderDndContextProps

Properties

baseControls

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

Defined in

packages/dnd/src/types.ts:87


canDrop

Optional canDrop: (params: CustomCanDropParams) => boolean

Type declaration

(params): boolean

Parameters
NameType
paramsCustomCanDropParams
Returns

boolean

Defined in

packages/dnd/src/types.ts:88


useDrag

Optional useDrag: <DragObject, DropResult, CollectedProps>(specArg: FactoryOrInstance<DragSourceHookSpec<DragObject, DropResult, CollectedProps>>, deps?: unknown[]) => [CollectedProps, ConnectDragSource, ConnectDragPreview]

Type declaration

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

useDragSource hook

Type parameters
NameType
DragObjectunknown
DropResultunknown
CollectedPropsunknown
Parameters
NameTypeDescription
specArgFactoryOrInstance<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:84


useDrop

Optional useDrop: <DragObject, DropResult, CollectedProps>(specArg: FactoryOrInstance<DropTargetHookSpec<DragObject, DropResult, CollectedProps>>, deps?: unknown[]) => [CollectedProps, ConnectDropTarget]

Type declaration

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

useDropTarget Hook

Type parameters
NameType
DragObjectunknown
DropResultunknown
CollectedPropsunknown
Parameters
NameTypeDescription
specArgFactoryOrInstance<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:86