RuleProps<F, O>

Rule props.

Extends

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

Type parameters

Type parameter	Value
F extends string	string
O extends string	string

Properties

actions

actions: QueryActions

Inherited from

CommonRuleAndGroupProps.actions

Source

packages/react-querybuilder/src/types/propsUsingReact.ts:368

---

context?

optional context: any

Inherited from

CommonRuleAndGroupProps.context

Source

packages/react-querybuilder/src/types/propsUsingReact.ts:373

---

disabled?

optional disabled: boolean

Inherited from

CommonRuleAndGroupProps.disabled

Source

packages/react-querybuilder/src/types/propsUsingReact.ts:369

---

dndRef?

optional dndRef: Ref<HTMLDivElement>

Inherited from

Partial.dndRef

Source

packages/react-querybuilder/src/types/propsUsingReact.ts:421

---

dragMonitorId?

optional dragMonitorId: string | symbol

Inherited from

Partial.dragMonitorId

Source

packages/react-querybuilder/src/types/propsUsingReact.ts:417

---

dragRef?

optional dragRef: Ref<HTMLSpanElement>

Inherited from

Partial.dragRef

Source

packages/react-querybuilder/src/types/propsUsingReact.ts:420

---

dropEffect?

optional dropEffect: DropEffect

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

Inherited from

Partial.dropEffect

Source

packages/react-querybuilder/src/types/propsUsingReact.ts:423

---

dropMonitorId?

optional dropMonitorId: string | symbol

Inherited from

Partial.dropMonitorId

Source

packages/react-querybuilder/src/types/propsUsingReact.ts:419

---

field?

optional field: string

Deprecated

Use the field property of the rule prop instead

Source

packages/react-querybuilder/src/types/propsUsingReact.ts:436

---

id?

optional id: string

Inherited from

CommonRuleAndGroupProps.id

Source

packages/react-querybuilder/src/types/propsUsingReact.ts:363

---

isDragging?

optional isDragging: boolean

Inherited from

Partial.isDragging

Source

packages/react-querybuilder/src/types/propsUsingReact.ts:416

---

isOver?

optional isOver: boolean

Inherited from

Partial.isOver

Source

packages/react-querybuilder/src/types/propsUsingReact.ts:418

---

operator?

optional operator: string

Deprecated

Use the operator property of the rule prop instead

Source

packages/react-querybuilder/src/types/propsUsingReact.ts:440

---

parentDisabled?

optional parentDisabled: boolean

Inherited from

CommonRuleAndGroupProps.parentDisabled

Source

packages/react-querybuilder/src/types/propsUsingReact.ts:365

---

path

path: Path

Inherited from

CommonRuleAndGroupProps.path

Source

packages/react-querybuilder/src/types/propsUsingReact.ts:364

---

rule

rule: RuleType<F, O, any, string>

Source

packages/react-querybuilder/src/types/propsUsingReact.ts:432

---

schema

schema: Schema <FullOption<F>, O>

Inherited from

CommonRuleAndGroupProps.schema

Source

packages/react-querybuilder/src/types/propsUsingReact.ts:367

---

shiftDownDisabled?

optional shiftDownDisabled: boolean

Inherited from

CommonRuleAndGroupProps.shiftDownDisabled

Source

packages/react-querybuilder/src/types/propsUsingReact.ts:371

---

shiftUpDisabled?

optional shiftUpDisabled: boolean

Inherited from

CommonRuleAndGroupProps.shiftUpDisabled

Source

packages/react-querybuilder/src/types/propsUsingReact.ts:370

---

translations

translations: Translations

Inherited from

CommonRuleAndGroupProps.translations

Source

packages/react-querybuilder/src/types/propsUsingReact.ts:366

---

value?

optional value: any

Deprecated

Use the value property of the rule prop instead

Source

packages/react-querybuilder/src/types/propsUsingReact.ts:445

---

valueSource?

optional valueSource: ValueSource

Deprecated

Use the valueSource property of the rule prop instead

Source

packages/react-querybuilder/src/types/propsUsingReact.ts:449

---

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.