@react-querybuilder/core

Props

Name	Description
BaseTranslation	A translation for a component with title only.
BaseTranslations	The shape of the translations prop.
BaseTranslationWithLabel	A translation for a component with title and label.
BaseTranslationWithPlaceholders	A translation for a component with title and a placeholder.
Classnames	Classnames applied to each component.
CommonRuleSubComponentProps	Base interface for all rule subcomponents.
Placeholder	Placeholder strings for option lists.
QueryActions	Functions included in the actions prop passed to every subcomponent.
BaseTranslationsFull	The full translations interface with all properties required.

Export

Name	Description
FormatQueryFinalOptions	Options object curated by formatQuery and passed to a RuleGroupProcessor.
FormatQueryOptions	Options object shape for formatQuery.
ParameterizedNamedSQL	Object produced by formatQuery for the "parameterized_named" format.
ParameterizedSQL	Object produced by formatQuery for the "parameterized" format.
RQBJsonLogicEndsWith	-
RQBJsonLogicStartsWith	-
RQBJsonLogicVar	-
ValueProcessorOptions	Options object for ValueProcessorByRule functions.
ConstituentWordOrder	Constituent word order (as array) for the "natural_language" format.
ConstituentWordOrderString	Constituent word order (as string) for the "natural_language" format.
ExportFormat	Available export formats for formatQuery.
ExportObjectFormats	Export formats for formatQuery that produce objects instead of strings.
ExportOperatorMap	A map of operators to strings to be used in the output of formatQuery. If the result can differ based on the valueSource, the key should map to an array where the second element represents the string to be used when valueSource is "field". The first element will be used in all other cases.
FormatQueryValidateRule	Rule validator for formatQuery.
GroupVariantCondition	Rule group condition identifier for the "natural_language" format.
NLTranslationKey	Keys for the translations config object used by the "natural_language" format.
NLTranslations	translations config object for "natural_language" format.
RQBJsonLogic	JsonLogic rule object with additional operators generated by formatQuery and accepted by parseJsonLogic!parseJsonLogic.
RuleGroupProcessor	Function to produce a result that formatQuery uses when processing a RuleGroupType or RuleGroupTypeIC object.
RuleProcessor	Function to produce a result that formatQuery uses when processing a RuleType object.
SQLPreset	Available presets for the "sql" export format.
ValueProcessor	-
ValueProcessorByRule	Function that produces a processed value for a given RuleType.
ValueProcessorLegacy	Function that produces a processed value for a given field, operator, value, and valueSource.
celCombinatorMap	Maps a DefaultCombinatorName to a CEL combinator.
defaultCELValueProcessor	-
defaultExportOperatorMap	Default operator map used by formatQuery for "natural_language" format.
defaultMongoDBValueProcessor	-
defaultNLTranslations	Default translations used by formatQuery for "natural_language" format.
defaultOperatorProcessorNL	Default operator processor used by formatQuery for "natural_language" format.
defaultOperatorProcessorSQL	Default operator processor used by formatQuery for "sql" and "parameterized*" formats.
defaultRuleGroupProcessorCEL	Rule group processor used by formatQuery for "cel" format.
defaultRuleGroupProcessorDrizzle	Default rule group processor used by formatQuery for the "drizzle" format. The returned function can be assigned to the where property in the Drizzle relational queries API.
defaultRuleGroupProcessorElasticSearch	Rule group processor used by formatQuery for "elasticsearch" format.
defaultRuleGroupProcessorJSONata	Rule group processor used by formatQuery for "jsonata" format.
defaultRuleGroupProcessorJsonLogic	Rule group processor used by formatQuery for "jsonlogic" format.
defaultRuleGroupProcessorLDAP	Rule group processor used by formatQuery for "ldap" format.
defaultRuleGroupProcessorMongoDB	Rule group processor used by formatQuery for "mongodb" format.
defaultRuleGroupProcessorMongoDBQuery	Rule group processor used by formatQuery for "mongodb_query" format.
defaultRuleGroupProcessorNL	Rule group processor used by formatQuery for "natural_language" format.
defaultRuleGroupProcessorParameterized	Rule group processor used by formatQuery for "parameterized" and "parameterized_named" formats.
defaultRuleGroupProcessorPrisma	Rule group processor used by formatQuery for "prisma" format.
defaultRuleGroupProcessorSequelize	Rule group processor used by formatQuery for "sequelize" format.
defaultRuleGroupProcessorSpEL	Default rule processor used by formatQuery for "spel" format.
defaultRuleGroupProcessorSQL	Default rule processor used by formatQuery for "sql" format.
defaultRuleProcessorCEL	Default rule processor used by formatQuery for "cel" format.
defaultRuleProcessorDrizzle	Default rule processor used by formatQuery for the "drizzle" format.
defaultRuleProcessorElasticSearch	Default rule processor used by formatQuery for "elasticsearch" format.
defaultRuleProcessorJSONata	Default rule processor used by formatQuery for "jsonata" format.
defaultRuleProcessorJsonLogic	Default rule processor used by formatQuery for "jsonlogic" format.
defaultRuleProcessorLDAP	Default rule processor used by formatQuery for "ldap" format.
defaultRuleProcessorMongoDB	Default rule processor used by formatQuery for "mongodb" format.
defaultRuleProcessorMongoDBQuery	Default rule processor used by formatQuery for "mongodb_query" format.
defaultRuleProcessorNL	Default rule processor used by formatQuery for "natural_language" format.
defaultRuleProcessorParameterized	Default rule processor used by formatQuery for "parameterized" and "parameterized_named" formats.
defaultRuleProcessorPrisma	Default rule processor used by formatQuery for "prisma" format.
defaultRuleProcessorSequelize	Default rule processor used by formatQuery for the "sequelize" format.
defaultRuleProcessorSpEL	Default rule processor used by formatQuery for "spel" format.
defaultRuleProcessorSQL	Default rule processor used by formatQuery for "sql" format.
defaultSpELValueProcessor	-
defaultValueProcessor	Default value processor used by formatQuery for "sql" format.
defaultValueProcessorByRule	Default value processor used by formatQuery for "sql" format.
defaultValueProcessorCELByRule	-
defaultValueProcessorMongoDBByRule	-
defaultValueProcessorNL	Default value processor used by formatQuery for "natural_language" format.
defaultValueProcessorSpELByRule	-
formatQueryOptionPresets	A collection of option presets for formatQuery.
jsonLogicAdditionalOperators	Register these operators with jsonLogic before applying the result of formatQuery(query, 'jsonlogic').
mongoDbFallback	Default fallback object used by formatQuery for "mongodb_query" format.
mongoOperators	Maps a (lowercase) DefaultOperatorName to a MongoDB operator.
prismaFallback	Default fallback object used by formatQuery for "prisma" format.
prismaOperators	Maps a (lowercase) DefaultOperatorName to a Prisma ORM operator.
sqlDialectPresets	A collection of option presets for formatQuery, specifically for SQL-based formats.
formatQuery	Generates a formatted (indented two spaces) JSON string from a query object.
getNLTranslataion	Used by formatQuery to get a translation based on certain conditions for the "natural_language" format.
getQuotedFieldName	Given a field name and relevant ValueProcessorOptions, returns the field name wrapped in the configured quote character(s).
getQuoteFieldNamesWithArray	Converts the quoteFieldNamesWith option into an array of two strings. If the option is a string, the array elements are both that string.
isValidValue	Determines whether a value is anything except an empty string or NaN.
isValueProcessorLegacy	Used by formatQuery to determine whether the given value processor is a "legacy" value processor by counting the number of arguments. Legacy value processors take 3 arguments (not counting any arguments with default values), while rule-based value processors take no more than 2 arguments.
mapSQLOperator	Maps a DefaultOperatorName to a SQL operator.
normalizeConstituentWordOrder	Given a Constituent word order like "svo" or "sov", returns a permutation of ["S", "V", "O"] based on the first occurrence of each letter in the input string (case insensitive). This widens the valid input from abbreviations like "svo" to more expressive strings like "subject-verb-object" or "sub ver obj". Any missing letters are appended in the default order "SVO" (e.g., "object" would yield ["O", "S", "V"]).
numerifyValues	Converts all string-type value properties of a query object into number where appropriate.
shouldRenderAsNumber	Determines whether formatQuery should render the given value as a number. As long as parseNumbers is true, number and bigint values will return true and string values will return true if they test positive against numericRegex.

Defaults

Variable	Description
defaultCombinators	Default combinator list.
defaultCombinatorsExtended	Default combinator list, with XOR added.
defaultControlClassnames	Default classnames for each component.
defaultJoinChar	Default character used to .join and .split arrays.
defaultMatchModes	Default match modes.
defaultOperatorNegationMap	Map of default operators to their respective opposite/negating operators.
defaultOperators	Default operator list.
defaultPlaceholderFieldGroupLabel	Default label for placeholder option group in the fields array.
defaultPlaceholderFieldLabel	Default label for placeholder option in the fields array.
defaultPlaceholderFieldName	Default name for placeholder option in the fields array.
defaultPlaceholderLabel	-
defaultPlaceholderName	-
defaultPlaceholderOperatorGroupLabel	Default label for placeholder option group in the operators array.
defaultPlaceholderOperatorLabel	Default label for placeholder option in the operators array.
defaultPlaceholderOperatorName	Default name for placeholder option in the operators array.
defaultPlaceholderValueGroupLabel	Default label for placeholder option group in the values array.
defaultPlaceholderValueLabel	Default label for placeholder option in the values array.
defaultPlaceholderValueName	Default name for placeholder option in the values array.
defaultTranslations	Default configuration of translatable strings.
groupInvalidReasons	Default reason codes for a group being invalid.
rootPath	The Path of the root group.
standardClassnames	Standard classnames applied to each component.
TestID	Component identifiers for testing.

Option Lists

Name	Description
BaseOption	Do not use this type directly; use Option, ValueOption, or FullOption instead. For specific option types, you can use FullField, FullOperator, or FullCombinator, all of which extend FullOption.
FullOperator	Full operator definition used in the operators/getOperators props of QueryBuilder. This type requires both name and value, but the operators/getOperators props themselves can use a FlexibleOption where only one of name or value is required, or FullOperator where only name is required.
OptionGroup	A group of Options, usually within an OptionList.
BaseFullOption	This type is identical to FullOption but without the unknown index property. Extend from this type instead of FullOption directly.
BaseOptionMap	Map of option identifiers to their respective Option.
Combinator	Combinator definition used in the combinators prop of QueryBuilder. This type is an extension of FullCombinator where only name and label are required.
CombinatorByValue	Combinator definition used in the combinators prop of QueryBuilder. This type is an extension of FullCombinator where only value and label are required.
DefaultCombinator	A FullCombinator definition with a DefaultCombinatorName name property.
DefaultCombinatorExtended	A FullCombinator definition with a DefaultCombinatorNameExtended name property.
DefaultCombinatorName	Default allowed values for the combinator property.
DefaultCombinatorNameExtended	Default allowed values for the combinator property, plus "xor".
DefaultOperator	An FullOperator definition with a DefaultOperatorName name property.
DefaultOperatorName	Default values for the operator property.
Field	Field definition used in the fields prop of QueryBuilder. This type is an extension of FullField where only name and label are required.
FieldByValue	Field definition used in the fields prop of QueryBuilder. This type is an extension of FullField where only value and label are required.
FlexibleOption	A generic Option with either a name or value as its primary identifier. OptionList-type props on the QueryBuilder component accept this type, but corresponding props passed down to subcomponents will always be translated to FullOption first.
FlexibleOptionGroup	A group of BaseOptions, usually within a FlexibleOptionList.
FlexibleOptionList	An array of options or option groups, like OptionList but the option type may use either name or value as the primary identifier.
FlexibleOptionListProp	An array of options or option groups, like OptionList but the option type may use either name or value as the primary identifier.
FullCombinator	Full combinator definition used in the combinators prop of QueryBuilder. This type requires both name and value, but the combinators prop itself can use a FlexibleOption where only one of name or value is required, or Combinator where only name is required.
FullField	Full field definition used in the fields prop of QueryBuilder. This type requires both name and value, but the fields prop itself can use a FlexibleOption where only one of name or value is required (along with label), or Field where only name and label are required.
FullOption	A generic Option requiring both name and value properties. Props that extend OptionList accept BaseOption, but corresponding props sent to subcomponents will always be translated to this type first to ensure both name and value are available.
FullOptionList	An array of options or option groups, like OptionList, but using FullOption instead of Option. This means that every member is guaranteed to have both name and value.
FullOptionMap	Map of option identifiers to their respective FullOption.
FullOptionRecord	Map of option identifiers to their respective FullOption. Must include all possible strings from the identifier type.
GetOptionIdentifierType	Extracts the type of the identifying property from a Option, ValueOption, or FullOption.
GetOptionType	Extracts the Option type from a FlexibleOptionList.
NameLabelPair	-
Operator	Operator definition used in the operators/getOperators props of QueryBuilder. This type is an extension of FullOperator where only name and label are required.
OperatorByValue	Operator definition used in the operators/getOperators props of QueryBuilder. This type is an extension of FullOperator where only value and label are required.
Option	A generic option. Used directly in OptionList or as the child element of an OptionGroup.
OptionList	Either an array of Options or an array of OptionGroups.
ToFlexibleOption	Utility type to turn an Option, ValueOption, or BaseOption into a FlexibleOption.
ToFullOption	Utility type to turn an Option, ValueOption or BaseOption into a FullOption.
ValueOption	Like Option but requiring value instead of name.
filterFieldsByComparator	For a given FullField, returns the fields list filtered for other fields that match by comparator. Only fields other than the one in question will ever be included, even if comparator is null or undefined. If comparator is a string, fields with the same value for that property will be included. If comparator is a function, each field will be passed to the function along with the operator and fields for which the function returns true will be included.
getFirstOption	Gets the first option from an OptionList.
getOption	Gets the option from an OptionList with the given name. Handles Option arrays as well as OptionGroup arrays.
isFlexibleOptionArray	Determines if an array is a flat array of FlexibleOption.
isFlexibleOptionGroupArray	Determines if a FlexibleOptionList is a FlexibleOptionGroup array.
isFullOptionArray	Determines if an array is a flat array of FullOption.
isFullOptionGroupArray	Determines if a FlexibleOptionList is a OptionGroup array of FullOption.
isOptionGroupArray	Determines if an OptionList is an OptionGroup array.
toFlatOptionArray	Flattens FlexibleOptionGroup arrays into BaseOption arrays. If the array is already flat, it is returned as is.
toFullOption	Converts an Option or ValueOption (i.e., BaseOption) into a FullOption. Full options are left unchanged.
toFullOptionList	Converts an OptionList or FlexibleOptionList into a FullOptionList. Lists of full options are left unchanged.
toFullOptionMap	Converts a FlexibleOptionList into a FullOptionList. Lists of full options are left unchanged.
uniqByIdentifier	Generates a new array of objects with duplicates removed based on the identifying property (value or name)
uniqByName	-
uniqOptGroups	Generates a new OptionGroup array with duplicates removed based on the identifying property (value or name).
uniqOptList	Generates a new Option or OptionGroup array with duplicates removed based on the identifier property (value or name).

Query Tools

Name	Description
AddOptions	Options for add.
GroupOptions	Options for group.
InsertOptions	Options for insert.
MoveOptions	Options for move.
UpdateOptions	Options for update.
add	Adds a rule or group to a query.
convertFromIC	Converts a RuleGroupTypeIC to RuleGroupType.
convertQuery	Converts a RuleGroupType to RuleGroupTypeIC. For a more explicit operation, use convertToIC.
convertToIC	Converts a RuleGroupType to RuleGroupTypeIC.
group	Creates a new group at a target path with its rules array containing the current objects at the target path and the source path. In the options parameter, pass { clone: true } to copy the source rule/group instead of move.
insert	Inserts a rule or group into a query.
move	Moves a rule or group from one path to another. In the options parameter, pass { clone: true } to copy instead of move.
remove	Removes a rule or group from a query.
update	Updates a property of a rule or group within a query.

Functions

Function	Description
bigIntJsonParseReviver	"Reviver" method for JSON.parse's second argument. Converts objects having a single $bigint: string property to an actual bigint value.
bigIntJsonStringifyReplacer	"Replacer" method for JSON.stringify's second argument. Converts bigint values to objects with a $bigint property having a value of a string representation of the actual bigint-type value.
clsx	Vendored/adapted version of the clsx package.
findID	Returns the RuleType or RuleGroupType/RuleGroupTypeIC with the given id within a query.
findPath	Returns the RuleType or RuleGroupType/RuleGroupTypeIC at the given path within a query.
generateID	Default id generator. Generates a valid v4 UUID. Uses crypto.randomUUID() when available, otherwise uses an alternate method based on getRandomValues. The returned string is guaranteed to match this regex: /^[0-9A-F]{8}-[0-9A-F]{4}-4[0-9A-F]{3}-[89AB][0-9A-F]{3}-[0-9A-F]{12}$/i
getCommonAncestorPath	Finds the deepest/longest path that two paths have in common.
getMatchModesUtil	Utility function to get the match modes array for the given field. If the field definition does not define a matchModes property, the getMatchModes prop is used. Returns FullOption<MatchMode>[] of all match modes by default.
getParentPath	Truncates the last element of an array and returns the result as a new array.
getParseNumberMethod	-
getPathOfID	Returns the Path of the RuleType or RuleGroupType/RuleGroupTypeIC with the given id within a query.
getValidationClassNames	Gets the standard classname for valid or invalid components based on the given validation result.
getValueSourcesUtil	Utility function to get the value sources array for the given field and operator. If the field definition does not define a valueSources property, the getValueSources prop is used. Returns [FullOption<"value">] by default.
isAncestor	Determines if the first path is an ancestor of the second path. The first path must be shorter and exactly match the second path up through the length of the first path.
isPojo	Determines if a variable is a plain old JavaScript object, aka POJO.
isRuleGroup	Determines if an object is a RuleGroupType or RuleGroupTypeIC.
isRuleGroupType	Determines if an object is a RuleGroupType.
isRuleGroupTypeIC	Determines if an object is a RuleGroupTypeIC.
isRuleOrGroupValid	Determines if a rule or group is valid based on a validation result (if defined) or a validator function. Returns true if neither are defined.
isRuleType	Determines if an object is a RuleType (only checks for a field property).
isValidationResult	Determines if an object is useful as a validation result.
joinWith	Joins an array of strings using the given character (see defaultJoinChar). When the given character appears in an array element, a backslash will be added just before it to distinguish it from the join character. Effectively the inverse of splitBy.
lc	Converts a value to lowercase if it's a string, otherwise returns the value as is.
mergeAnyTranslation	-
mergeAnyTranslations	Merges any number of partial translations into a single definition.
mergeClassnames	Merges a list of partial Classnames definitions into a single definition.
nullFreeArray	Determines if an array is free of null/undefined.
nullOrUndefinedOrEmpty	Simple helper to determine whether a value is null, undefined, or an empty string.
parseNumber	Converts a string to a number. Uses native parseFloat if parseNumbers is "native", otherwise uses numeric-quantity. If that returns NaN, the string is returned unchanged. Numeric values are returned as-is regardless of the parseNumbers option.
pathIsDisabled	Determines if the rule or group at the specified path is either disabled itself or disabled by an ancestor group.
pathsAreEqual	Determines if two paths (each Path) are equivalent.
prepareOptionList	-
prepareRule	Ensures that a rule is valid by adding an id property if it does not already exist.
prepareRuleGroup	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.
prepareRuleOrGroup	Ensures that a rule or group is valid. See prepareRule and prepareRuleGroup.
processMatchMode	-
regenerateID	Generates a new id property for a rule.
regenerateIDs	Recursively generates new id properties for a rule group and all its rules and subgroups.
splitBy	Splits a string by a given character (see defaultJoinChar). Escaped characters (characters preceded by a backslash) will not apply to the split, and the backslash will be removed in the array element. Inverse of joinWith.
toArray	Splits a string by comma then trims each element. Arrays are returned as is except any string elements are trimmed.
transformQuery	Recursively process a query heirarchy using this versatile utility function.
trimIfString	Trims the value if it is a string. Otherwise returns the value as is.

Interfaces

Interface	Description
CommonRuleAndGroupProperties	Properties common to both rules and groups.
DefaultRuleGroupTypeIC	RuleGroupTypeIC with combinators limited to DefaultCombinatorName and rules limited to DefaultRuleType.
DragCollection	-
DropCollection	-
DropResult	-
MatchConfig	Quantification mode describing how many elements of the value array must pass the filter for the rule itself to pass.
ParseNumberOptions	Options object for parseNumber.
PreparedOptionList	-
PrepareOptionListParams	-
PreparerOptions	Options for prepareRule/prepareRuleGroup.
RegenerateIdOptions	Options object for regenerateID/regenerateIDs.
RuleGroupType	The main rule group type. This type is used for query definitions as well as all sub-groups of queries.
RuleGroupTypeIC	The main rule group interface when using independent combinators. This type is used for query definitions as well as all sub-groups of queries.
RuleType	The main rule type. The field, operator, and value properties can be narrowed with generics.
TransformQueryOptions	Options object for index!transformQuery transformQuery.
ValidationResult	Object with a valid boolean value and optional reasons.

Type Aliases

Type Alias	Description
AccessibleDescriptionGenerator	Signature of accessibleDescriptionGenerator prop, used by QueryBuilder to generate accessible descriptions for each RuleGroup.
ActionElementEventHandler	-
Arity	Allowed values of the FullOperator property arity. A value of "unary" or a number less than two will cause the default ValueEditor to render null.
Classname	String of classnames, array of classname strings, or object where the keys are classnames and those with truthy values will be included. Suitable for passing to the clsx package.
DefaultCombinators	-
DefaultCombinatorsExtended	-
DefaultMatchModes	-
DefaultOperators	-
DefaultRuleGroupArray	The type of the rules array in a DefaultRuleGroupType.
DefaultRuleGroupICArray	The type of the rules array in a DefaultRuleGroupTypeIC.
DefaultRuleGroupType	RuleGroupType with the combinator property limited to DefaultCombinatorNameExtended and rules limited to DefaultRuleType.
DefaultRuleGroupTypeAny	Shorthand for "either DefaultRuleGroupType or DefaultRuleGroupTypeIC".
DefaultRuleOrGroupArray	Shorthand for "either DefaultRuleGroupArray or DefaultRuleGroupICArray".
DefaultRuleType	RuleType with the operator property limited to DefaultOperatorName.
DndDropTargetType	-
DraggedItem	-
DropEffect	-
FindPathReturnType	Return type for findPath.
GenericizeRuleGroupType	Converts a narrowed rule group type to its most generic form.
GetRuleGroupType	Determines if a type extending RuleGroupTypeAny is actually RuleGroupType or RuleGroupTypeIC.
GetRuleTypeFromGroupWithFieldAndOperator	Determines the RuleType of a given RuleGroupType or RuleGroupTypeIC. If the field and operator name types of the rule type extend the identifier types of the provided Field and Operator types, the given rule type is returned as is. Otherwise, the rule type has its field and operator types narrowed to the identifier types of the provided Field and Operator types.
InputType	HTML5 input types
JsonLogicAll	-
JsonLogicAnd	-
JsonLogicDoubleNegation	-
JsonLogicEqual	-
JsonLogicGreaterThan	-
JsonLogicGreaterThanOrEqual	-
JsonLogicInArray	-
JsonLogicInString	-
JsonLogicLessThan	-
JsonLogicLessThanOrEqual	-
JsonLogicNegation	-
JsonLogicNone	-
JsonLogicNotEqual	-
JsonLogicOr	-
JsonLogicReservedOperations	-
JsonLogicRulesLogic	-
JsonLogicSome	-
JsonLogicStrictEqual	-
JsonLogicStrictNotEqual	-
JsonLogicVar	-
MatchMode	-
MatchModeOptions	-
ParseNumberMethod	Parsing algorithms used by parseNumber.
ParseNumbersPropConfig	Options for the parseNumbers prop of QueryBuilder.
Path	-
QueryValidator	Function that validates a query.
RemoveNullability	Utility type to make all properties non-nullable.
RuleGroupArray	The type of the rules array in a RuleGroupType.
RuleGroupICArray	The type of the rules array in a RuleGroupTypeIC.
RuleGroupTypeAny	Shorthand for "either RuleGroupType or RuleGroupTypeIC".
RuleOrGroupArray	Shorthand for "either RuleGroupArray or RuleGroupICArray".
RuleValidator	Function that validates a rule.
StringUnionToFlexibleOptionArray	-
StringUnionToFullOptionArray	-
UpdateableProperties	All updateable properties of rules and groups (everything except id, path, and rules).
ValidationMap	Map of rule/group id to its respective ValidationResult.
ValueChangeEventHandler	-
ValueEditorType	Type of ValueEditor that will be displayed.
ValueSource	A source for the value property of a rule.
ValueSourceFlexibleOptions	-
ValueSourceFullOptions	-
ValueSources	A valid array of potential value sources.
WithRequired	Utility type to make one or more properties required.
WithUnknownIndex	Adds an unknown index property to an interface.

Variables

Variable	Description
defaultCombinatorLabelMap	-
defaultOperatorLabelMap	-
defaultValidator	This is an example validation function you can pass to QueryBuilder in the validator prop. It assumes that you want to validate groups, and has a no-op for validating rules which you can replace with your own implementation.
generateAccessibleDescription	-
LogType	-
numericRegex	Regex matching numeric strings. Passes for positive/negative integers, decimals, and E notation, with optional surrounding whitespace.
objectEntries	A strongly-typed version of Object.entries().
objectKeys	A strongly-typed version of Object.keys().

---

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.