Skip to main content

RulesEngineProps

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

Properties

allowDefaultConsequents?

optional allowDefaultConsequents: boolean

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


allowNestedConditions?

optional allowNestedConditions: boolean

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


autoSelectConsequentType?

optional autoSelectConsequentType: boolean

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


classnames?

optional classnames: Partial<ClassnamesRE>

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


components?

optional components: Partial<ComponentsRE>

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


consequentTypes?

optional consequentTypes: FlexibleOptionList<BaseOption<string>>

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


defaultRulesEngine?

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

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


enableMountRulesEngineChange?

optional enableMountRulesEngineChange: boolean

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


getConsequentTypes()?

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

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

Parameters

ParameterType
conditionPathPath
antecedentRuleGroupTypeAny
context?unknown

Returns

FlexibleOptionListProp<BaseOption<string>> | null


idGenerator()?

optional idGenerator: () => string

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

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

Parameters

ParameterType
conditionREConditionAny
parentConditionPathPath
rulesEngineRulesEngineAny

Returns

boolean | REConditionAny


onRemoveCondition()?

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

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

Parameters

ParameterType
conditionREConditionAny
conditionPathPath
rulesEngineRulesEngineAny

Returns

boolean | REConditionAny


onRulesEngineChange()?

optional onRulesEngineChange: (re: RulesEngine) => void

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

Parameters

ParameterType
reRulesEngine

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


rulesEngine?

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

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


suppressStandardClassnames?

optional suppressStandardClassnames: boolean

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


translations?

optional translations: Partial<TranslationsRE>

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


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.