🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more

@react-querybuilder/antd

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install
r

@react-querybuilder/antd

Custom Ant Design components for react-querybuilder

8.7.1
latest
Version published
Weekly downloads
4.6K
-24.15%
Maintainers
1
Weekly downloads
 
Created
Issues
21

@react-querybuilder/antd

Official react-querybuilder compatibility package for Ant Design.

Screenshot

Installation

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

Usage

To configure the query builder to use Ant Design-compatible components, place QueryBuilderAntD above QueryBuilder in the component hierarchy.

import { QueryBuilderAntD } from '@react-querybuilder/antd';
import { useState } from 'react';
import { type Field, QueryBuilder, type RuleGroupType } from 'react-querybuilder';

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

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

  return (
    <QueryBuilderAntD>
      <QueryBuilder fields={fields} defaultQuery={query} onQueryChange={setQuery} />
    </QueryBuilderAntD>
  );
}

[!NOTE]

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;
}

QueryBuilderAntD is a React context provider that assigns the following props to all descendant QueryBuilder elements. The props can be overridden on the QueryBuilder or used directly without the context provider.

ExportQueryBuilder prop
antdControlElementscontrolElements
antdTranslationstranslations
AntDActionElementcontrolElements.actionElement
AntDDragHandlecontrolElements.dragHandle
AntDNotTogglecontrolElements.notToggle
AntDShiftActionscontrolElements.shiftActions
AntDValueEditorcontrolElements.valueEditor
AntDValueSelectorcontrolElements.valueSelector

[!TIP]

By default, this package uses icons from @ant-design/icons for button labels. To reset button labels to their default strings, use defaultTranslations from react-querybuilder.

<QueryBuilderAntD translations={defaultTranslations}>

FAQs

Package last updated on 09 Jun 2025

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts