Skip to main content

RuleGroupProps<F, O>

RuleGroup props.

Extends​

Type Parameters​

Type ParameterDefault type
F extends FullOptionFullOption
O extends stringstring

Properties​

actions​

actions: QueryActions

Inherited from​

CommonRuleAndGroupProps.actions

Defined in​

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

combinator?​

optional combinator: string

Deprecated​

Use the combinator property of the ruleGroup prop instead

Defined in​

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

context?​

optional context: any

Inherited from​

CommonRuleAndGroupProps.context

Defined in​

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

disabled?​

optional disabled: boolean

Inherited from​

CommonRuleAndGroupProps.disabled

Defined in​

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

dragMonitorId?​

optional dragMonitorId: string | symbol

Inherited from​

Partial.dragMonitorId

Defined in​

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

dragRef?​

optional dragRef: Ref<HTMLSpanElement>

Inherited from​

Partial.dragRef

Defined in​

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

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:410

dropMonitorId?​

optional dropMonitorId: string | symbol

Inherited from​

Partial.dropMonitorId

Defined in​

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

dropRef?​

optional dropRef: Ref<HTMLDivElement>

Inherited from​

Partial.dropRef

Defined in​

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

id?​

optional id: string

Inherited from​

CommonRuleAndGroupProps.id

Defined in​

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

isDragging?​

optional isDragging: boolean

Inherited from​

Partial.isDragging

Defined in​

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

isOver?​

optional isOver: boolean

Inherited from​

Partial.isOver

Defined in​

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

not?​

optional not: boolean

Deprecated​

Use the not property of the ruleGroup prop instead

Defined in​

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

parentDisabled?​

optional parentDisabled: boolean

Inherited from​

CommonRuleAndGroupProps.parentDisabled

Defined in​

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

path​

path: Path

Inherited from​

CommonRuleAndGroupProps.path

Defined in​

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

previewRef?​

optional previewRef: Ref<HTMLDivElement>

Inherited from​

Partial.previewRef

Defined in​

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

ruleGroup​

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

Defined in​

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

rules?​

optional rules: RuleOrGroupArray

Deprecated​

Use the rules property of the ruleGroup prop instead

Defined in​

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

schema​

schema: Schema<F, O>

Inherited from​

CommonRuleAndGroupProps.schema

Defined in​

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

shiftDownDisabled?​

optional shiftDownDisabled: boolean

Inherited from​

CommonRuleAndGroupProps.shiftDownDisabled

Defined in​

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

shiftUpDisabled?​

optional shiftUpDisabled: boolean

Inherited from​

CommonRuleAndGroupProps.shiftUpDisabled

Defined in​

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

translations​

translations: Translations

Inherited from​

CommonRuleAndGroupProps.translations

Defined in​

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

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.