Schema<F, O>

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

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:379

Returns

RuleType

---

createRuleGroup()

createRuleGroup(ic?: boolean): RuleGroupTypeAny

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

Parameters

Parameter	Type
ic?	boolean

Returns

RuleGroupTypeAny

---

dispatchQuery()

dispatchQuery(query: RuleGroupTypeAny): void

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

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:387

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:383

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:382

Returns

RuleGroupTypeAny

---

getRuleClassname()

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

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

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:390

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:385

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:384

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:388

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:386

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:391

---

addRuleToNewGroups

addRuleToNewGroups: boolean

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

---

autoSelectField

autoSelectField: boolean

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

---

autoSelectOperator

autoSelectOperator: boolean

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

---

autoSelectValue

autoSelectValue: boolean

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

---

classNames

classNames: Classnames

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

---

combinators

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

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

---

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> & RuleGroupProps<{[key: string]: unknown; disabled: boolean; label: string; name: string; value: string; }, string> & { accessibleDescription: string; addGroup: ActionElementEventHandler; addRule: ActionElementEventHandler; classNames: Pick<{ actionElement: string; addGroup: string; addRule: string; betweenRules: string; body: string; branches: string; cloneGroup: string; cloneRule: string; combinators: string; disabled: string; dndCopy: string; dndDragging: string; dndGroup: string; dndOver: string; dragHandle: string; fields: string; header: string; invalid: string; lockGroup: string; lockRule: string; notToggle: string; operators: string; queryBuilder: string; removeGroup: string; removeRule: string; rule: string; ruleGroup: string; shiftActions: string; valid: string; value: string; valueListItem: string; valueSelector: string; valueSource: string; }, "removeGroup" | "addRule" | "addGroup" | "combinators" | "notToggle" | "dragHandle" | "lockGroup" | "shiftActions" | "body" | "header" | "cloneGroup">; cloneGroup: ActionElementEventHandler; onCombinatorChange: ValueChangeEventHandler; onGroupAdd: (group: RuleGroupTypeAny, parentPath: Path, context?: any) => void; onIndependentCombinatorChange: (value: any, index: number, context?: any) => void; onNotToggleChange: (checked: boolean, context?: any) => void; outerClassName: string; pathsMemo: { disabled: boolean; path: Path; }[]; removeGroup: ActionElementEventHandler; ruleGroup: RuleGroupType<RuleType<string, string, any, string>, string> | RuleGroupTypeIC<RuleType<string, string, any, string>, string>; shiftGroupDown: (event?: MouseEvent<Element, MouseEvent>, context?: any) => void; shiftGroupUp: (event?: MouseEvent<Element, MouseEvent>, context?: any) => void; toggleLockGroup: ActionElementEventHandler; validationClassName: string; validationResult: boolean | ValidationResult; }>; ruleGroupHeaderElements: ComponentType<RuleGroupProps<{[key: string]: unknown; disabled: boolean; label: string; name: string; value: string; }, string> & RuleGroupProps<{[key: string]: unknown; disabled: boolean; label: string; name: string; value: string; }, string> & { accessibleDescription: string; addGroup: ActionElementEventHandler; addRule: ActionElementEventHandler; classNames: Pick<{ actionElement: string; addGroup: string; addRule: string; betweenRules: string; body: string; branches: string; cloneGroup: string; cloneRule: string; combinators: string; disabled: string; dndCopy: string; dndDragging: string; dndGroup: string; dndOver: string; dragHandle: string; fields: string; header: string; invalid: string; lockGroup: string; lockRule: string; notToggle: string; operators: string; queryBuilder: string; removeGroup: string; removeRule: string; rule: string; ruleGroup: string; shiftActions: string; valid: string; value: string; valueListItem: string; valueSelector: string; valueSource: string; }, "removeGroup" | "addRule" | "addGroup" | "combinators" | "notToggle" | "dragHandle" | "lockGroup" | "shiftActions" | "body" | "header" | "cloneGroup">; cloneGroup: ActionElementEventHandler; onCombinatorChange: ValueChangeEventHandler; onGroupAdd: (group: RuleGroupTypeAny, parentPath: Path, context?: any) => void; onIndependentCombinatorChange: (value: any, index: number, context?: any) => void; onNotToggleChange: (checked: boolean, context?: any) => void; outerClassName: string; pathsMemo: { disabled: boolean; path: Path; }[]; removeGroup: ActionElementEventHandler; ruleGroup: RuleGroupType<RuleType<string, string, any, string>, string> | RuleGroupTypeIC<RuleType<string, string, any, string>, string>; shiftGroupDown: (event?: MouseEvent<Element, MouseEvent>, context?: any) => void; shiftGroupUp: (event?: MouseEvent<Element, MouseEvent>, context?: any) => void; toggleLockGroup: ActionElementEventHandler; validationClassName: string; validationResult: boolean | ValidationResult; }>; 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>; }>, "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:378

---

disabledPaths

disabledPaths: Path[]

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

---

enableDragAndDrop

enableDragAndDrop: boolean

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

---

fieldMap

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

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

---

fields

fields: FullOptionList<F>

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

---

independentCombinators

independentCombinators: boolean

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

---

listsAsArrays

listsAsArrays: boolean

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

---

parseNumbers

parseNumbers: ParseNumbersPropConfig

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

---

qbId

qbId: string

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

---

showCloneButtons

showCloneButtons: boolean

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

---

showCombinatorsBetweenRules

showCombinatorsBetweenRules: boolean

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

---

showLockButtons

showLockButtons: boolean

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

---

showNotToggle

showNotToggle: boolean

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

---

showShiftActions

showShiftActions: boolean

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

---

suppressStandardClassnames

suppressStandardClassnames: boolean

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

---

validationMap

validationMap: ValidationMap

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

---

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.