RuleContextResolvers<F>

Defined in: packages/core/src/utils/deriveRuleContext.ts:36

Functions used by deriveRuleContext to resolve a rule's configuration. Each corresponds to the QueryBuilder prop (or useQueryBuilderSetup output) of the same name.

Type Parameters

Type Parameter	Default type
F extends FullField	FullField

Properties

fieldMap

fieldMap: Partial<FullOptionRecord<FullField>>

Defined in: packages/core/src/utils/deriveRuleContext.ts:38

---

fields

fields: OptionList<F>

Defined in: packages/core/src/utils/deriveRuleContext.ts:37

---

getInputType

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

Defined in: packages/core/src/utils/deriveRuleContext.ts:39

Parameters

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

Returns

InputType | null

---

getMatchModes

getMatchModes: (field: string, misc: { fieldData: F; }) => MatchModeOptions

Defined in: packages/core/src/utils/deriveRuleContext.ts:40

Parameters

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

Returns

MatchModeOptions

---

getOperators

getOperators: (field: string, misc: { fieldData: F; }) => OptionList<FullOperator<string>>

Defined in: packages/core/src/utils/deriveRuleContext.ts:41

Parameters

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

Returns

OptionList<FullOperator<string>>

---

getParameters

getParameters: (field: string, operator: string, misc: { fieldData: F; }) => FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value?: string; }>

Defined in: packages/core/src/utils/deriveRuleContext.ts:42

Parameters

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

Returns

FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value?: string; }>

---

getSubQueryBuilderProps?

optional getSubQueryBuilderProps?: (field: string, misc: { fieldData: F; }) => Record<string, unknown>

Defined in: packages/core/src/utils/deriveRuleContext.ts:58

Parameters

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

Returns

Record<string, unknown>

---

getValueEditorType

getValueEditorType: (field: string, operator: string, misc: { fieldData: F; }) => ValueEditorType

Defined in: packages/core/src/utils/deriveRuleContext.ts:47

Parameters

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

Returns

ValueEditorType

---

getValues

getValues: (field: string, operator: string, misc: { fieldData: F; }) => FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value?: string; }>

Defined in: packages/core/src/utils/deriveRuleContext.ts:48

Parameters

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

Returns

FlexibleOptionList<{[key: string]: unknown; disabled?: boolean; label: string; name: string; value?: string; }>

---

getValueSources

getValueSources: (field: string, operator: string, misc: { fieldData: F; }) => [{ label: string; name: ValueSource; value: ValueSource; }, ...{ label: string; name: ValueSource; value: ValueSource }[]]

Defined in: packages/core/src/utils/deriveRuleContext.ts:53

Parameters

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

Returns

[{ label: string; name: ValueSource; value: ValueSource; }, ...{ label: string; name: ValueSource; value: ValueSource }[]]

---

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.