RuleProps<F, O>

Defined in: packages/react-querybuilder/src/types/props.ts:709

Rule props.

Extends

• CommonRuleAndGroupProps<FullOption<F>, O>.Partial<UseRuleDnD>

Extended by

• UseRule

Type Parameters

Type Parameter	Default type
F extends string	string
O extends string	string

Properties

actions

actions: QueryActions

Defined in: packages/react-querybuilder/src/types/props.ts:638

Inherited from

CommonRuleAndGroupProps.actions

---

context?

optional context: any

Defined in: packages/react-querybuilder/src/types/props.ts:643

Inherited from

CommonRuleAndGroupProps.context

---

disabled?

optional disabled: boolean

Defined in: packages/react-querybuilder/src/types/props.ts:639

Inherited from

CommonRuleAndGroupProps.disabled

---

dndRef?

optional dndRef: Ref<HTMLDivElement>

Defined in: packages/react-querybuilder/src/types/props.ts:696

Inherited from

UseRuleDnD.dndRef

---

dragMonitorId?

optional dragMonitorId: string | symbol

Defined in: packages/react-querybuilder/src/types/props.ts:692

Inherited from

UseRuleDnD.dragMonitorId

---

dragRef?

optional dragRef: Ref<HTMLSpanElement>

Defined in: packages/react-querybuilder/src/types/props.ts:695

Inherited from

UseRuleDnD.dragRef

---

dropEffect?

optional dropEffect: DropEffect

Defined in: packages/react-querybuilder/src/types/props.ts:698

"move" by default; "copy" if the modifier key is pressed.

Inherited from

UseRuleDnD.dropEffect

---

dropMonitorId?

optional dropMonitorId: string | symbol

Defined in: packages/react-querybuilder/src/types/props.ts:694

Inherited from

UseRuleDnD.dropMonitorId

---

dropNotAllowed?

optional dropNotAllowed: boolean

Defined in: packages/react-querybuilder/src/types/props.ts:701

Inherited from

UseRuleDnD.dropNotAllowed

---

field?

optional field: string

Defined in: packages/react-querybuilder/src/types/props.ts:716

Deprecated

Use the field property of the rule prop instead

---

groupItems?

optional groupItems: boolean

Defined in: packages/react-querybuilder/src/types/props.ts:700

True if the dragged and hovered items should form a new group.

Inherited from

UseRuleDnD.groupItems

---

id?

optional id: string

Defined in: packages/react-querybuilder/src/types/props.ts:632

Inherited from

CommonRuleAndGroupProps.id

---

isDragging?

optional isDragging: boolean

Defined in: packages/react-querybuilder/src/types/props.ts:691

Inherited from

UseRuleDnD.isDragging

---

isOver?

optional isOver: boolean

Defined in: packages/react-querybuilder/src/types/props.ts:693

Inherited from

UseRuleDnD.isOver

---

operator?

optional operator: string

Defined in: packages/react-querybuilder/src/types/props.ts:720

Deprecated

Use the operator property of the rule prop instead

---

parentDisabled?

optional parentDisabled: boolean

Defined in: packages/react-querybuilder/src/types/props.ts:634

Inherited from

CommonRuleAndGroupProps.parentDisabled

---

parentMuted?

optional parentMuted: boolean

Defined in: packages/react-querybuilder/src/types/props.ts:635

Inherited from

CommonRuleAndGroupProps.parentMuted

---

path

path: Path

Defined in: packages/react-querybuilder/src/types/props.ts:633

Inherited from

CommonRuleAndGroupProps.path

---

rule

rule: RuleType<F, O>

Defined in: packages/react-querybuilder/src/types/props.ts:712

---

schema

schema: Schema<{[key: string]: unknown; disabled?: boolean; label: string; name: F; value: F; }, O>

Defined in: packages/react-querybuilder/src/types/props.ts:637

Inherited from

CommonRuleAndGroupProps.schema

---

shiftDownDisabled?

optional shiftDownDisabled: boolean

Defined in: packages/react-querybuilder/src/types/props.ts:641

Inherited from

CommonRuleAndGroupProps.shiftDownDisabled

---

shiftUpDisabled?

optional shiftUpDisabled: boolean

Defined in: packages/react-querybuilder/src/types/props.ts:640

Inherited from

CommonRuleAndGroupProps.shiftUpDisabled

---

translations

translations: Translations

Defined in: packages/react-querybuilder/src/types/props.ts:636

Inherited from

CommonRuleAndGroupProps.translations

---

value?

optional value: any

Defined in: packages/react-querybuilder/src/types/props.ts:725

Deprecated

Use the value property of the rule prop instead

---

valueSource?

optional valueSource: ValueSource

Defined in: packages/react-querybuilder/src/types/props.ts:729

Deprecated

Use the valueSource property of the rule prop instead

---

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.