RuleDndProps

RuleDnD props.

Properties

children

children: ReactElement<RuleProps<string, string>, string | JSXElementConstructor<any>>

Source

packages/dnd/src/types.ts:42

---

disabled

disabled: boolean

Source

packages/dnd/src/types.ts:34

---

independentCombinators

independentCombinators: boolean

Source

packages/dnd/src/types.ts:37

---

moveRule()

moveRule: (oldPath, newPath, clone?) => void

Parameters

Parameter	Type
oldPath	Path
newPath	Path | "up" | "down"
clone?	boolean

Returns

void

Source

packages/dnd/src/types.ts:33

---

parentDisabled

parentDisabled: boolean

Source

packages/dnd/src/types.ts:35

---

path

path: Path

Source

packages/dnd/src/types.ts:36

---

useDrag()

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:39

---

useDrop()

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: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.