SchemaRE

Defined in: rules-engine/src/types/props.ts:30

Configuration options passed in the schema prop from RulesEngineBuilder to each subcomponent.

Properties

addCondition()

addCondition: (parentConditionPath: Path, condition?: REConditionAny) => void

Defined in: rules-engine/src/types/props.ts:46

Parameters

Parameter	Type
parentConditionPath	Path
condition?	REConditionAny

Returns

void

---

allowDefaultConsequents

allowDefaultConsequents: boolean

Defined in: rules-engine/src/types/props.ts:37

---

allowNestedConditions

allowNestedConditions: boolean

Defined in: rules-engine/src/types/props.ts:38

---

autoSelectConsequentType

autoSelectConsequentType: boolean

Defined in: rules-engine/src/types/props.ts:35

---

classnames

classnames: ClassnamesRE

Defined in: rules-engine/src/types/props.ts:33

---

components

components: ComponentsRE

Defined in: rules-engine/src/types/props.ts:32

---

consequentTypes

consequentTypes: WithUnknownIndex<BaseOption<string> & {[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>[] | OptionGroup<WithUnknownIndex<BaseOption<string> & {[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>>[]

Defined in: rules-engine/src/types/props.ts:34

---

defaultConsequentType

defaultConsequentType: {[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }

Defined in: rules-engine/src/types/props.ts:49

Index Signature

[key: string]: unknown

disabled?

optional disabled: boolean

label

label: string

name

name: string

value

value: string

---

dispatchRulesEngine()

dispatchRulesEngine: (re: RulesEngineAny) => void

Defined in: rules-engine/src/types/props.ts:45

Parameters

Parameter	Type
re	RulesEngineAny

Returns

void

---

getConsequentTypes()

getConsequentTypes: (conditionPath: Path, antecedent: RuleGroupTypeAny, context?: unknown) => WithUnknownIndex<BaseOption<string> & {[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>[] | OptionGroup<WithUnknownIndex<BaseOption<string> & {[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>>[]

Defined in: rules-engine/src/types/props.ts:50

Parameters

Parameter	Type
conditionPath	Path
antecedent	RuleGroupTypeAny
context?	unknown

Returns

WithUnknownIndex<BaseOption<string> & {[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>[] | OptionGroup<WithUnknownIndex<BaseOption<string> & {[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>>[]

---

getRulesEngine()

getRulesEngine: () => RulesEngineAny

Defined in: rules-engine/src/types/props.ts:44

Returns

RulesEngineAny

---

queryBuilderProps?

optional queryBuilderProps: Except<QueryBuilderProps<RuleGroupTypeAny, {[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }, {[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }, {[key: string]: unknown; disabled?: boolean; label: string; name: string; value: string; }>, "query" | "onQueryChange">

Defined in: rules-engine/src/types/props.ts:40

---

reId

reId: string

Defined in: rules-engine/src/types/props.ts:31

---

removeCondition()

removeCondition: (conditionPath: Path) => void

Defined in: rules-engine/src/types/props.ts:47

Parameters

Parameter	Type
conditionPath	Path

Returns

void

---

suppressStandardClassnames

suppressStandardClassnames: boolean

Defined in: rules-engine/src/types/props.ts:36

---

translations

translations: TranslationsFullRE

Defined in: rules-engine/src/types/props.ts:39

---

updateCondition()

updateCondition: (conditionPath: Path, property: string, value: unknown) => void

Defined in: rules-engine/src/types/props.ts:48

Parameters

Parameter	Type
conditionPath	Path
property	string
value	unknown

Returns

void

---

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.