UseRule
Defined in: packages/react-querybuilder/src/components/Rule.tsx:287
Rule props.
Extends
Properties
actions
actions:
QueryActions
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:419
Inherited from
classNames
classNames: {
cloneRule
:string
;dragHandle
:string
;fields
:string
;lockRule
:string
;operators
:string
;removeRule
:string
;shiftActions
:string
;value
:string
;valueSource
:string
; }
Defined in: packages/react-querybuilder/src/components/Rule.tsx:288
cloneRule
cloneRule:
string
dragHandle
dragHandle:
string
fields
fields:
string
lockRule
lockRule:
string
operators
operators:
string
removeRule
removeRule:
string
shiftActions
shiftActions:
string
value
value:
string
valueSource
valueSource:
string
cloneRule
cloneRule:
ActionElementEventHandler
Defined in: packages/react-querybuilder/src/components/Rule.tsx:299
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
dndRef?
optional
dndRef:Ref
<HTMLDivElement
>
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:476
Inherited from
dragMonitorId?
optional
dragMonitorId:string
|symbol
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:472
Inherited from
dragRef?
optional
dragRef:Ref
<HTMLSpanElement
>
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:475
Inherited from
dropEffect?
optional
dropEffect:DropEffect
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:478
"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:474
Inherited from
field?
optional
field:string
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:495
Deprecated
Use the field
property of the rule
prop instead
Inherited from
fieldData
fieldData: {[
key
:string
]:unknown
;className
:Classname
;comparator
:string
| (f
: {[key
:string
]:unknown
;className
:Classname
;comparator
: string | ((f: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; ... 9 more ...; cl...;defaultOperator
:string
;defaultValue
:any
;disabled
:boolean
;id
:string
;inputType
:null
|InputType
;label
:string
;name
:string
;operators
:FlexibleOptionList
<{[key
:string
]:unknown
;disabled
:boolean
;label
:string
;name
:string
;value
:string
; }>;placeholder
:string
;validator
:RuleValidator
;value
:string
;valueEditorType
:ValueEditorType
| (operator
:string
) =>ValueEditorType
;values
:FlexibleOptionList
<{[key
:string
]:unknown
;disabled
:boolean
;label
:string
;name
:string
;value
:string
; }>;valueSources
:ValueSources
| (operator
:string
) =>ValueSources
; },operator
:string
) =>boolean
;defaultOperator
:string
;defaultValue
:any
;disabled
:boolean
;id
:string
;inputType
:null
|InputType
;label
:string
;name
:string
;operators
:FlexibleOptionList
<{[key
:string
]:unknown
;disabled
:boolean
;label
:string
;name
:string
;value
:string
; }>;placeholder
:string
;validator
:RuleValidator
;value
:string
;valueEditorType
:ValueEditorType
| (operator
:string
) =>ValueEditorType
;values
:FlexibleOptionList
<{[key
:string
]:unknown
;disabled
:boolean
;label
:string
;name
:string
;value
:string
; }>;valueSources
:ValueSources
| (operator
:string
) =>ValueSources
; }
Defined in: packages/react-querybuilder/src/components/Rule.tsx:300
Index Signature
[key
: string
]: unknown
className?
optional
className:Classname
comparator?
optional
comparator:string
| (f
: {[key
:string
]:unknown
;className
:Classname
;comparator
: string | ((f: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; ... 9 more ...; cl...;defaultOperator
:string
;defaultValue
:any
;disabled
:boolean
;id
:string
;inputType
:null
|InputType
;label
:string
;name
:string
;operators
:FlexibleOptionList
<{[key
:string
]:unknown
;disabled
:boolean
;label
:string
;name
:string
;value
:string
; }>;placeholder
:string
;validator
:RuleValidator
;value
:string
;valueEditorType
:ValueEditorType
| (operator
:string
) =>ValueEditorType
;values
:FlexibleOptionList
<{[key
:string
]:unknown
;disabled
:boolean
;label
:string
;name
:string
;value
:string
; }>;valueSources
:ValueSources
| (operator
:string
) =>ValueSources
; },operator
:string
) =>boolean
defaultOperator?
optional
defaultOperator:string
defaultValue?
optional
defaultValue:any
disabled?
optional
disabled:boolean
id?
optional
id:string
inputType?
optional
inputType:null
|InputType
label
label:
string
name
name:
string
operators?
optional
operators:FlexibleOptionList
<{[key
:string
]:unknown
;disabled
:boolean
;label
:string
;name
:string
;value
:string
; }>
placeholder?
optional
placeholder:string
validator?
optional
validator:RuleValidator
value
value:
string
valueEditorType?
optional
valueEditorType:ValueEditorType
| (operator
:string
) =>ValueEditorType
values?
optional
values:FlexibleOptionList
<{[key
:string
]:unknown
;disabled
:boolean
;label
:string
;name
:string
;value
:string
; }>
valueSources?
optional
valueSources:ValueSources
| (operator
:string
) =>ValueSources
generateOnChangeHandler()
generateOnChangeHandler: (
prop
:"value"
|"disabled"
|"field"
|"operator"
|"valueSource"
|"combinatorPreceding"
) =>ValueChangeEventHandler
Defined in: packages/react-querybuilder/src/components/Rule.tsx:301
Parameters
Parameter | Type |
---|---|
prop | "value" | "disabled" | "field" | "operator" | "valueSource" | "combinatorPreceding" |
Returns
groupItems?
optional
groupItems:boolean
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:480
True if the dragged and hovered items should form a new group.
Inherited from
hideValueControls
hideValueControls:
boolean
Defined in: packages/react-querybuilder/src/components/Rule.tsx:308
id?
optional
id:string
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:414
Inherited from
inputType
inputType:
null
|InputType
Defined in: packages/react-querybuilder/src/components/Rule.tsx:309
isDragging?
optional
isDragging:boolean
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:471
Inherited from
isOver?
optional
isOver:boolean
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:473
Inherited from
onChangeField
onChangeField:
ValueChangeEventHandler
Defined in: packages/react-querybuilder/src/components/Rule.tsx:305
onChangeOperator
onChangeOperator:
ValueChangeEventHandler
Defined in: packages/react-querybuilder/src/components/Rule.tsx:306
onChangeValue
onChangeValue:
ValueChangeEventHandler
Defined in: packages/react-querybuilder/src/components/Rule.tsx:307
onChangeValueSource
onChangeValueSource:
ValueChangeEventHandler
Defined in: packages/react-querybuilder/src/components/Rule.tsx:304
operator?
optional
operator:string
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:499
Deprecated
Use the operator
property of the rule
prop instead
Inherited from
operators
operators:
OptionList
<FullOperator
<string
>>
Defined in: packages/react-querybuilder/src/components/Rule.tsx:310
outerClassName
outerClassName:
string
Defined in: packages/react-querybuilder/src/components/Rule.tsx:311
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
removeRule
removeRule:
ActionElementEventHandler
Defined in: packages/react-querybuilder/src/components/Rule.tsx:312
rule
rule:
RuleType
<string
,string
>
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:491
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
shiftRuleDown()
shiftRuleDown: (
event
?:MouseEvent
<Element
,MouseEvent
>,_context
?:any
) =>void
Defined in: packages/react-querybuilder/src/components/Rule.tsx:314
Parameters
Parameter | Type |
---|---|
event ? | MouseEvent <Element , MouseEvent > |
_context ? | any |
Returns
void
shiftRuleUp()
shiftRuleUp: (
event
?:MouseEvent
<Element
,MouseEvent
>,_context
?:any
) =>void
Defined in: packages/react-querybuilder/src/components/Rule.tsx:313
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
toggleLockRule
toggleLockRule:
ActionElementEventHandler
Defined in: packages/react-querybuilder/src/components/Rule.tsx:315
translations
translations:
Translations
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:417
Inherited from
validationResult
validationResult:
boolean
|ValidationResult
Defined in: packages/react-querybuilder/src/components/Rule.tsx:316
value?
optional
value:any
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:504
Deprecated
Use the value
property of the rule
prop instead
Inherited from
valueEditorSeparator
valueEditorSeparator:
ReactNode
Defined in: packages/react-querybuilder/src/components/Rule.tsx:317
valueEditorType
valueEditorType:
ValueEditorType
Defined in: packages/react-querybuilder/src/components/Rule.tsx:318
values
values:
FlexibleOptionList
<{[key
:string
]:unknown
;disabled
:boolean
;label
:string
;name
:string
;value
:string
; }>
Defined in: packages/react-querybuilder/src/components/Rule.tsx:319
valueSource?
optional
valueSource:ValueSource
Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:508
Deprecated
Use the valueSource
property of the rule
prop instead
Inherited from
valueSourceOptions
valueSourceOptions:
ValueSourceOptions
Defined in: packages/react-querybuilder/src/components/Rule.tsx:320
valueSources
valueSources:
ValueSources
Defined in: packages/react-querybuilder/src/components/Rule.tsx:321
API documentation is generated from the latest commit on the main
branch. It may be somewhat inconsistent with official releases of React Query Builder.