CreateRuleOptions<F extends FullField = FullField>

Defined in: packages/core/src/utils/ruleFactory.ts:17

Everything createRule needs to produce a new rule. Each member corresponds to the QueryBuilder prop (or useQueryBuilderSetup output) of the same name.

Type Parameters

Type Parameter	Default type
F extends FullField	FullField

Properties

fields

fields: FullOptionList<F>

Defined in: packages/core/src/utils/ruleFactory.ts:18

---

getDefaultField?

optional getDefaultField?: string | ((fieldsData: FullOptionList<F>) => string)

Defined in: packages/core/src/utils/ruleFactory.ts:19

---

getMatchModes

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

Defined in: packages/core/src/utils/ruleFactory.ts:29

Produces the match modes for a field.

Parameters

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

Returns

MatchModeOptions

---

getRuleDefaultOperator

getRuleDefaultOperator: (field: string) => string

Defined in: packages/core/src/utils/ruleFactory.ts:21

Produces the default operator for a field, i.e. resolveDefaultOperator already bound.

Parameters

Parameter	Type
field	string

Returns

string

---

getRuleDefaultValue

getRuleDefaultValue: (rule: RuleType) => unknown

Defined in: packages/core/src/utils/ruleFactory.ts:31

Produces the default value for an otherwise-complete rule.

Parameters

Parameter	Type
rule	RuleType

Returns

unknown

---

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/ruleFactory.ts:23

Produces the value sources for a field/operator pair.

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

---

idGenerator?

optional idGenerator?: () => string

Defined in: packages/core/src/utils/ruleFactory.ts:32

Returns

string

---

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.