SchemaNative<F, O>

Configuration options passed in the schema prop from QueryBuilder to each subcomponent.

Extends

• Schema<F, O>.WithOptionalStyleSheets

Type Parameters

Type Parameter
F extends FullField
O extends string

Properties

accessibleDescriptionGenerator

accessibleDescriptionGenerator: AccessibleDescriptionGenerator

Inherited from

Schema.accessibleDescriptionGenerator

Defined in

packages/react-querybuilder/src/types/propsUsingReact.ts:364

---

addRuleToNewGroups

addRuleToNewGroups: boolean

Inherited from

Schema.addRuleToNewGroups

Defined in

packages/react-querybuilder/src/types/propsUsingReact.ts:372

---

autoSelectField

autoSelectField: boolean

Inherited from

Schema.autoSelectField

Defined in

packages/react-querybuilder/src/types/propsUsingReact.ts:370

---

autoSelectOperator

autoSelectOperator: boolean

Inherited from

Schema.autoSelectOperator

Defined in

packages/react-querybuilder/src/types/propsUsingReact.ts:371

---

classNames

classNames: Classnames

Inherited from

Schema.classNames

Defined in

packages/react-querybuilder/src/types/propsUsingReact.ts:349

---

combinators

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

Inherited from

Schema.combinators

Defined in

packages/react-querybuilder/src/types/propsUsingReact.ts:350

---

controls

controls: Required<SetNonNullable<Partial<object>, "notToggle" | "dragHandle" | "valueSourceSelector" | "ruleGroup" | "rule" | "shiftActions" | "actionElement" | "addGroupAction" | "addRuleAction" | "cloneGroupAction" | "cloneRuleAction" | "combinatorSelector" | "fieldSelector" | "inlineCombinator" | "lockGroupAction" | "lockRuleAction" | "operatorSelector" | "removeGroupAction" | "removeRuleAction" | "ruleGroupBodyElements" | "ruleGroupHeaderElements" | "valueEditor" | "valueSelector">>

Inherited from

Schema.controls

Defined in

packages/react-querybuilder/src/types/propsUsingReact.ts:351

---

disabledPaths

disabledPaths: Path[]

Inherited from

Schema.disabledPaths

Defined in

packages/react-querybuilder/src/types/propsUsingReact.ts:378

---

enableDragAndDrop

enableDragAndDrop: boolean

Inherited from

Schema.enableDragAndDrop

Defined in

packages/react-querybuilder/src/types/propsUsingReact.ts:373

---

fieldMap

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

Inherited from

Schema.fieldMap

Defined in

packages/react-querybuilder/src/types/propsUsingReact.ts:348

---

fields

fields: FullOptionList<F>

Inherited from

Schema.fields

Defined in

packages/react-querybuilder/src/types/propsUsingReact.ts:347

---

independentCombinators

independentCombinators: boolean

Inherited from

Schema.independentCombinators

Defined in

packages/react-querybuilder/src/types/propsUsingReact.ts:375

---

listsAsArrays

listsAsArrays: boolean

Inherited from

Schema.listsAsArrays

Defined in

packages/react-querybuilder/src/types/propsUsingReact.ts:376

---

parseNumbers

parseNumbers: ParseNumbersPropConfig

Inherited from

Schema.parseNumbers

Defined in

packages/react-querybuilder/src/types/propsUsingReact.ts:377

---

qbId

qbId: string

Inherited from

Schema.qbId

Defined in

packages/react-querybuilder/src/types/propsUsingReact.ts:346

---

showCloneButtons

showCloneButtons: boolean

Inherited from

Schema.showCloneButtons

Defined in

packages/react-querybuilder/src/types/propsUsingReact.ts:368

---

showCombinatorsBetweenRules

showCombinatorsBetweenRules: boolean

Inherited from

Schema.showCombinatorsBetweenRules

Defined in

packages/react-querybuilder/src/types/propsUsingReact.ts:365

---

showLockButtons

showLockButtons: boolean

Inherited from

Schema.showLockButtons

Defined in

packages/react-querybuilder/src/types/propsUsingReact.ts:369

---

showNotToggle

showNotToggle: boolean

Inherited from

Schema.showNotToggle

Defined in

packages/react-querybuilder/src/types/propsUsingReact.ts:366

---

showShiftActions

showShiftActions: boolean

Inherited from

Schema.showShiftActions

Defined in

packages/react-querybuilder/src/types/propsUsingReact.ts:367

---

styles?

optional styles: WrapEachPropertyInStyleProp<QueryBuilderNativeStyles>

Inherited from

WithOptionalStyleSheets.styles

Defined in

packages/native/src/types.ts:27

---

validationMap

validationMap: ValidationMap

Inherited from

Schema.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>

Inherited from

Schema.createRule

Defined in

packages/react-querybuilder/src/types/propsUsingReact.ts:352

---

createRuleGroup()

createRuleGroup(ic?): RuleGroupTypeAny

Parameters

Parameter	Type
ic?	boolean

Returns

RuleGroupTypeAny

Inherited from

Schema.createRuleGroup

Defined in

packages/react-querybuilder/src/types/propsUsingReact.ts:353

---

dispatchQuery()

dispatchQuery(query): void

Parameters

Parameter	Type
query	RuleGroupTypeAny

Returns

void

Inherited from

Schema.dispatchQuery

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	object
meta.fieldData	F

Returns

null | InputType

Inherited from

Schema.getInputType

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	object
meta.fieldData	F

Returns

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

Inherited from

Schema.getOperators

Defined in

packages/react-querybuilder/src/types/propsUsingReact.ts:356

---

getQuery()

getQuery(): undefined | RuleGroupTypeAny

Returns

undefined | RuleGroupTypeAny

Inherited from

Schema.getQuery

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	object
misc.fieldData	F

Returns

Classname

Inherited from

Schema.getRuleClassname

Defined in

packages/react-querybuilder/src/types/propsUsingReact.ts:362

---

getRuleGroupClassname()

getRuleGroupClassname(ruleGroup): Classname

Parameters

Parameter	Type
ruleGroup	RuleGroupTypeAny

Returns

Classname

Inherited from

Schema.getRuleGroupClassname

Defined in

packages/react-querybuilder/src/types/propsUsingReact.ts:363

---

getValueEditorSeparator()

getValueEditorSeparator(field, operator, meta): ReactNode

Parameters

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

Returns

ReactNode

Inherited from

Schema.getValueEditorSeparator

Defined in

packages/react-querybuilder/src/types/propsUsingReact.ts:358

---

getValueEditorType()

getValueEditorType(field, operator, meta): ValueEditorType

Parameters

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

Returns

ValueEditorType

Inherited from

Schema.getValueEditorType

Defined in

packages/react-querybuilder/src/types/propsUsingReact.ts:357

---

getValueSources()

getValueSources(field, operator, meta): ValueSources

Parameters

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

Returns

ValueSources

Inherited from

Schema.getValueSources

Defined in

packages/react-querybuilder/src/types/propsUsingReact.ts:359

---

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

Defined in

packages/react-querybuilder/src/types/propsUsingReact.ts:361

---

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.