SchemaNative<F, O>
Defined in: native/src/types.ts:37
Extends
Schema
<F
,O
>.WithOptionalStyleSheets
Type Parameters
Type Parameter |
---|
F extends FullField |
O extends string |
Methods
createRule()
createRule():
RuleType
Defined in: react-querybuilder/src/types/propsUsingReact.ts:379
Returns
Inherited from
createRuleGroup()
createRuleGroup(
ic
?:boolean
):RuleGroupTypeAny
Defined in: react-querybuilder/src/types/propsUsingReact.ts:380
Parameters
Parameter | Type |
---|---|
ic ? | boolean |
Returns
Inherited from
dispatchQuery()
dispatchQuery(
query
:RuleGroupTypeAny
):void
Defined in: react-querybuilder/src/types/propsUsingReact.ts:381
Parameters
Parameter | Type |
---|---|
query | RuleGroupTypeAny |
Returns
void
Inherited from
getInputType()
getInputType(
field
:string
,operator
:string
,meta
: {fieldData
:F
; }):null
|InputType
Defined in: react-querybuilder/src/types/propsUsingReact.ts:387
Parameters
Parameter | Type |
---|---|
field | string |
operator | string |
meta | { fieldData : F ; } |
meta.fieldData | F |
Returns
null
| InputType
Inherited from
getOperators()
getOperators(
field
:string
,meta
: {fieldData
:F
; }):FullOperator
<string
>[] |OptionGroup
<FullOperator
<string
>>[]
Defined in: react-querybuilder/src/types/propsUsingReact.ts:383
Parameters
Parameter | Type |
---|---|
field | string |
meta | { fieldData : F ; } |
meta.fieldData | F |
Returns
FullOperator
<string
>[] | OptionGroup
<FullOperator
<string
>>[]
Inherited from
getQuery()
getQuery():
RuleGroupTypeAny
Defined in: react-querybuilder/src/types/propsUsingReact.ts:382
Returns
Inherited from
getRuleClassname()
getRuleClassname(
rule
:RuleType
,misc
: {fieldData
:F
; }):Classname
Defined in: react-querybuilder/src/types/propsUsingReact.ts:389
Parameters
Parameter | Type |
---|---|
rule | RuleType |
misc | { fieldData : F ; } |
misc.fieldData | F |
Returns
Inherited from
getRuleGroupClassname()
getRuleGroupClassname(
ruleGroup
:RuleGroupTypeAny
):Classname
Defined in: react-querybuilder/src/types/propsUsingReact.ts:390
Parameters
Parameter | Type |
---|---|
ruleGroup | RuleGroupTypeAny |
Returns
Inherited from
getValueEditorSeparator()
getValueEditorSeparator(
field
:string
,operator
:string
,meta
: {fieldData
:F
; }):ReactNode
Defined in: react-querybuilder/src/types/propsUsingReact.ts:385
Parameters
Parameter | Type |
---|---|
field | string |
operator | string |
meta | { fieldData : F ; } |
meta.fieldData | F |
Returns
ReactNode
Inherited from
Schema
.getValueEditorSeparator
getValueEditorType()
getValueEditorType(
field
:string
,operator
:string
,meta
: {fieldData
:F
; }):ValueEditorType
Defined in: react-querybuilder/src/types/propsUsingReact.ts:384
Parameters
Parameter | Type |
---|---|
field | string |
operator | string |
meta | { fieldData : F ; } |
meta.fieldData | F |
Returns
Inherited from
getValues()
getValues(
field
:string
,operator
:string
,meta
: {fieldData
:F
; }):WithUnknownIndex
<{[key
:string
]:unknown
;disabled
:boolean
;label
:string
;name
:string
;value
:string
; } & {[key
:string
]:unknown
;disabled
:boolean
;label
:string
;name
:string
;value
:string
; }>[] |OptionGroup
<WithUnknownIndex
<{[key
:string
]:unknown
;disabled
:boolean
;label
:string
;name
:string
;value
:string
; } & {[key
:string
]:unknown
;disabled
:boolean
;label
:string
;name
:string
;value
:string
; }>>[]
Defined in: react-querybuilder/src/types/propsUsingReact.ts:388
Parameters
Parameter | Type |
---|---|
field | string |
operator | string |
meta | { fieldData : F ; } |
meta.fieldData | F |
Returns
WithUnknownIndex
<{[key
: string
]: unknown
; disabled
: boolean
; label
: string
; name
: string
; value
: string
; } & {[key
: string
]: unknown
; disabled
: boolean
; label
: string
; name
: string
; value
: string
; }>[] | OptionGroup
<WithUnknownIndex
<{[key
: string
]: unknown
; disabled
: boolean
; label
: string
; name
: string
; value
: string
; } & {[key
: string
]: unknown
; disabled
: boolean
; label
: string
; name
: string
; value
: string
; }>>[]
Inherited from
getValueSources()
getValueSources(
field
:string
,operator
:string
,meta
: {fieldData
:F
; }):ValueSources
Defined in: react-querybuilder/src/types/propsUsingReact.ts:386
Parameters
Parameter | Type |
---|---|
field | string |
operator | string |
meta | { fieldData : F ; } |
meta.fieldData | F |
Returns
Inherited from
Properties
accessibleDescriptionGenerator
accessibleDescriptionGenerator:
AccessibleDescriptionGenerator
Defined in: react-querybuilder/src/types/propsUsingReact.ts:391
Inherited from
Schema
.accessibleDescriptionGenerator
addRuleToNewGroups
addRuleToNewGroups:
boolean
Defined in: react-querybuilder/src/types/propsUsingReact.ts:400
Inherited from
autoSelectField
autoSelectField:
boolean
Defined in: react-querybuilder/src/types/propsUsingReact.ts:397
Inherited from
autoSelectOperator
autoSelectOperator:
boolean
Defined in: react-querybuilder/src/types/propsUsingReact.ts:398
Inherited from
autoSelectValue
autoSelectValue:
boolean
Defined in: react-querybuilder/src/types/propsUsingReact.ts:399
Inherited from
classNames
classNames:
Classnames
Defined in: react-querybuilder/src/types/propsUsingReact.ts:376
Inherited from
combinators
combinators:
FullCombinator
[] |OptionGroup
<FullCombinator
>[]
Defined in: react-querybuilder/src/types/propsUsingReact.ts:377
Inherited from
controls
controls:
Required
<SetNonNullable
<Partial
<{actionElement
:ComponentType
<ActionProps
>;addGroupAction
:null
|ComponentType
<ActionWithRulesAndAddersProps
>;addRuleAction
:null
|ComponentType
<ActionWithRulesAndAddersProps
>;cloneGroupAction
:null
|ComponentType
<ActionWithRulesProps
>;cloneRuleAction
:null
|ComponentType
<ActionProps
>;combinatorSelector
:null
|ComponentType
<CombinatorSelectorProps
>;dragHandle
:null
|ForwardRefExoticComponent
<DragHandleProps
&RefAttributes
<HTMLElement
>>;fieldSelector
:null
|ComponentType
<FieldSelectorProps
<F
>>;inlineCombinator
:null
|ComponentType
<InlineCombinatorProps
>;lockGroupAction
:null
|ComponentType
<ActionWithRulesProps
>;lockRuleAction
:null
|ComponentType
<ActionWithRulesProps
>;notToggle
:null
|ComponentType
<NotToggleProps
>;operatorSelector
:null
|ComponentType
<OperatorSelectorProps
>;removeGroupAction
:null
|ComponentType
<ActionWithRulesProps
>;removeRuleAction
:null
|ComponentType
<ActionProps
>;rule
:ComponentType
<RuleProps
<string
,string
>>;ruleGroup
:ComponentType
<RuleGroupProps
<F
,O
>>;ruleGroupBodyElements
:ComponentType
<RuleGroupProps
<{[key
:string
]:unknown
;disabled
:boolean
;label
:string
;name
:string
;value
:string
; },string
> &RuleGroupProps
<{[key
:string
]:unknown
;disabled
:boolean
;label
:string
;name
:string
;value
:string
; },string
> & {accessibleDescription
:string
;addGroup
:ActionElementEventHandler
;addRule
:ActionElementEventHandler
;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"
>;cloneGroup
:ActionElementEventHandler
;onCombinatorChange
:ValueChangeEventHandler
;onGroupAdd
: (group
:RuleGroupTypeAny
,parentPath
:Path
,context
?:any
) =>void
;onIndependentCombinatorChange
: (value
:any
,index
:number
,context
?:any
) =>void
;onNotToggleChange
: (checked
:boolean
,context
?:any
) =>void
;outerClassName
:string
;pathsMemo
: {disabled
:boolean
;path
:Path
; }[];removeGroup
:ActionElementEventHandler
;ruleGroup
:RuleGroupType
<RuleType
<string
,string
,any
,string
>,string
> |RuleGroupTypeIC
<RuleType
<string
,string
,any
,string
>,string
>;shiftGroupDown
: (event
?:MouseEvent
<Element
,MouseEvent
>,context
?:any
) =>void
;shiftGroupUp
: (event
?:MouseEvent
<Element
,MouseEvent
>,context
?:any
) =>void
;toggleLockGroup
:ActionElementEventHandler
;validationClassName
:string
;validationResult
:boolean
|ValidationResult
; }>;ruleGroupHeaderElements
:ComponentType
<RuleGroupProps
<{[key
:string
]:unknown
;disabled
:boolean
;label
:string
;name
:string
;value
:string
; },string
> &RuleGroupProps
<{[key
:string
]:unknown
;disabled
:boolean
;label
:string
;name
:string
;value
:string
; },string
> & {accessibleDescription
:string
;addGroup
:ActionElementEventHandler
;addRule
:ActionElementEventHandler
;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"
>;cloneGroup
:ActionElementEventHandler
;onCombinatorChange
:ValueChangeEventHandler
;onGroupAdd
: (group
:RuleGroupTypeAny
,parentPath
:Path
,context
?:any
) =>void
;onIndependentCombinatorChange
: (value
:any
,index
:number
,context
?:any
) =>void
;onNotToggleChange
: (checked
:boolean
,context
?:any
) =>void
;outerClassName
:string
;pathsMemo
: {disabled
:boolean
;path
:Path
; }[];removeGroup
:ActionElementEventHandler
;ruleGroup
:RuleGroupType
<RuleType
<string
,string
,any
,string
>,string
> |RuleGroupTypeIC
<RuleType
<string
,string
,any
,string
>,string
>;shiftGroupDown
: (event
?:MouseEvent
<Element
,MouseEvent
>,context
?:any
) =>void
;shiftGroupUp
: (event
?:MouseEvent
<Element
,MouseEvent
>,context
?:any
) =>void
;toggleLockGroup
:ActionElementEventHandler
;validationClassName
:string
;validationResult
:boolean
|ValidationResult
; }>;shiftActions
:null
|ComponentType
<ShiftActionsProps
>;valueEditor
:null
|ComponentType
<ValueEditorProps
<F
,O
>>;valueSelector
:ComponentType
<ValueSelectorProps
<{[key
:string
]:unknown
;disabled
:boolean
;label
:string
;name
:string
;value
:string
; }>>;valueSourceSelector
:null
|ComponentType
<ValueSourceSelectorProps
>; }>,"notToggle"
|"dragHandle"
|"valueSourceSelector"
|"ruleGroup"
|"rule"
|"shiftActions"
|"actionElement"
|"addGroupAction"
|"addRuleAction"
|"cloneGroupAction"
|"cloneRuleAction"
|"combinatorSelector"
|"fieldSelector"
|"inlineCombinator"
|"lockGroupAction"
|"lockRuleAction"
|"operatorSelector"
|"removeGroupAction"
|"removeRuleAction"
|"ruleGroupBodyElements"
|"ruleGroupHeaderElements"
|"valueEditor"
|"valueSelector"
>>
Defined in: react-querybuilder/src/types/propsUsingReact.ts:378
Inherited from
disabledPaths
disabledPaths:
Path
[]
Defined in: react-querybuilder/src/types/propsUsingReact.ts:406
Inherited from
enableDragAndDrop
enableDragAndDrop:
boolean
Defined in: react-querybuilder/src/types/propsUsingReact.ts:401
Inherited from
fieldMap
fieldMap:
Partial
<Record
<GetOptionIdentifierType
<F
>,F
>>
Defined in: react-querybuilder/src/types/propsUsingReact.ts:375
Inherited from
fields
fields:
FullOptionList
<F
>
Defined in: react-querybuilder/src/types/propsUsingReact.ts:374
Inherited from
independentCombinators
independentCombinators:
boolean
Defined in: react-querybuilder/src/types/propsUsingReact.ts:403
Inherited from
listsAsArrays
listsAsArrays:
boolean
Defined in: react-querybuilder/src/types/propsUsingReact.ts:404
Inherited from
parseNumbers
parseNumbers:
ParseNumbersPropConfig
Defined in: react-querybuilder/src/types/propsUsingReact.ts:405
Inherited from
qbId
qbId:
string
Defined in: react-querybuilder/src/types/propsUsingReact.ts:373
Inherited from
showCloneButtons
showCloneButtons:
boolean
Defined in: react-querybuilder/src/types/propsUsingReact.ts:395
Inherited from
showCombinatorsBetweenRules
showCombinatorsBetweenRules:
boolean
Defined in: react-querybuilder/src/types/propsUsingReact.ts:392
Inherited from
Schema
.showCombinatorsBetweenRules
showLockButtons
showLockButtons:
boolean
Defined in: react-querybuilder/src/types/propsUsingReact.ts:396
Inherited from
showNotToggle
showNotToggle:
boolean
Defined in: react-querybuilder/src/types/propsUsingReact.ts:393
Inherited from
showShiftActions
showShiftActions:
boolean
Defined in: react-querybuilder/src/types/propsUsingReact.ts:394
Inherited from
styles?
optional
styles:WrapEachPropertyInStyleProp
<QueryBuilderNativeStyles
>
Defined in: native/src/types.ts:31
Inherited from
WithOptionalStyleSheets.styles
suppressStandardClassnames
suppressStandardClassnames:
boolean
Defined in: react-querybuilder/src/types/propsUsingReact.ts:407
Inherited from
Schema
.suppressStandardClassnames
validationMap
validationMap:
ValidationMap
Defined in: react-querybuilder/src/types/propsUsingReact.ts:402
Inherited from
API documentation is generated from the latest commit on the main
branch. It may be somewhat inconsistent with official releases of React Query Builder.