Skip to main content

useDeprecatedProps()

Call Signature

useDeprecatedProps(type: "independentCombinators", logWarning: boolean, otherParams: "invalid" | "unnecessary"): void

Logs an error to the console if any of the following are true:

  • QueryBuilder is rendered with an independentCombinators prop
  • RuleGroup is rendered with combinator or rules props (deprecated in favor of ruleGroup)
  • Rule is rendered with field, operator, or value props (deprecated in favor of rule)

Parameters

ParameterType
type"independentCombinators"
logWarningboolean
otherParams"invalid" | "unnecessary"

Returns

void

Defined in

packages/react-querybuilder/src/hooks/useDeprecatedProps.ts:10

Call Signature

useDeprecatedProps(type: "ruleGroup" | "rule", logWarning: boolean): void

Logs an error to the console if any of the following are true:

  • QueryBuilder is rendered with an independentCombinators prop
  • RuleGroup is rendered with combinator or rules props (deprecated in favor of ruleGroup)
  • Rule is rendered with field, operator, or value props (deprecated in favor of rule)

Parameters

ParameterType
type"ruleGroup" | "rule"
logWarningboolean

Returns

void

Defined in

packages/react-querybuilder/src/hooks/useDeprecatedProps.ts:15


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.