GetRuleDefaultValueOptions<F extends FullField = FullField>

Defined in: packages/core/src/utils/getRuleDefaultValue.ts:33

Options for getRuleDefaultValue.

Type Parameters

Type Parameter	Default type
F extends FullField	FullField

Properties

fieldData

fieldData: F

Defined in: packages/core/src/utils/getRuleDefaultValue.ts:35

Resolved field configuration for rule.field (e.g. fieldMap[rule.field] ?? {}).

---

fields

fields: FullOptionList<F>

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

Full field list, used to seed a comparator-valid field when valueSource is 'field'.

---

getDefaultValue?

optional getDefaultValue?: (rule: RuleType, meta: { fieldData: F; }) => unknown

Defined in: packages/core/src/utils/getRuleDefaultValue.ts:43

Optional escape hatch overriding the computed default.

Parameters

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

Returns

unknown

---

getParameters?

optional getParameters?: (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; }>>[] | null

Defined in: packages/core/src/utils/getRuleDefaultValue.ts:45

Named parameter options, used to seed a default when valueSource is 'parameter'.

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

---

getValueEditorType

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

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

Resolves the editor type for the field/operator (drives select/radio/checkbox defaults).

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/core/src/utils/getRuleDefaultValue.ts:41

Resolves the value option list for the field/operator.

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

---

listsAsArrays?

optional listsAsArrays?: boolean

Defined in: packages/core/src/utils/getRuleDefaultValue.ts:51

When true, multi-value defaults are arrays instead of comma-joined strings.

---

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.