UseRuleGroup
Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:398
RuleGroup props.
Extends
Properties
accessibleDescription
accessibleDescription:
string
Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:401
actions
actions:
QueryActions
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:666
Inherited from
addGroup
addGroup:
ActionElementEventHandler
Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:399
addRule
addRule:
ActionElementEventHandler
Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:400
classNames
classNames:
Pick
<{ [k in keyof Classnames]: string }
,"header"
|"shiftActions"
|"dragHandle"
|"combinators"
|"notToggle"
|"addRule"
|"addGroup"
|"cloneGroup"
|"lockGroup"
|"removeGroup"
|"body"
>
Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:402
cloneGroup
cloneGroup:
ActionElementEventHandler
Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:416
combinator?
optional
combinator:string
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:703
Deprecated
Use the combinator
property of the ruleGroup
prop instead
Inherited from
context?
optional
context:any
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:671
Inherited from
disabled?
optional
disabled:boolean
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:667
Inherited from
dragMonitorId?
optional
dragMonitorId:string
|symbol
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:679
Inherited from
dragRef?
optional
dragRef:Ref
<HTMLSpanElement
>
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:683
Inherited from
dropEffect?
optional
dropEffect:DropEffect
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:686
"move"
by default; "copy"
if the modifier key is pressed.
Inherited from
dropMonitorId?
optional
dropMonitorId:string
|symbol
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:681
Inherited from
dropRef?
optional
dropRef:Ref
<HTMLDivElement
>
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:684
Inherited from
groupItems?
optional
groupItems:boolean
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:688
True if the dragged and hovered items should form a new group.
Inherited from
id?
optional
id:string
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:661
Inherited from
isDragging?
optional
isDragging:boolean
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:678
Inherited from
isOver?
optional
isOver:boolean
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:680
Inherited from
not?
optional
not:boolean
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:711
Deprecated
Use the not
property of the ruleGroup
prop instead
Inherited from
onCombinatorChange
onCombinatorChange:
ValueChangeEventHandler
Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:417
onGroupAdd()
onGroupAdd: (
group
:RuleGroupTypeAny
,parentPath
:Path
,context?
:any
) =>void
Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:418
Parameters
Parameter | Type |
---|---|
group | RuleGroupTypeAny |
parentPath | Path |
context? | any |
Returns
void
onIndependentCombinatorChange()
onIndependentCombinatorChange: (
value
:any
,index
:number
,context?
:any
) =>void
Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:419
Parameters
Parameter | Type |
---|---|
value | any |
index | number |
context? | any |
Returns
void
onNotToggleChange()
onNotToggleChange: (
checked
:boolean
,context?
:any
) =>void
Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:420
Parameters
Parameter | Type |
---|---|
checked | boolean |
context? | any |
Returns
void
outerClassName
outerClassName:
string
Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:421
parentDisabled?
optional
parentDisabled:boolean
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:663
Inherited from
path
path:
Path
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:662
Inherited from
pathsMemo
pathsMemo: {
disabled
:boolean
;path
:Path
; }[]
Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:422
disabled
disabled:
boolean
path
path:
Path
previewRef?
optional
previewRef:Ref
<HTMLDivElement
>
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:682
Inherited from
removeGroup
removeGroup:
ActionElementEventHandler
Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:423
ruleGroup
ruleGroup:
RuleGroupType
<RuleType
<string
,string
,any
,string
>,string
> |RuleGroupTypeIC
<RuleType
<string
,string
,any
,string
>,string
>
Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:424
Overrides
rules?
optional
rules:RuleOrGroupArray
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:707
Deprecated
Use the rules
property of the ruleGroup
prop instead
Inherited from
schema
schema:
Schema
<{[key
:string
]:unknown
;disabled?
:boolean
;label
:string
;name
:string
;value
:string
; },string
>
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:665
Inherited from
shiftDownDisabled?
optional
shiftDownDisabled:boolean
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:669
Inherited from
RuleGroupProps
.shiftDownDisabled
shiftGroupDown()
shiftGroupDown: (
event?
:MouseEvent
<Element
,MouseEvent
>,context?
:any
) =>void
Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:425
Parameters
Parameter | Type |
---|---|
event? | MouseEvent <Element , MouseEvent > |
context? | any |
Returns
void
shiftGroupUp()
shiftGroupUp: (
event?
:MouseEvent
<Element
,MouseEvent
>,context?
:any
) =>void
Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:426
Parameters
Parameter | Type |
---|---|
event? | MouseEvent <Element , MouseEvent > |
context? | any |
Returns
void
shiftUpDisabled?
optional
shiftUpDisabled:boolean
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:668
Inherited from
RuleGroupProps
.shiftUpDisabled
toggleLockGroup
toggleLockGroup:
ActionElementEventHandler
Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:427
translations
translations:
Translations
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:664
Inherited from
validationClassName
validationClassName:
string
Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:428
validationResult
validationResult:
boolean
|ValidationResult
Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:429
API documentation is generated from the latest commit on the main
branch. It may be somewhat inconsistent with official releases of React Query Builder.