RulesEngineProps
Defined in: rules-engine/src/types/props.ts:129
Properties
allowDefaultConsequents?
optionalallowDefaultConsequents:boolean
Defined in: rules-engine/src/types/props.ts:151
allowNestedConditions?
optionalallowNestedConditions:boolean
Defined in: rules-engine/src/types/props.ts:152
autoSelectConsequentType?
optionalautoSelectConsequentType:boolean
Defined in: rules-engine/src/types/props.ts:149
classnames?
optionalclassnames:Partial<ClassnamesRE>
Defined in: rules-engine/src/types/props.ts:155
components?
optionalcomponents:Partial<ComponentsRE>
Defined in: rules-engine/src/types/props.ts:154
consequentTypes?
optionalconsequentTypes:FlexibleOptionList<BaseOption<string>>
Defined in: rules-engine/src/types/props.ts:133
defaultRulesEngine?
optionaldefaultRulesEngine:RulesEngine<RuleType<string,string,any,string>,string>
Defined in: rules-engine/src/types/props.ts:131
enableMountRulesEngineChange?
optionalenableMountRulesEngineChange:boolean
Defined in: rules-engine/src/types/props.ts:153
getConsequentTypes()?
optionalgetConsequentTypes: (conditionPath:Path,antecedent:RuleGroupTypeAny,context?:unknown) =>FlexibleOptionListProp<BaseOption<string>> |null
Defined in: rules-engine/src/types/props.ts:134
Parameters
| Parameter | Type |
|---|---|
conditionPath | Path |
antecedent | RuleGroupTypeAny |
context? | unknown |
Returns
FlexibleOptionListProp<BaseOption<string>> | null
idGenerator()?
optionalidGenerator: () =>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()?
optionalonAddCondition: (condition:REConditionAny,parentConditionPath:Path,rulesEngine:RulesEngineAny) =>boolean|REConditionAny
Defined in: rules-engine/src/types/props.ts:139
Parameters
| Parameter | Type |
|---|---|
condition | REConditionAny |
parentConditionPath | Path |
rulesEngine | RulesEngineAny |
Returns
boolean | REConditionAny
onRemoveCondition()?
optionalonRemoveCondition: (condition:REConditionAny,conditionPath:Path,rulesEngine:RulesEngineAny) =>boolean|REConditionAny
Defined in: rules-engine/src/types/props.ts:144
Parameters
| Parameter | Type |
|---|---|
condition | REConditionAny |
conditionPath | Path |
rulesEngine | RulesEngineAny |
Returns
boolean | REConditionAny
onRulesEngineChange()?
optionalonRulesEngineChange: (re:RulesEngine) =>void
Defined in: rules-engine/src/types/props.ts:132
Parameters
| Parameter | Type |
|---|---|
re | RulesEngine |
Returns
void
queryBuilderProps?
optionalqueryBuilderProps: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?
optionalrulesEngine:RulesEngine<RuleType<string,string,any,string>,string>
Defined in: rules-engine/src/types/props.ts:130
suppressStandardClassnames?
optionalsuppressStandardClassnames:boolean
Defined in: rules-engine/src/types/props.ts:150
translations?
optionaltranslations:Partial<TranslationsRE>
Defined in: rules-engine/src/types/props.ts:156
API documentation is generated from the latest commit on the main branch. It may be somewhat inconsistent with official releases of React Query Builder.