SchemaRE

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

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:55

Parameters

Parameter	Type
parentConditionPath	Path
condition?	REConditionAny

Returns

void

---

allowDefaultConsequents

allowDefaultConsequents: boolean

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

---

allowNestedConditions

allowNestedConditions: boolean

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

---

autoSelectConsequentType

autoSelectConsequentType: boolean

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

---

classnames

classnames: ClassnamesRE

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

---

components

components: ComponentsRE

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

---

consequentTypes

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

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

---

defaultConsequentType

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

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

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:54

Parameters

Parameter	Type
re	RulesEngineAny

Returns

void

---

evaluationMode

evaluationMode: EvaluationMode

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

---

getConsequentTypes

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

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

Parameters

Parameter	Type
conditionPath	Path
antecedent	RuleGroupTypeAny
context?	unknown

Returns

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

---

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

---

getDefaultConsequentType

getDefaultConsequentType: (conditionPath: Path, antecedent: RuleGroupTypeAny, context?: unknown) => string

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

Parameters

Parameter	Type
conditionPath	Path
antecedent	RuleGroupTypeAny
context?	unknown

Returns

string

---

getRulesEngine

getRulesEngine: () => RulesEngineAny

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

Returns

RulesEngineAny

---

moveCondition

moveCondition: (conditionPath: Path, direction: "up" | "down") => void

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

Parameters

Parameter	Type
conditionPath	Path
direction	"up" | "down"

Returns

void

---

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:49

---

reId

reId: string

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

---

removeCondition

removeCondition: (conditionPath: Path) => void

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

Parameters

Parameter	Type
conditionPath	Path

Returns

void

---

showShiftActions

showShiftActions: boolean

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

---

suppressStandardClassnames

suppressStandardClassnames: boolean

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

---

translations

translations: TranslationsFullRE

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

---

updateCondition

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

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

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.