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
Parameter | Type |
---|---|
sourcePath | Path |
targetPath | Path |
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
Parameter | Type |
---|---|
oldPath | Path |
newPath | Path | "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
Parameter | Type |
---|---|
group | RuleGroupTypeAny |
parentPath | Path |
context ? | any |
Returns
void
onGroupRemove()
onGroupRemove(
path
:Path
):void
Defined in: packages/react-querybuilder/src/types/props.ts:315
Parameters
Parameter | Type |
---|---|
path | Path |
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
Parameter | Type |
---|---|
prop | "value" | "disabled" | "field" | "operator" | "valueSource" | "combinatorPreceding" | "combinator" | "rules" | "not" |
value | any |
path | Path |
context ? | any |
Returns
void
onRuleAdd()
onRuleAdd(
rule
:RuleType
,parentPath
:Path
,context
?:any
):void
Defined in: packages/react-querybuilder/src/types/props.ts:322
Parameters
Parameter | Type |
---|---|
rule | RuleType |
parentPath | Path |
context ? | any |
Returns
void
onRuleRemove()
onRuleRemove(
path
:Path
):void
Defined in: packages/react-querybuilder/src/types/props.ts:323
Parameters
Parameter | Type |
---|---|
path | Path |
Returns
void
API documentation is generated from the latest commit on the main
branch. It may be somewhat inconsistent with official releases of React Query Builder.