Skip to main content

QueryActions

Functions included in the actions prop passed to every subcomponent.

Methods

moveRule()

moveRule(oldPath: Path, newPath: Path | "up" | "down", clone?: boolean, context?: any): void

Parameters

ParameterType
oldPathPath
newPathPath | "up" | "down"
clone?boolean
context?any

Returns

void

Defined in

packages/react-querybuilder/src/types/props.ts:297


onGroupAdd()

onGroupAdd(group: RuleGroupTypeAny, parentPath: Path, context?: any): void

Parameters

ParameterType
groupRuleGroupTypeAny
parentPathPath
context?any

Returns

void

Defined in

packages/react-querybuilder/src/types/props.ts:287


onGroupRemove()

onGroupRemove(path: Path): void

Parameters

ParameterType
pathPath

Returns

void

Defined in

packages/react-querybuilder/src/types/props.ts:288


onPropChange()

onPropChange(prop: "value" | "disabled" | "field" | "operator" | "valueSource" | "combinatorPreceding" | "combinator" | "rules" | "not", value: any, path: Path, context?: any): void

Parameters

ParameterType
prop"value" | "disabled" | "field" | "operator" | "valueSource" | "combinatorPreceding" | "combinator" | "rules" | "not"
valueany
pathPath
context?any

Returns

void

Defined in

packages/react-querybuilder/src/types/props.ts:289


onRuleAdd()

onRuleAdd(rule: RuleType<string, string, any, string>, parentPath: Path, context?: any): void

Parameters

ParameterType
ruleRuleType<string, string, any, string>
parentPathPath
context?any

Returns

void

Defined in

packages/react-querybuilder/src/types/props.ts:295


onRuleRemove()

onRuleRemove(path: Path): void

Parameters

ParameterType
pathPath

Returns

void

Defined in

packages/react-querybuilder/src/types/props.ts:296


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.