@react-querybuilder/rules-engine

Props

Name	Description
TranslationsRE	The shape of the translations prop for RulesEngineBuilder.
TranslationsFullRE	The full translations interface for RulesEngineBuilder, with all properties required.

Functions

Function	Description
findConditionID	Returns the RuleGroupType/RuleGroupTypeIC with the given id within a rules engine.
findConditionPath	Returns the RuleGroupType/RuleGroupTypeIC at the given path within a rules engine.
getConditionPathOfID	Returns the Path of the RuleGroupType/RuleGroupTypeIC with the given id within a rules engine.
isRulesEngine	Determines if an object is a RulesEngine.
isRulesEngineAny	Determines if an object is a RulesEngine or RulesEngineIC.
isRulesEngineCondition	Determines if an object is a RulesEngineAntecedent.
isRulesEngineConditionAny	Determines if an object is a RulesEngineAntecedent or REConditionIC.
isRulesEngineConditionIC	Determines if an object is a REConditionIC.
isRulesEngineConsequent	Determines if an object is a RulesEngine or RulesEngineIC.
isRulesEngineIC	Determines if an object is a RulesEngineIC.
mergeClassnamesRE	Merges a list of partial ClassnamesRE definitions into a single definition.
prepareRulesEngine	Ensures that a rule group is valid by recursively adding an id property to the group itself and all its rules and subgroups where one does not already exist.
prepareRulesEngineCondition	-
regenerateREIDs	Recursively generates new id properties for a rule group or rules engine and all its rules/conditions and subgroups/subconditions.
RulesEngineBuilder	-

Interfaces

Interface	Description
ActionElementREProps	-
ClassnamesRE	-
ComponentsRE	-
ConditionCascadeProps	-
ConditionProps	-
Consequent	-
ConsequentProps	-
FormatRulesEngineOptions	-
PreparerOptionsRE	Options for prepareRulesEngine.
RECondition	Properties common to both rules and groups.
REConditionIC	Properties common to both rules and groups.
RulesEngine	Properties common to both rules and groups.
RulesEngineBuilderHeaderProps	-
RulesEngineIC	Properties common to both rules and groups.
RulesEngineProps	-
SchemaRE	-
ValueSelectorREProps	-

Type Aliases

Type Alias	Description
ConsequentBase	-
FindConditionPath	Return type for findConditionPath.
REConditionAny	-
REConditionCascade	-
RulesEngineAny	-
RulesEngineExportFormat	-
RulesEngineProcessor	-

Variables

Variable	Description
ActionElementRE	-
ConditionBuilderHeader	Default header component for RulesEngineConditionBuilder.
ConsequentBuilder	Analogous to the body of an "if" or "else-if" block.
ConsequentBuilderBody	Default body component for ConsequentBuilder.
ConsequentBuilderHeader	Default header component for ConsequentBuilder.
defaultComponentsRE	-
RulesEngineBuilderHeader	-
RulesEngineConditionBuilder	Analogous to an "if" or "else-if" block.
RulesEngineConditionBuilderBody	Default body component for RulesEngineConditionBuilder.
RulesEngineConditionCascade	Renders a sequential list of if/else-if/else blocks in a rules engine.
ValueSelectorRE	-

Rules Engine Tools

Name	Description
AddOptionsRE	Options for addRE.
InsertOptionsRE	Options for insertRE.
MoveOptionsRE	Options for moveRE.
UpdateOptionsRE	Options for updateRE.
addRE	Adds a rule or group to a query.
insertRE	Inserts a rule engine condition into a rules engine.
moveRE	Moves a rule engine condition from one path to another. In the options parameter, pass { clone: true } to copy instead of move.
removeRE	Removes a rule engine condition from a rules engine.
updateRE	Updates a property of a rule or group within a query.

---

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.