RulesEngineProps

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

Props for RulesEngineBuilder.

Properties

allowDefaultConsequents?

optional allowDefaultConsequents?: boolean

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

---

allowNestedConditions?

optional allowNestedConditions?: boolean

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

---

autoSelectConsequentType?

optional autoSelectConsequentType?: boolean

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

---

classnames?

optional classnames?: Partial<ClassnamesRE>

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

---

components?

optional components?: Partial<ComponentsRE>

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

---

consequentTypes?

optional consequentTypes?: FlexibleOptionList<BaseOption<string>>

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

---

defaultRulesEngine?

optional defaultRulesEngine?: RulesEngine<RuleType<string, string, any, string, Record<string, any>>, string>

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

---

enableMountRulesEngineChange?

optional enableMountRulesEngineChange?: boolean

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

---

getConsequentTypes?

optional getConsequentTypes?: (conditionPath: Path, antecedent: RuleGroupTypeAny, context?: unknown) => FlexibleOptionListProp<BaseOption<string>> | null

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

Parameters

Parameter	Type
conditionPath	Path
antecedent	RuleGroupTypeAny
context?	unknown

Returns

FlexibleOptionListProp<BaseOption<string>> | null

---

idGenerator?

optional idGenerator?: () => string

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

id generator function. Should always produce a unique/random string.

Returns

string

Default

crypto.randomUUID

---

onAddCondition?

optional onAddCondition?: (condition: REConditionAny, parentConditionPath: Path, rulesEngine: RulesEngineAny) => boolean | REConditionAny

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

Parameters

Parameter	Type
condition	REConditionAny
parentConditionPath	Path
rulesEngine	RulesEngineAny

Returns

boolean | REConditionAny

---

onRemoveCondition?

optional onRemoveCondition?: (condition: REConditionAny, conditionPath: Path, rulesEngine: RulesEngineAny) => boolean | REConditionAny

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

Parameters

Parameter	Type
condition	REConditionAny
conditionPath	Path
rulesEngine	RulesEngineAny

Returns

boolean | REConditionAny

---

onRulesEngineChange?

optional onRulesEngineChange?: (re: RulesEngine) => void

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

Parameters

Parameter	Type
re	RulesEngine

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

---

rulesEngine?

optional rulesEngine?: RulesEngine<RuleType<string, string, any, string, Record<string, any>>, string>

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

---

suppressStandardClassnames?

optional suppressStandardClassnames?: boolean

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

---

translations?

optional translations?: Partial<TranslationsRE>

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

---

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.