Schema<F, O>

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

Type parameters

Type parameter
F extends FullField
O extends string

Properties

accessibleDescriptionGenerator

accessibleDescriptionGenerator: AccessibleDescriptionGenerator

Source

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

---

addRuleToNewGroups

addRuleToNewGroups: boolean

Source

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

---

autoSelectField

autoSelectField: boolean

Source

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

---

autoSelectOperator

autoSelectOperator: boolean

Source

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

---

classNames

classNames: Classnames

Source

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

---

combinators

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

Source

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

---

controls

controls: Controls<F, O>

Source

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

---

disabledPaths

disabledPaths: Path[]

Source

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

---

enableDragAndDrop

enableDragAndDrop: boolean

Source

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

---

fieldMap

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

Source

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

---

fields

fields: FullOptionList<F>

Source

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

---

independentCombinators

independentCombinators: boolean

Source

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

---

listsAsArrays

listsAsArrays: boolean

Source

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

---

parseNumbers

parseNumbers: ParseNumbersMethod

Source

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

---

qbId

qbId: string

Source

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

---

showCloneButtons

showCloneButtons: boolean

Source

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

---

showCombinatorsBetweenRules

showCombinatorsBetweenRules: boolean

Source

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

---

showLockButtons

showLockButtons: boolean

Source

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

---

showNotToggle

showNotToggle: boolean

Source

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

---

showShiftActions

showShiftActions: boolean

Source

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

---

validationMap

validationMap: ValidationMap

Source

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

Methods

createRule()

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

Returns

RuleType<string, string, any, string>

Source

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

---

createRuleGroup()

createRuleGroup(ic?): RuleGroupTypeAny

Parameters

Parameter	Type
ic?	boolean

Returns

RuleGroupTypeAny

Source

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

---

dispatchQuery()

dispatchQuery(query): void

Parameters

Parameter	Type
query	RuleGroupTypeAny

Returns

void

Source

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

---

getInputType()

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

Parameters

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

Returns

null | InputType

Source

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

---

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>>[]

Source

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

---

getQuery()

getQuery(): undefined | RuleGroupTypeAny

Returns

undefined | RuleGroupTypeAny

Source

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

---

getRuleClassname()

getRuleClassname(rule, misc): Classname

Parameters

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

Returns

Classname

Source

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

---

getRuleGroupClassname()

getRuleGroupClassname(ruleGroup): Classname

Parameters

Parameter	Type
ruleGroup	RuleGroupTypeAny

Returns

Classname

Source

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

---

getValueEditorSeparator()

getValueEditorSeparator(field, operator, meta): ReactNode

Parameters

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

Returns

ReactNode

Source

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

---

getValueEditorType()

getValueEditorType(field, operator, meta): ValueEditorType

Parameters

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

Returns

ValueEditorType

Source

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

---

getValueSources()

getValueSources(field, operator, meta): ValueSources

Parameters

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

Returns

ValueSources

Source

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

---

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>>>[]

Source

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

---

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.