RuleProps<F, O>
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:728
Rule props.
Extends
CommonRuleAndGroupProps
<FullOption
<F
>,O
>.Partial
<UseRuleDnD
>
Extended by
Type Parameters
Type Parameter | Default type |
---|---|
F extends string | string |
O extends string | string |
Properties
actions
actions:
QueryActions
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:659
Inherited from
CommonRuleAndGroupProps.actions
context?
optional
context:any
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:664
Inherited from
CommonRuleAndGroupProps.context
disabled?
optional
disabled:boolean
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:660
Inherited from
CommonRuleAndGroupProps.disabled
dndRef?
optional
dndRef:Ref
<HTMLDivElement
>
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:716
Inherited from
Partial.dndRef
dragMonitorId?
optional
dragMonitorId:string
|symbol
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:712
Inherited from
Partial.dragMonitorId
dragRef?
optional
dragRef:Ref
<HTMLSpanElement
>
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:715
Inherited from
Partial.dragRef
dropEffect?
optional
dropEffect:DropEffect
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:718
"move"
by default; "copy"
if the modifier key is pressed.
Inherited from
Partial.dropEffect
dropMonitorId?
optional
dropMonitorId:string
|symbol
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:714
Inherited from
Partial.dropMonitorId
field?
optional
field:string
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:735
Deprecated
Use the field
property of the rule
prop instead
groupItems?
optional
groupItems:boolean
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:720
True if the dragged and hovered items should form a new group.
Inherited from
Partial.groupItems
id?
optional
id:string
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:654
Inherited from
CommonRuleAndGroupProps.id
isDragging?
optional
isDragging:boolean
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:711
Inherited from
Partial.isDragging
isOver?
optional
isOver:boolean
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:713
Inherited from
Partial.isOver
operator?
optional
operator:string
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:739
Deprecated
Use the operator
property of the rule
prop instead
parentDisabled?
optional
parentDisabled:boolean
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:656
Inherited from
CommonRuleAndGroupProps.parentDisabled
path
path:
Path
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:655
Inherited from
CommonRuleAndGroupProps.path
rule
rule:
RuleType
<F
,O
>
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:731
schema
schema:
Schema
<{[key
:string
]:unknown
;disabled?
:boolean
;label
:string
;name
:F
;value
:F
; },O
>
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:658
Inherited from
CommonRuleAndGroupProps.schema
shiftDownDisabled?
optional
shiftDownDisabled:boolean
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:662
Inherited from
CommonRuleAndGroupProps.shiftDownDisabled
shiftUpDisabled?
optional
shiftUpDisabled:boolean
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:661
Inherited from
CommonRuleAndGroupProps.shiftUpDisabled
translations
translations:
Translations
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:657
Inherited from
CommonRuleAndGroupProps.translations
value?
optional
value:any
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:744
Deprecated
Use the value
property of the rule
prop instead
valueSource?
optional
valueSource:ValueSource
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:748
Deprecated
Use the valueSource
property of the rule
prop instead
API documentation is generated from the latest commit on the main
branch. It may be somewhat inconsistent with official releases of React Query Builder.