Skip to main content

RuleGroupProps<F, O>

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

RuleGroup props.

Extends

Type Parameters

Type ParameterDefault type
F extends FullOptionFullOption
O extends stringstring

Properties

actions

actions: QueryActions

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

Inherited from

CommonRuleAndGroupProps.actions


combinator?

optional combinator: string

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

Deprecated

Use the combinator property of the ruleGroup prop instead


context?

optional context: any

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

Inherited from

CommonRuleAndGroupProps.context


disabled?

optional disabled: boolean

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

Inherited from

CommonRuleAndGroupProps.disabled


dragMonitorId?

optional dragMonitorId: string | symbol

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

Inherited from

Partial.dragMonitorId


dragRef?

optional dragRef: Ref<HTMLSpanElement>

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

Inherited from

Partial.dragRef


dropEffect?

optional dropEffect: DropEffect

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

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

Inherited from

Partial.dropEffect


dropMonitorId?

optional dropMonitorId: string | symbol

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

Inherited from

Partial.dropMonitorId


dropRef?

optional dropRef: Ref<HTMLDivElement>

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

Inherited from

Partial.dropRef


groupItems?

optional groupItems: boolean

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

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

Inherited from

Partial.groupItems


id?

optional id: string

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

Inherited from

CommonRuleAndGroupProps.id


isDragging?

optional isDragging: boolean

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

Inherited from

Partial.isDragging


isOver?

optional isOver: boolean

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

Inherited from

Partial.isOver


not?

optional not: boolean

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

Deprecated

Use the not property of the ruleGroup prop instead


parentDisabled?

optional parentDisabled: boolean

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

Inherited from

CommonRuleAndGroupProps.parentDisabled


path

path: Path

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

Inherited from

CommonRuleAndGroupProps.path


previewRef?

optional previewRef: Ref<HTMLDivElement>

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

Inherited from

Partial.previewRef


ruleGroup

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

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


rules?

optional rules: RuleOrGroupArray

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

Deprecated

Use the rules property of the ruleGroup prop instead


schema

schema: Schema<F, O>

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

Inherited from

CommonRuleAndGroupProps.schema


shiftDownDisabled?

optional shiftDownDisabled: boolean

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

Inherited from

CommonRuleAndGroupProps.shiftDownDisabled


shiftUpDisabled?

optional shiftUpDisabled: boolean

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

Inherited from

CommonRuleAndGroupProps.shiftUpDisabled


translations

translations: Translations

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

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.