@react-querybuilder/antd

@react-querybuilder/antd

Official react-querybuilder components for Ant Design.

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

Installation

npm i --save react-querybuilder @react-querybuilder/antd @ant-design/icons antd
# OR
yarn add react-querybuilder @react-querybuilder/antd @ant-design/icons antd

Usage

import { antdControlElements } from '@react-querybuilder/antd';
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 (
    <QueryBuilder
      fields={fields}
      query={query}
      onQueryChange={q => setQuery(q)}
      controlElements={antdControlElements}
    />
  );
};

You may also want to reduce the width of the value editor component, which is 100% by default, with the following CSS rule:

.queryBuilder .ant-input {
  width: auto;
}

Changelog

[v4.5.1] - 2022-06-21

Fixed

• The type ValueProcessor was incorrectly including the new ValueProcessorByRule type. ValueProcessor is now simply an alias for ValueProcessorLegacy, which should undo a breaking change from [v4.5.0].