Skip to main content

RuleProps<F, O>

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:735

Rule props.

Extends

Extended by

Type Parameters

Type ParameterDefault type
F extends stringstring
O extends stringstring

Properties

actions

actions: QueryActions

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:666

Inherited from

CommonRuleAndGroupProps.actions


context?

optional context: any

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:671

Inherited from

CommonRuleAndGroupProps.context


disabled?

optional disabled: boolean

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:667

Inherited from

CommonRuleAndGroupProps.disabled


dndRef?

optional dndRef: Ref<HTMLDivElement>

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:723

Inherited from

UseRuleDnD.dndRef


dragMonitorId?

optional dragMonitorId: string | symbol

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:719

Inherited from

UseRuleDnD.dragMonitorId


dragRef?

optional dragRef: Ref<HTMLSpanElement>

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:722

Inherited from

UseRuleDnD.dragRef


dropEffect?

optional dropEffect: DropEffect

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

"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/propsUsingReact.ts:721

Inherited from

UseRuleDnD.dropMonitorId


field?

optional field: string

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:742

Deprecated

Use the field property of the rule prop instead


groupItems?

optional groupItems: boolean

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:727

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/propsUsingReact.ts:661

Inherited from

CommonRuleAndGroupProps.id


isDragging?

optional isDragging: boolean

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:718

Inherited from

UseRuleDnD.isDragging


isOver?

optional isOver: boolean

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

Inherited from

UseRuleDnD.isOver


operator?

optional operator: string

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:746

Deprecated

Use the operator property of the rule prop instead


parentDisabled?

optional parentDisabled: boolean

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:663

Inherited from

CommonRuleAndGroupProps.parentDisabled


path

path: Path

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:662

Inherited from

CommonRuleAndGroupProps.path


rule

rule: RuleType<F, O>

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:738


schema

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

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:665

Inherited from

CommonRuleAndGroupProps.schema


shiftDownDisabled?

optional shiftDownDisabled: boolean

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:669

Inherited from

CommonRuleAndGroupProps.shiftDownDisabled


shiftUpDisabled?

optional shiftUpDisabled: boolean

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:668

Inherited from

CommonRuleAndGroupProps.shiftUpDisabled


translations

translations: Translations

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:664

Inherited from

CommonRuleAndGroupProps.translations


value?

optional value: any

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:751

Deprecated

Use the value property of the rule prop instead


valueSource?

optional valueSource: ValueSource

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:755

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.