ParseCELOptions

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

Options object for parseCEL!parseCEL.

Extends

• ParserCommonOptions

Properties

fields?

optional fields: OptionList<{ [key: string]: unknown; className: Classname | undefined; comparator: string | (f: { [key: string]: unknown; className: Classname | undefined; comparator: string | ((f: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; ... 9 more ...; cl...; defaultOperator: string; defaultValue: any; disabled: boolean; id: string; inputType: InputType | null | undefined; label: string; name: string; operators: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; placeholder: string; validator: RuleValidator; value: string; valueEditorType: ValueEditorType | ((operator: string) => ValueEditorType) | undefined; values: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; valueSources: ValueSources | ((operator: string) => ValueSources) | undefined; }, operator: string) => boolean; defaultOperator: string; defaultValue: any; disabled: boolean; id: string; inputType: InputType | null | undefined; label: string; name: string; operators: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; placeholder: string; validator: RuleValidator; value: string; valueEditorType: ValueEditorType | ((operator: string) => ValueEditorType) | undefined; values: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; valueSources: ValueSources | ((operator: string) => ValueSources) | undefined; }> | Record<string, { [key: string]: unknown; className: Classname | undefined; comparator: string | (f: { [key: string]: unknown; className: Classname | undefined; comparator: string | ((f: { [x: string]: unknown; label: string; disabled?: boolean | undefined; name: string; value: string; id?: string | undefined; operators?: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; ... 9 more ...; cl...; defaultOperator: string; defaultValue: any; disabled: boolean; id: string; inputType: InputType | null | undefined; label: string; name: string; operators: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; placeholder: string; validator: RuleValidator; value: string; valueEditorType: ValueEditorType | ((operator: string) => ValueEditorType) | undefined; values: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; valueSources: ValueSources | ((operator: string) => ValueSources) | undefined; }, operator: string) => boolean; defaultOperator: string; defaultValue: any; disabled: boolean; id: string; inputType: InputType | null | undefined; label: string; name: string; operators: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; placeholder: string; validator: RuleValidator; value: string; valueEditorType: ValueEditorType | ((operator: string) => ValueEditorType) | undefined; values: FlexibleOptionList<{ [x: string]: unknown; value?: string | undefined; label: string; disabled?: boolean | undefined; name: string; }> | undefined; valueSources: ValueSources | ((operator: string) => ValueSources) | undefined; }>

Defined in: packages/react-querybuilder/src/types/importExport.ts:351

Inherited from

ParserCommonOptions.fields

---

generateIDs?

optional generateIDs: boolean

Defined in: packages/react-querybuilder/src/types/importExport.ts:361

When true, a unique id will be generated for each rule and group in the query.

Inherited from

ParserCommonOptions.generateIDs

---

getValueSources()?

optional getValueSources: (field: string, operator: string) => ValueSources

Defined in: packages/react-querybuilder/src/types/importExport.ts:352

Parameters

Parameter	Type
field	string
operator	string

Returns

ValueSources

Inherited from

ParserCommonOptions.getValueSources

---

independentCombinators?

optional independentCombinators: boolean

Defined in: packages/react-querybuilder/src/types/importExport.ts:357

When true, the generated query will use independent combinators (RuleGroupTypeIC).

Inherited from

ParserCommonOptions.independentCombinators

---

listsAsArrays?

optional listsAsArrays: boolean

Defined in: packages/react-querybuilder/src/types/importExport.ts:353

Inherited from

ParserCommonOptions.listsAsArrays

---

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.