SchemaNative<F, O>

Extends

• Schema<F, O>.WithOptionalStyleSheets

Type parameters

Type parameter
F extends FullField
O extends string

Properties

accessibleDescriptionGenerator

accessibleDescriptionGenerator: AccessibleDescriptionGenerator

Inherited from

Schema.accessibleDescriptionGenerator

Source

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1090

---

addRuleToNewGroups

addRuleToNewGroups: boolean

Inherited from

Schema.addRuleToNewGroups

Source

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1098

---

autoSelectField

autoSelectField: boolean

Inherited from

Schema.autoSelectField

Source

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1096

---

autoSelectOperator

autoSelectOperator: boolean

Inherited from

Schema.autoSelectOperator

Source

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1097

---

classNames

classNames: Classnames

Inherited from

Schema.classNames

Source

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1061

---

combinators

combinators: FullCombinator<string>[] | OptionGroup<FullCombinator<string>>[]

Inherited from

Schema.combinators

Source

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1062

---

controls

controls: Controls<F, O>

Inherited from

Schema.controls

Source

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1063

---

disabledPaths

disabledPaths: Path[]

Inherited from

Schema.disabledPaths

Source

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1104

---

enableDragAndDrop

enableDragAndDrop: boolean

Inherited from

Schema.enableDragAndDrop

Source

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1099

---

fieldMap

fieldMap: Partial<Record<GetOptionIdentifierType<F>, F>>

Inherited from

Schema.fieldMap

Source

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1060

---

fields

fields: FullOptionList<F>

Inherited from

Schema.fields

Source

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1059

---

independentCombinators

independentCombinators: boolean

Inherited from

Schema.independentCombinators

Source

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1101

---

listsAsArrays

listsAsArrays: boolean

Inherited from

Schema.listsAsArrays

Source

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1102

---

parseNumbers

parseNumbers: ParseNumbersMethod

Inherited from

Schema.parseNumbers

Source

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1103

---

qbId

qbId: string

Inherited from

Schema.qbId

Source

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1058

---

showCloneButtons

showCloneButtons: boolean

Inherited from

Schema.showCloneButtons

Source

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1094

---

showCombinatorsBetweenRules

showCombinatorsBetweenRules: boolean

Inherited from

Schema.showCombinatorsBetweenRules

Source

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1091

---

showLockButtons

showLockButtons: boolean

Inherited from

Schema.showLockButtons

Source

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1095

---

showNotToggle

showNotToggle: boolean

Inherited from

Schema.showNotToggle

Source

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1092

---

showShiftActions

showShiftActions: boolean

Inherited from

Schema.showShiftActions

Source

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1093

---

styles?

optional styles: WrapEachPropertyInStyleProp <QueryBuilderNativeStyles>

Inherited from

WithOptionalStyleSheets.styles

Source

native/src/types.ts:27

---

validationMap

validationMap: ValidationMap

Inherited from

Schema.validationMap

Source

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1100

Methods

createRule()

createRule(): RuleType<string, string, any, string>

Returns

RuleType<string, string, any, string>

Inherited from

Schema.createRule

Source

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1064

---

createRuleGroup()

createRuleGroup(ic?): RuleGroupTypeAny<RuleType<string, string, any, string>, string>

Parameters

Parameter	Type
ic?	boolean

Returns

RuleGroupTypeAny<RuleType<string, string, any, string>, string>

Inherited from

Schema.createRuleGroup

Source

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1065

---

dispatchQuery()

dispatchQuery(query): void

Parameters

Parameter	Type
query	RuleGroupTypeAny<RuleType<string, string, any, string>, string>

Returns

void

Inherited from

Schema.dispatchQuery

Source

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1066

---

getInputType()

getInputType(field, operator, meta): null | InputType

Parameters

Parameter	Type
field	string
operator	string
meta	object
meta.fieldData	F

Returns

null | InputType

Inherited from

Schema.getInputType

Source

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1080

---

getOperators()

getOperators(field, meta): FullOperator<string>[] | OptionGroup<FullOperator<string>>[]

Parameters

Parameter	Type
field	string
meta	object
meta.fieldData	F

Returns

FullOperator<string>[] | OptionGroup<FullOperator<string>>[]

Inherited from

Schema.getOperators

Source

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1068

---

getQuery()

getQuery(): undefined | RuleGroupTypeAny<RuleType<string, string, any, string>, string>

Returns

undefined | RuleGroupTypeAny<RuleType<string, string, any, string>, string>

Inherited from

Schema.getQuery

Source

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1067

---

getRuleClassname()

getRuleClassname(rule, misc): Classname

Parameters

Parameter	Type
rule	RuleType<string, string, any, string>
misc	object
misc.fieldData	F

Returns

Classname

Inherited from

Schema.getRuleClassname

Source

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1086

---

getRuleGroupClassname()

getRuleGroupClassname(ruleGroup): Classname

Parameters

Parameter	Type
ruleGroup	RuleGroupTypeAny<RuleType<string, string, any, string>, string>

Returns

Classname

Inherited from

Schema.getRuleGroupClassname

Source

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1089

---

getValueEditorSeparator()

getValueEditorSeparator(field, operator, meta): ReactNode

Parameters

Parameter	Type
field	string
operator	string
meta	object
meta.fieldData	F

Returns

ReactNode

Inherited from

Schema.getValueEditorSeparator

Source

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1074

---

getValueEditorType()

getValueEditorType(field, operator, meta): ValueEditorType

Parameters

Parameter	Type
field	string
operator	string
meta	object
meta.fieldData	F

Returns

ValueEditorType

Inherited from

Schema.getValueEditorType

Source

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1071

---

getValueSources()

getValueSources(field, operator, meta): ValueSources

Parameters

Parameter	Type
field	string
operator	string
meta	object
meta.fieldData	F

Returns

ValueSources

Inherited from

Schema.getValueSources

Source

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1077

---

getValues()

getValues(field, operator, meta): WithUnknownIndex<Option<string> & FullOption<string>>[] | OptionGroup<WithUnknownIndex<Option<string> & FullOption<string>>>[]

Parameters

Parameter	Type
field	string
operator	string
meta	object
meta.fieldData	F

Returns

WithUnknownIndex<Option<string> & FullOption<string>>[] | OptionGroup<WithUnknownIndex<Option<string> & FullOption<string>>>[]

Inherited from

Schema.getValues

Source

react-querybuilder/dist/cjs/react-querybuilder.cjs.production.d.ts:1083

---

caution

API documentation is generated from the latest commit on the main branch. It may be somewhat inconsistent with official releases of React Query Builder.