Skip to main content

QueryActions

Defined in: packages/react-querybuilder/src/types/props.ts:313

Functions included in the actions prop passed to every subcomponent.

Methods

groupRule()

groupRule(sourcePath: Path, targetPath: Path, clone?: boolean, context?: any): void

Defined in: packages/react-querybuilder/src/types/props.ts:325

Parameters

ParameterType
sourcePathPath
targetPathPath
clone?boolean
context?any

Returns

void


moveRule()

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

Defined in: packages/react-querybuilder/src/types/props.ts:324

Parameters

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

Returns

void


onGroupAdd()

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

Defined in: packages/react-querybuilder/src/types/props.ts:314

Parameters

ParameterType
groupRuleGroupTypeAny
parentPathPath
context?any

Returns

void


onGroupRemove()

onGroupRemove(path: Path): void

Defined in: packages/react-querybuilder/src/types/props.ts:315

Parameters

ParameterType
pathPath

Returns

void


onPropChange()

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

Defined in: packages/react-querybuilder/src/types/props.ts:316

Parameters

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

Returns

void


onRuleAdd()

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

Defined in: packages/react-querybuilder/src/types/props.ts:322

Parameters

ParameterType
ruleRuleType
parentPathPath
context?any

Returns

void


onRuleRemove()

onRuleRemove(path: Path): void

Defined in: packages/react-querybuilder/src/types/props.ts:323

Parameters

ParameterType
pathPath

Returns

void


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.