@react-querybuilder/fluent

@react-querybuilder/fluent

Official react-querybuilder components for Fluent UI.

To see them in action, check out the react-querybuilder demo or load the example in CodeSandbox.

Full documentation

Installation

npm i react-querybuilder @react-querybuilder/fluent @fluentui/react-components @fluentui/react-icons-mdl2
# OR yarn add / pnpm add / bun add

Usage

To render Fluent UI-compatible components in the query builder, wrap the <QueryBuilder /> element in <QueryBuilderFluent />.

import { FluentProvider, webLightTheme } from '@fluentui/react-components';
import { QueryBuilderFluent } from '@react-querybuilder/fluent';
import { QueryBuilder, RuleGroupType } from 'react-querybuilder';

const fields = [
  { name: 'firstName', label: 'First Name' },
  { name: 'lastName', label: 'Last Name' },
];

const App = () => {
  const [query, setQuery] = useState<RuleGroupType>({ combinator: 'and', rules: [] });

  return (
    <FluentProvider theme={webLightTheme}>
      <QueryBuilderFluent>
        <QueryBuilder fields={fields} query={query} onQueryChange={setQuery} />
      </QueryBuilderFluent>
    </FluentProvider>
  );
};

Notes

• This package exports fluentControlElements which can be assigned directly to the controlElements prop on <QueryBuilder /> (and also exports each component individually), but wrapping <QueryBuilder /> in <QueryBuilderFluent /> is the recommended method.

Changelog

[v7.1.0] - 2024-04-01

Changed

• To avoid confusion with the recommended query selector and update methods (useQueryBuilderSelector, props.schema.getQuery(), and props.schema.dispatchQuery()), the hooks useQueryBuilderDispatch and useQueryBuilderStore are no longer exported.

Added

• New "bulk add" controlClassnames properties. These classnames augment—rather than replace—the classnames defined for specific controls.
  • actionElement: Applied to all action elements like addRuleAction, addGroupAction, etc.
  • valueSelector: Applied to all selection elements like combinatorSelector, fieldSelector, etc.
• New numberedParams option for formatQuery. When the format is "parameterized", parameter placeholders within the generated SQL string will begin with the configured paramPrefix (default ":") followed by a numbered index beginning with 1 instead of using "?" as the placeholder for all parameters. This option was added primarily to reduce the code necessary for generating PostgreSQL-compatible SQL.
  • formatQuery now passes a third parameter to custom ruleProcessor functions when the format is "parameterized" or "parameterized_named". Currently the parameter is an object with a single property, processedParams, which represents the current state of the params array (for the "parameterized" format) or object (for the "parameterized_named" format) at the point the rule processor is invoked during query processing. The default ruleProcessor for the parameterized formats uses this parameter when the numberedParams option is true.

Fixed

• Improved performance of generateID when crypto.randomUUID is not available. This led to performance improvements in initial <QueryBuilder /> rendering and query update functions.