@react-querybuilder/rules-engine

Components

Name	Description
ActionElementRE	-
ConditionBuilder	Default condition editor for RulesEngineBuilder. Analogous to an "if" or "else-if" block.
ConditionBuilderBody	Default body component for ConditionBuilder.
ConditionCascade	Renders a sequential list of if/else-if/else blocks in a rules engine.
ConsequentBuilder	Default consequent editor for RulesEngineBuilder. Analogous to the body of an "if" or "else-if" block.
ConsequentBuilderBody	Default body component for ConsequentBuilder.
ConsequentBuilderHeader	Default header component for ConsequentBuilder.
RulesEngineBuilderHeader	Default header component for RulesEngineBuilder.
ShiftActionsRE	-
ValueSelectorRE	-
RulesEngineBuilder	The rules engine builder component for React.

Props

Name	Description
ActionElementREProps	-
ClassnamesRE	Classnames applied to each component.
ComponentsRE	All subcomponents.
ConditionCascadeProps	Props for ConditionCascade.
ConditionProps	Props for ConditionBuilder.
ConsequentProps	Props for ConsequentBuilder, ConsequentBuilderHeader, and ConsequentBuilderBody.
RulesEngineBuilderHeaderProps	Props for RulesEngineBuilderHeader.
RulesEngineProps	Props for RulesEngineBuilder.
SchemaRE	Configuration options passed in the schema prop from RulesEngineBuilder to each subcomponent.
ShiftActionsREProps	-
TranslationsRE	The shape of the translations prop for RulesEngineBuilder.
ValueSelectorREProps	-
TranslationsFullRE	The full translations interface for RulesEngineBuilder, with all properties required.

Export

Name	Description
FormatRulesEngineOptions	Options object shape for formatRulesEngine.
EvaluationMode	Determines how sibling conditions in a react-querybuilder!RulesEngine RulesEngine relate to one another when exported.
NativePredicate	A compiled antecedent for the "native"/"node-rules" export targets: returns true when the supplied facts satisfy the rule group it was compiled from.
RulesEngineEvaluator	In-process evaluator returned by formatRulesEngine(re, 'native'). Given a facts object, returns the react-querybuilder!Consequent consequents of every condition that fires, in order, honoring the react-querybuilder!RulesEngine.evaluationMode evaluationMode.
RulesEngineExportFormat	Available export formats for formatRulesEngine.
RulesEngineProcessor	Function to produce a result that formatRulesEngine uses when processing a react-querybuilder!RulesEngine RulesEngine or react-querybuilder!RulesEngineIC RulesEngineIC object.
defaultRuleGroupProcessorNative	Default rule group processor for the "native" export format. Compiles a rule group into a NativePredicate that ANDs ("and") or ORs ("or") its child predicates and negates the result when not is set. Invalid/placeholder rules are filtered out exactly as in the other export targets; an empty (or invalid outermost) group compiles to an always-true predicate.
defaultRuleGroupProcessorRulePilot	Default rule group processor for the "rulepilot" export format. Compiles a rule group into a rulepilot Condition: and → { all }, or → { any }, and a negated group (not) is wrapped in { none: [...] } (rulepilot has no not). Invalid/placeholder rules—and rules whose operator rulepilot cannot represent (the rule processor returns null for those)—are filtered out exactly as in the other export targets. An empty nested group is dropped; an empty outermost group compiles to an always-true { all: [] }.
defaultRuleProcessorNative	Default rule processor for the "native" export format. Compiles a single rule into a NativePredicate that evaluates the rule's operator (via nativeOperators) against the fact identified by the rule's field. Unknown operators evaluate to false.
defaultRuleProcessorRulePilot	Default rule processor for the "rulepilot" export format. Compiles a single React Query Builder rule into a rulepilot Constraint (or a small Condition for range/null checks).
defaultRulesEngineProcessorJsonRulesEngine	Default processor for the json-rules-engine export format.
defaultRulesEngineProcessorNative	Default processor for the "native" export format. Returns an in-process RulesEngineEvaluator: a function that, given a facts object, returns the consequents of every condition that fires—in order, honoring the evaluationMode. Antecedents are compiled to predicates with no runtime dependencies.
defaultRulesEngineProcessorNodeRules	Default processor for the "node-rules" export format. Returns an array of live node-rules Rule objects with real condition/consequence functions—ready to pass to new RuleEngine(...) or register(...). Antecedents are compiled to predicates (shared with the "native" target) so evaluation needs no operator registration. Each fired condition's consequent is pushed onto fact.events (mirroring the json-rules-engine result shape).
defaultRulesEngineProcessorRulePilot	Default processor for the "rulepilot" export format. Returns a single rulepilot Rule whose ordered conditions reproduce the rules engine's cascade: each condition pairs a guard (its own antecedent AND-ed with its ancestor antecedents and the negated antecedents of prior siblings) with result: consequent.
jsonRulesEngineAdditionalOperators	Operator evaluators for the React Query Builder operators that have no json-rules-engine built-in equivalent. Register these on an Engine so that rules exported by formatRulesEngine which use these operators can be evaluated—either manually via engine.addOperator(...), or automatically by passing the engine as context.engine to formatRulesEngine.
nativeOperators	Evaluators for every React Query Builder default operator, comparing a fact value against the value stored on a rule. Used by the "native" and "node-rules" export targets to evaluate antecedents in process. Unknown operators evaluate to false.
rulePilotUnsupportedOperators	React Query Builder substring operators that the "rulepilot" export format cannot represent. rulepilot's only string-matching operator, matches, builds the regular expression from the runtime fact and tests it against the rule value (new RegExp(fact).test(value))—the inverse of what these operators require—so there is no faithful mapping. Rules using these operators are skipped (treated as invalid) during export; see defaultRuleGroupProcessorRulePilot.
formatRulesEngine	-
walkRulesEngine	Flattens a react-querybuilder!RulesEngine RulesEngine into an ordered list of guard/consequent pairs, reproducing the if/else-if/else ("cascade") or independent ("cumulative") semantics shared by the runnable export targets.

Defaults

Variable	Description
defaultClassnamesRE	Default classnames used by RulesEngineBuilder.
defaultComponentsRE	Default components used by RulesEngineBuilder.
defaultTranslationsRE	Default configuration of translatable strings for RulesEngineBuilder.
standardClassnamesRE	Standard classnames applied by RulesEngineBuilder.

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.
getFactValue	Looks up path in a fact object. An exact key match wins (so flat keys that literally contain dots still work); otherwise the path is traversed segment-by-segment ("profile.age").
inRange	Determines whether factVal falls within the inclusive range described by compareVal, mirroring the robustness of the "between" handling in formatQuery. The bounds may be supplied as an array ([lo, hi]) or a comma-separated string ("lo,hi"). Numeric bounds are parsed and reordered ascending; non-numeric bounds compare lexicographically in the order given. Returns null when fewer than two valid bounds are present.
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.

Interfaces

Interface	Description
AddMethodRE	-
FlatRule	A flattened rules-engine condition: a single combined guard paired with its consequent.
InsertMethodRE	-
MoveMethodRE	-
PreparerOptionsRE	Options for prepareRulesEngine.
RECondition	A condition within a RulesEngine. Each condition has an antecedent (rule group) and an optional consequent. A condition may also itself contain nested conditions.
REConditionIC	A condition within a RulesEngine. Each condition has an antecedent (rule group) and an optional consequent. A condition may also itself contain nested conditions.
RemoveMethodRE	-
RulesEngine	Rules engine with standard query objects (RuleGroupType). Contains an array of conditions, each with an antecedent (rule group) and an optional consequent. An optional defaultConsequent can be specified that will be used if none of the conditions are met.
RulesEngineIC	Rules engine with "independent combinator" query objects RuleGroupTypeIC). Contains an array of conditions, each with an antecedent (rule group) and an optional consequent. An optional defaultConsequent can be specified that will be used if none of the conditions are met.
UpdateMethodRE	-
WalkPrimitives	Primitives that adapt walkRulesEngine to a particular guard representation G (e.g. a json-rules-engine TopLevelCondition, or a NativePredicate function).

Type Aliases

Type Alias	Description
FindConditionPath	Return type for findConditionPath.
REConditionAny	Either RECondition or REConditionIC.
REConditionCascade	Array of conditions within a RulesEngine or RulesEngineIC.
RulesEngineAny	Either RulesEngine or RulesEngineIC.

Variables

Variable	Description
ConditionBuilderHeader	Default header component for ConditionBuilder.
defaultRuleGroupProcessorJsonRulesEngine	-
defaultRuleProcessorJsonRulesEngine	-
defaultRulesEngine	-
defaultRulesEngineIC	-

Rules Engine

Name	Description
Consequent	-
ConsequentPropertyDef	Definition of a single editable property of a consequent type. Used by the built-in ConsequentBuilderBody to render an appropriate input for each property. Property values are stored on the consequent under params[name].
ConsequentBase	-
ConsequentPropertyInputType	Supported input types for a built-in consequent property editor.
ConsequentTypeOption	A consequent type option that may carry editable property definitions. Pass an array of these as the consequentTypes prop (or from getConsequentTypes) to enable the built-in property editor. Only name (the identifier stored as the consequent's type) and label are required; see FullConsequentTypeOption for the resolved form used internally.
FullConsequentTypeOption	A ConsequentTypeOption resolved to a FullOption (both name and value guaranteed). This is the form passed to subcomponents via the schema.

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 without mutating the original rules engine.
addREInPlace	Adds a rule or group to a query by mutating the rules engine.
insertRE	Inserts a rule engine condition into a rules engine without mutating the original rules engine.
insertREInPlace	Inserts a rule engine condition into a rules engine by mutating the rules engine.
moveRE	Moves a rule engine condition from one path to another without mutating the original rules engine. In the options parameter, pass { clone: true } to copy instead of move.
moveREInPlace	Moves a rule engine condition from one path to another by mutating the rules engine. In the options parameter, pass { clone: true } to copy instead of move.
removeRE	Removes a rule engine condition from a rules engine without mutating the original rules engine.
removeREInPlace	Removes a rule engine condition from a rules engine by mutating the rules engine.
updateRE	Updates a property of a rule or group within a query without mutating the original rules engine.
updateREInPlace	Updates a property of a rule or group within a query by mutating the rules engine.

---

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.