Schema<F, O>

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:572

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

Extended by

• SchemaNative

Type Parameters

Type Parameter
F extends FullField
O extends string

Methods

createRule()

createRule(): RuleType

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:579

Returns

RuleType

---

createRuleGroup()

createRuleGroup(ic?: boolean): RuleGroupTypeAny

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:580

Parameters

Parameter	Type
ic?	boolean

Returns

RuleGroupTypeAny

---

dispatchQuery()

dispatchQuery(query: RuleGroupTypeAny): void

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:581

Parameters

Parameter	Type
query	RuleGroupTypeAny

Returns

void

---

getInputType()

getInputType(field: string, operator: string, meta: { fieldData: F; }): null | InputType

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:587

Parameters

Parameter	Type
field	string
operator	string
meta	{ fieldData: F; }
meta.fieldData	F

Returns

null | InputType

---

getOperators()

getOperators(field: string, meta: { fieldData: F; }): FullOperator<string>[] | OptionGroup<FullOperator<string>>[]

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:583

Parameters

Parameter	Type
field	string
meta	{ fieldData: F; }
meta.fieldData	F

Returns

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

---

getQuery()

getQuery(): RuleGroupTypeAny

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:582

Returns

RuleGroupTypeAny

---

getRuleClassname()

getRuleClassname(rule: RuleType, misc: { fieldData: F; }): Classname

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:589

Parameters

Parameter	Type
rule	RuleType
misc	{ fieldData: F; }
misc.fieldData	F

Returns

Classname

---

getRuleGroupClassname()

getRuleGroupClassname(ruleGroup: RuleGroupTypeAny): Classname

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:590

Parameters

Parameter	Type
ruleGroup	RuleGroupTypeAny

Returns

Classname

---

getValueEditorSeparator()

getValueEditorSeparator(field: string, operator: string, meta: { fieldData: F; }): ReactNode

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:585

Parameters

Parameter	Type
field	string
operator	string
meta	{ fieldData: F; }
meta.fieldData	F

Returns

ReactNode

---

getValueEditorType()

getValueEditorType(field: string, operator: string, meta: { fieldData: F; }): ValueEditorType

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:584

Parameters

Parameter	Type
field	string
operator	string
meta	{ fieldData: F; }
meta.fieldData	F

Returns

ValueEditorType

---

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: packages/react-querybuilder/src/types/propsUsingReact.ts:588

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

---

getValueSources()

getValueSources(field: string, operator: string, meta: { fieldData: F; }): ValueSources

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:586

Parameters

Parameter	Type
field	string
operator	string
meta	{ fieldData: F; }
meta.fieldData	F

Returns

ValueSources

Properties

accessibleDescriptionGenerator

accessibleDescriptionGenerator: AccessibleDescriptionGenerator

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:591

---

addRuleToNewGroups

addRuleToNewGroups: boolean

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:600

---

autoSelectField

autoSelectField: boolean

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:597

---

autoSelectOperator

autoSelectOperator: boolean

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:598

---

autoSelectValue

autoSelectValue: boolean

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:599

---

classNames

classNames: Classnames

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:576

---

combinators

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

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:577

---

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> & UseRuleGroup>; ruleGroupHeaderElements: ComponentType<RuleGroupProps<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }, string> & UseRuleGroup>; 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>; }>, "rule" | "ruleGroup" | "inlineCombinator" | "shiftActions" | "actionElement" | "addGroupAction" | "addRuleAction" | "cloneGroupAction" | "cloneRuleAction" | "combinatorSelector" | "dragHandle" | "fieldSelector" | "lockGroupAction" | "lockRuleAction" | "notToggle" | "operatorSelector" | "removeGroupAction" | "removeRuleAction" | "ruleGroupBodyElements" | "ruleGroupHeaderElements" | "valueEditor" | "valueSelector" | "valueSourceSelector">>

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:578

---

disabledPaths

disabledPaths: Path[]

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:606

---

enableDragAndDrop

enableDragAndDrop: boolean

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:601

---

fieldMap

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

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:575

---

fields

fields: FullOptionList<F>

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:574

---

independentCombinators

independentCombinators: boolean

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:603

---

listsAsArrays

listsAsArrays: boolean

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:604

---

parseNumbers

parseNumbers: ParseNumbersPropConfig

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:605

---

qbId

qbId: string

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:573

---

showCloneButtons

showCloneButtons: boolean

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:595

---

showCombinatorsBetweenRules

showCombinatorsBetweenRules: boolean

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:592

---

showLockButtons

showLockButtons: boolean

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:596

---

showNotToggle

showNotToggle: boolean

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:593

---

showShiftActions

showShiftActions: boolean

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:594

---

suppressStandardClassnames

suppressStandardClassnames: boolean

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:607

---

validationMap

validationMap: ValidationMap

Defined in: packages/react-querybuilder/src/types/propsUsingReact.ts:602

---

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.