@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 --save react-querybuilder @react-querybuilder/fluent @fluentui/react-components
# OR
yarn add react-querybuilder @react-querybuilder/fluent @fluentui/react-components

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.0.4] - 2023-03-05

Fixed

• [#478] parseSQL now recognizes field names wrapped in square brackets, like [field name]. (The corresponding update to formatQuery was made in [#463] as part of v6.0.0).