InlineCombinatorDndProps

InlineCombinatorDnD props.

Extends

• InlineCombinatorProps

Properties

className?

optional className: string

CSS classNames to be applied.

This is string and not Classname because the Rule and RuleGroup components run clsx() to produce the className that gets passed to each subcomponent.

Inherited from

InlineCombinatorProps.className

Source

packages/react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1546

---

component

component: ComponentType<CombinatorSelectorProps>

Inherited from

InlineCombinatorProps.component

Source

packages/react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:895

---

context?

optional context: any

Container for custom props that are passed to all components.

Inherited from

InlineCombinatorProps.context

Source

packages/react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1566

---

disabled?

optional disabled: boolean

Disables the control.

Inherited from

InlineCombinatorProps.disabled

Source

packages/react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1562

---

independentCombinators?

optional independentCombinators: boolean

Inherited from

InlineCombinatorProps.independentCombinators

Source

packages/react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:896

---

level

level: number

The level of the current group. Always equal to path.length.

Inherited from

InlineCombinatorProps.level

Source

packages/react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1554

---

options

options: FullCombinator<string>[] | OptionGroup<FullCombinator<string>>[]

Inherited from

InlineCombinatorProps.options

Source

packages/react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1610

---

path

path: Path

Path to this subcomponent's rule/group within the query.

Inherited from

InlineCombinatorProps.path

Source

packages/react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1550

---

rules?

optional rules: RuleOrGroupArray

Inherited from

InlineCombinatorProps.rules

Source

packages/react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1611

---

schema

schema: Schema<FullOption<string>, string>

All subcomponents receive the configuration schema as a prop.

Inherited from

InlineCombinatorProps.schema

Source

packages/react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1578

---

testID?

optional testID: string

Test ID for this component.

Inherited from

InlineCombinatorProps.testID

Source

packages/react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1574

---

title?

optional title: string

The title/tooltip for this control.

Inherited from

InlineCombinatorProps.title

Source

packages/react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1558

---

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

---

validation?

optional validation: boolean | ValidationResult

Validation result of the parent rule/group.

Inherited from

InlineCombinatorProps.validation

Source

packages/react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1570

---

value?

optional value: string

Inherited from

InlineCombinatorProps.value

Source

packages/react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1584

Methods

handleOnChange()

handleOnChange(value): void

Parameters

Parameter	Type
value	any

Returns

void

Inherited from

InlineCombinatorProps.handleOnChange

Source

packages/react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1585

---

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.