QueryBuilderDndProps

QueryBuilderDndProps = QueryBuilderContextProviderProps & { canDrop: (params: CustomCanDropParams) => boolean; copyModeModifierKey: string; dnd: DndProp; groupModeModifierKey: string; }

Defined in: packages/dnd/src/types.ts:50

QueryBuilderDnD props.

Type declaration

canDrop()?

optional canDrop: (params: CustomCanDropParams) => boolean

Parameters

Parameter	Type
params	CustomCanDropParams

Returns

boolean

copyModeModifierKey?

optional copyModeModifierKey: string

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"

dnd?

optional dnd: DndProp

Provide this prop if enableDragAndDrop is true for the child element and you want the component to render immediately with drag-and-drop enabled. Otherwise, the component will asynchronously load react-dnd, react-dnd-html5-backend, and react-dnd-touch-backend. Drag-and-drop features will only be enabled once those packages have loaded.

groupModeModifierKey?

optional groupModeModifierKey: string

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"

---

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.