@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
# 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={q => setQuery(q)} />
      </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

[v6.5.3] - 2023-10-20

Added

• [#574] transformQuery enhancements:
  • rules properties are no longer retained unconditionally. The rules property can be copied or renamed like any other property using the propertyMap option.
  • propertyMap keys can now have false values. Properties matching a propertyMap key with a value of false will be removed without further processing (including the rules property, which would avoid recursion through the hierarchy altogether).
  • New boolean option omitPath. When true, a path property will not be added to each rule and group in the query hierarchy.

Fixed

• paramsKeepPrefix was not applying to bind variables generated from rules with an operator of "between", "notBetween", "in", or "notIn".