RuleProps<F, O>

Rule props.

Extends

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

Type Parameters

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

Properties

actions

actions: QueryActions

Inherited from

CommonRuleAndGroupProps.actions

Defined in

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

---

context?

optional context: any

Inherited from

CommonRuleAndGroupProps.context

Defined in

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

---

disabled?

optional disabled: boolean

Inherited from

CommonRuleAndGroupProps.disabled

Defined in

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

---

dndRef?

optional dndRef: Ref<HTMLDivElement>

Inherited from

Partial.dndRef

Defined in

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

---

dragMonitorId?

optional dragMonitorId: string | symbol

Inherited from

Partial.dragMonitorId

Defined in

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

---

dragRef?

optional dragRef: Ref<HTMLSpanElement>

Inherited from

Partial.dragRef

Defined in

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

---

dropEffect?

optional dropEffect: DropEffect

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

Inherited from

Partial.dropEffect

Defined in

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

---

dropMonitorId?

optional dropMonitorId: string | symbol

Inherited from

Partial.dropMonitorId

Defined in

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

---

field?

optional field: string

Deprecated

Use the field property of the rule prop instead

Defined in

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

---

id?

optional id: string

Inherited from

CommonRuleAndGroupProps.id

Defined in

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

---

isDragging?

optional isDragging: boolean

Inherited from

Partial.isDragging

Defined in

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

---

isOver?

optional isOver: boolean

Inherited from

Partial.isOver

Defined in

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

---

operator?

optional operator: string

Deprecated

Use the operator property of the rule prop instead

Defined in

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

---

parentDisabled?

optional parentDisabled: boolean

Inherited from

CommonRuleAndGroupProps.parentDisabled

Defined in

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

---

path

path: Path

Inherited from

CommonRuleAndGroupProps.path

Defined in

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

---

rule

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

Defined in

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

---

schema

schema: Schema<FullOption<F>, O>

Inherited from

CommonRuleAndGroupProps.schema

Defined in

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

---

shiftDownDisabled?

optional shiftDownDisabled: boolean

Inherited from

CommonRuleAndGroupProps.shiftDownDisabled

Defined in

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

---

shiftUpDisabled?

optional shiftUpDisabled: boolean

Inherited from

CommonRuleAndGroupProps.shiftUpDisabled

Defined in

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

---

translations

translations: Translations

Inherited from

CommonRuleAndGroupProps.translations

Defined in

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

---

value?

optional value: any

Deprecated

Use the value property of the rule prop instead

Defined in

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

---

valueSource?

optional valueSource: ValueSource

Deprecated

Use the valueSource property of the rule prop instead

Defined in

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

---

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.