Schema<F, O>
Configuration options passed in the schema prop from
QueryBuilder to each subcomponent.
Extended by
Type Parameters
| Type Parameter |
|---|
F extends FullField |
O extends string |
Properties
accessibleDescriptionGenerator
accessibleDescriptionGenerator:
AccessibleDescriptionGenerator
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:364
addRuleToNewGroups
addRuleToNewGroups:
boolean
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:372
autoSelectField
autoSelectField:
boolean
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:370
autoSelectOperator
autoSelectOperator:
boolean
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:371
classNames
classNames:
Classnames
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:349
combinators
combinators:
FullCombinator<string>[] |OptionGroup<FullCombinator<string>>[]
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:350
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<FullOption<string>,string> &Omit<RuleGroupProps<FullOption<string>,string>,"ruleGroup"> &object>;ruleGroupHeaderElements:ComponentType<RuleGroupProps<FullOption<string>,string> &Omit<RuleGroupProps<FullOption<string>,string>,"ruleGroup"> &object>;shiftActions:null|ComponentType<ShiftActionsProps>;valueEditor:null|ComponentType<ValueEditorProps<F,O>>;valueSelector:ComponentType<ValueSelectorProps<FullOption<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
packages/react-querybuilder/src/types/propsUsingReact.ts:351
disabledPaths
disabledPaths:
Path[]
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:378
enableDragAndDrop
enableDragAndDrop:
boolean
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:373
fieldMap
fieldMap:
Partial<Record<GetOptionIdentifierType<F>,F>>
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:348
fields
fields:
FullOptionList<F>
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:347
independentCombinators
independentCombinators:
boolean
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:375
listsAsArrays
listsAsArrays:
boolean
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:376
parseNumbers
parseNumbers:
ParseNumbersPropConfig
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:377
qbId
qbId:
string
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:346
showCloneButtons
showCloneButtons:
boolean
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:368
showCombinatorsBetweenRules
showCombinatorsBetweenRules:
boolean
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:365
showLockButtons
showLockButtons:
boolean
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:369
showNotToggle
showNotToggle:
boolean
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:366
showShiftActions
showShiftActions:
boolean
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:367
suppressStandardClassnames
suppressStandardClassnames:
boolean
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:379
validationMap
validationMap:
ValidationMap
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:374
Methods
createRule()
createRule():
RuleType<string,string,any,string>
Returns
RuleType<string, string, any, string>
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:352
createRuleGroup()
createRuleGroup(
ic?):RuleGroupTypeAny
Parameters
| Parameter | Type |
|---|---|
ic? | boolean |
Returns
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:353
dispatchQuery()
dispatchQuery(
query):void
Parameters
| Parameter | Type |
|---|---|
query | RuleGroupTypeAny |
Returns
void
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:354
getInputType()
getInputType(
field,operator,meta):null|InputType
Parameters
| Parameter | Type |
|---|---|
field | string |
operator | string |
meta | { fieldData: F; } |
meta.fieldData | F |
Returns
null | InputType
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:360
getOperators()
getOperators(
field,meta):FullOperator<string>[] |OptionGroup<FullOperator<string>>[]
Parameters
| Parameter | Type |
|---|---|
field | string |
meta | { fieldData: F; } |
meta.fieldData | F |
Returns
FullOperator<string>[] | OptionGroup<FullOperator<string>>[]
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:356
getQuery()
getQuery():
undefined|RuleGroupTypeAny
Returns
undefined | RuleGroupTypeAny
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:355
getRuleClassname()
getRuleClassname(
rule,misc):Classname
Parameters
| Parameter | Type |
|---|---|
rule | RuleType<string, string, any, string> |
misc | { fieldData: F; } |
misc.fieldData | F |
Returns
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:362
getRuleGroupClassname()
getRuleGroupClassname(
ruleGroup):Classname
Parameters
| Parameter | Type |
|---|---|
ruleGroup | RuleGroupTypeAny |
Returns
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:363
getValueEditorSeparator()
getValueEditorSeparator(
field,operator,meta):ReactNode
Parameters
| Parameter | Type |
|---|---|
field | string |
operator | string |
meta | { fieldData: F; } |
meta.fieldData | F |
Returns
ReactNode
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:358
getValueEditorType()
getValueEditorType(
field,operator,meta):ValueEditorType
Parameters
| Parameter | Type |
|---|---|
field | string |
operator | string |
meta | { fieldData: F; } |
meta.fieldData | F |
Returns
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:357
getValues()
getValues(
field,operator,meta):WithUnknownIndex<Option<string> &FullOption<string>>[] |OptionGroup<WithUnknownIndex<Option<string> &FullOption<string>>>[]
Parameters
| Parameter | Type |
|---|---|
field | string |
operator | string |
meta | { fieldData: F; } |
meta.fieldData | F |
Returns
WithUnknownIndex<Option<string> & FullOption<string>>[] | OptionGroup<WithUnknownIndex<Option<string> & FullOption<string>>>[]
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:361
getValueSources()
getValueSources(
field,operator,meta):ValueSources
Parameters
| Parameter | Type |
|---|---|
field | string |
operator | string |
meta | { fieldData: F; } |
meta.fieldData | F |
Returns
Defined in
packages/react-querybuilder/src/types/propsUsingReact.ts:359
API documentation is generated from the latest commit on the main branch. It may be somewhat inconsistent with official releases of React Query Builder.