@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.

Full documentation

Installation

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

Usage

To render Ant Design-compatible components in the query builder, wrap the <QueryBuilder /> element in <QueryBuilderAntD />.

import { QueryBuilderAntD } 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 (
    <QueryBuilderAntD>
      <QueryBuilder fields={fields} query={query} onQueryChange={setQuery} />
    </QueryBuilderAntD>
  );
};

Notes

• You may also want to reduce the width of the value editor component (100% by default) with the following CSS rule:

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

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

Changelog

[v7.6.0] - 2024-07-11

Added

• [#734] New callback props onMoveRule and onMoveGroup, called before a rule or group is moved (via drag-and-drop) or shifted. If the result of the callback is false, the move will be cancelled. If true, the move will proceed as normal. Alternatively, a full query object can be returned representing the new state if some other modifications were necessary.
• [#734] onAddRule and onAddGroup callbacks can now return true instead of the entire rule/group to allow the addition to proceed as normal.

Fixed

• [#733] parseSpEL was not handling the matches operator correctly when its value was a single character.
• [#733] Improved formatQuery "elasticsearch" output for "contains" and "doesNotContain" operators.