Skip to main content

RuleGroupProps<F, O>

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

RuleGroup props.

Extends

Extended by

Type Parameters

Type ParameterDefault type
F extends FullOptionFullOption
O extends stringstring

Properties

actions

actions: QueryActions

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

Inherited from

CommonRuleAndGroupProps.actions


combinator?

optional combinator: string

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

Deprecated

Use the combinator property of the ruleGroup prop instead


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


dragMonitorId?

optional dragMonitorId: string | symbol

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

Inherited from

UseRuleGroupDnD.dragMonitorId


dragRef?

optional dragRef: Ref<HTMLSpanElement>

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

Inherited from

UseRuleGroupDnD.dragRef


dropEffect?

optional dropEffect: DropEffect

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

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

Inherited from

UseRuleGroupDnD.dropEffect


dropMonitorId?

optional dropMonitorId: string | symbol

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

Inherited from

UseRuleGroupDnD.dropMonitorId


dropRef?

optional dropRef: Ref<HTMLDivElement>

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

Inherited from

UseRuleGroupDnD.dropRef


groupItems?

optional groupItems: boolean

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

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

Inherited from

UseRuleGroupDnD.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:678

Inherited from

UseRuleGroupDnD.isDragging


isOver?

optional isOver: boolean

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

Inherited from

UseRuleGroupDnD.isOver


not?

optional not: boolean

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

Deprecated

Use the not property of the ruleGroup 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


previewRef?

optional previewRef: Ref<HTMLDivElement>

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

Inherited from

UseRuleGroupDnD.previewRef


ruleGroup

ruleGroup: RuleGroupTypeAny<RuleType<GetOptionIdentifierType<F>, O, any, string>>

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


rules?

optional rules: RuleOrGroupArray

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

Deprecated

Use the rules property of the ruleGroup prop instead


schema

schema: Schema<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


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.