UseRuleGroup
Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:408
RuleGroup props.
Extends
Properties
accessibleDescription
accessibleDescription:
string
Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:411
actions
actions:
QueryActions
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:419
Inherited from
addGroup
addGroup:
ActionElementEventHandler
Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:409
addRule
addRule:
ActionElementEventHandler
Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:410
classNames
classNames:
Pick
<{actionElement
:string
;addGroup
:string
;addRule
:string
;betweenRules
:string
;body
:string
;branches
:string
;cloneGroup
:string
;cloneRule
:string
;combinators
:string
;disabled
:string
;dndCopy
:string
;dndDragging
:string
;dndGroup
:string
;dndOver
:string
;dragHandle
:string
;fields
:string
;header
:string
;invalid
:string
;lockGroup
:string
;lockRule
:string
;notToggle
:string
;operators
:string
;queryBuilder
:string
;removeGroup
:string
;removeRule
:string
;rule
:string
;ruleGroup
:string
;shiftActions
:string
;valid
:string
;value
:string
;valueListItem
:string
;valueSelector
:string
;valueSource
:string
; },"removeGroup"
|"addRule"
|"addGroup"
|"combinators"
|"notToggle"
|"dragHandle"
|"lockGroup"
|"shiftActions"
|"body"
|"header"
|"cloneGroup"
>
Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:412
cloneGroup
cloneGroup:
ActionElementEventHandler
Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:426
combinator?
optional
combinator:string
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:456
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:424
Inherited from
disabled?
optional
disabled:boolean
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:420
Inherited from
dragMonitorId?
optional
dragMonitorId:string
|symbol
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:432
Inherited from
dragRef?
optional
dragRef:Ref
<HTMLSpanElement
>
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:436
Inherited from
dropEffect?
optional
dropEffect:DropEffect
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:439
"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:434
Inherited from
dropRef?
optional
dropRef:Ref
<HTMLDivElement
>
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:437
Inherited from
groupItems?
optional
groupItems:boolean
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:441
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:414
Inherited from
isDragging?
optional
isDragging:boolean
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:431
Inherited from
isOver?
optional
isOver:boolean
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:433
Inherited from
not?
optional
not:boolean
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:464
Deprecated
Use the not
property of the ruleGroup
prop instead
Inherited from
onCombinatorChange
onCombinatorChange:
ValueChangeEventHandler
Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:427
onGroupAdd()
onGroupAdd: (
group
:RuleGroupTypeAny
,parentPath
:Path
,context
?:any
) =>void
Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:428
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:429
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:430
Parameters
Parameter | Type |
---|---|
checked | boolean |
context ? | any |
Returns
void
outerClassName
outerClassName:
string
Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:431
parentDisabled?
optional
parentDisabled:boolean
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:416
Inherited from
path
path:
Path
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:415
Inherited from
pathsMemo
pathsMemo: {
disabled
:boolean
;path
:Path
; }[]
Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:432
disabled
disabled:
boolean
path
path:
Path
previewRef?
optional
previewRef:Ref
<HTMLDivElement
>
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:435
Inherited from
removeGroup
removeGroup:
ActionElementEventHandler
Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:433
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:434
Overrides
rules?
optional
rules:RuleOrGroupArray
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:460
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:418
Inherited from
shiftDownDisabled?
optional
shiftDownDisabled:boolean
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:422
Inherited from
RuleGroupProps
.shiftDownDisabled
shiftGroupDown()
shiftGroupDown: (
event
?:MouseEvent
<Element
,MouseEvent
>,context
?:any
) =>void
Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:435
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:436
Parameters
Parameter | Type |
---|---|
event ? | MouseEvent <Element , MouseEvent > |
context ? | any |
Returns
void
shiftUpDisabled?
optional
shiftUpDisabled:boolean
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:421
Inherited from
RuleGroupProps
.shiftUpDisabled
toggleLockGroup
toggleLockGroup:
ActionElementEventHandler
Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:437
translations
translations:
Translations
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:417
Inherited from
validationClassName
validationClassName:
string
Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:438
validationResult
validationResult:
boolean
|ValidationResult
Defined in: packages/react-querybuilder/src/components/RuleGroup.tsx:439
API documentation is generated from the latest commit on the main
branch. It may be somewhat inconsistent with official releases of React Query Builder.