QueryBuilderDndContextProps
Defined in: packages/dnd/src/types.ts:85
QueryBuilderDndContext props.
Extends
Pick<QueryBuilderDndProps,"canDrop"|"copyModeModifierKey"|"groupModeModifierKey"|"hideDefaultDragPreview">
Properties
baseControls
baseControls:
Pick<Controls<FullField,string>,"rule"|"ruleGroup"|"combinatorSelector">
Defined in: packages/dnd/src/types.ts:92
canDrop()?
optionalcanDrop: (params:CustomCanDropParams) =>boolean
Defined in: packages/dnd/src/types.ts:59
Parameters
| Parameter | Type |
|---|---|
params | CustomCanDropParams |
Returns
boolean
Inherited from
Pick.canDrop
copyModeModifierKey?
optionalcopyModeModifierKey:string
Defined in: packages/dnd/src/types.ts:66
Key code for the modifier key that puts a drag-and-drop action in "copy" mode. Can be combined with "group" modifier key.
Default
"alt"
Inherited from
QueryBuilderDndProps.copyModeModifierKey
groupModeModifierKey?
optionalgroupModeModifierKey:string
Defined in: packages/dnd/src/types.ts:73
Key code for the modifier key that puts a drag-and-drop action in "group" mode. Can be combined with "copy" modifier key.
Default
"ctrl"
Inherited from
QueryBuilderDndProps.groupModeModifierKey
hideDefaultDragPreview?
optionalhideDefaultDragPreview:boolean
Defined in: packages/dnd/src/types.ts:77
Do not render the "ghost" preview image when dragging.
Inherited from
QueryBuilderDndProps.hideDefaultDragPreview
useDrag()?
optionaluseDrag: <DragObject,DropResult,CollectedProps>(specArg:FactoryOrInstance<DragSourceHookSpec<DragObject,DropResult,CollectedProps>>,deps?:unknown[]) => [CollectedProps,ConnectDragSource,ConnectDragPreview]
Defined in: packages/dnd/src/types.ts:90
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]
useDrop()?
optionaluseDrop: <DragObject,DropResult,CollectedProps>(specArg:FactoryOrInstance<DropTargetHookSpec<DragObject,DropResult,CollectedProps>>,deps?:unknown[]) => [CollectedProps,ConnectDropTarget]
Defined in: packages/dnd/src/types.ts:91
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]
API documentation is generated from the latest commit on the main branch. It may be somewhat inconsistent with official releases of React Query Builder.