@react-querybuilder/chakra

Official react-querybuilder compatibility package for Chakra UI.

- Demo
- Full documentation
- CodeSandbox / StackBlitz example projects

!Screenshot

Installation

``bash
npm i react-querybuilder @react-querybuilder/chakra @chakra-ui/react @emotion/react react-icons


OR yarn add / pnpm add / bun add


`

> [!NOTE]
>
> As of version 8, this package is no longer compatible with Chakra UI version 2.
>
> For compatibility with Chakra UI version 2, use @react-querybuilder/chakra2.

Usage

To configure the query builder to use Chakra-compatible components, place QueryBuilderChakra above QueryBuilder and beneath ChakraProvider in the component hierarchy.

`tsx
import { ChakraProvider, createSystem, defaultConfig, Theme } from '@chakra-ui/react';
import { QueryBuilderChakra } from '@react-querybuilder/chakra';
import { useState } from 'react';
import { type Field, QueryBuilder, type RuleGroupType } from 'react-querybuilder';

const chakraTheme = createSystem(defaultConfig);

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

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

return (







);
}
`

> [!NOTE]
>
> Some additional styling may be necessary. We recommend the following:
>
> `css
> .queryBuilder .chakra-native-select__root {
> width: fit-content;
> display: inline-block;
> }
>
> .queryBuilder .chakra-input {
> width: auto;
> display: inline-block;
> }
> `

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

| Export | QueryBuilder prop |
| ----------------------- | ------------------------------- |
| chakraControlElements | controlElements |
| chakraTranslations | translations |
| ChakraActionElement | controlElements.actionElement |
| ChakraNotToggle | controlElements.notToggle |
| ChakraValueEditor | controlElements.valueEditor |
| ChakraValueSelector | controlElements.valueSelector |

> [!TIP]
>
> By default, this package uses icons from react-icons for button labels. To reset button labels to their default strings, use defaultTranslations from react-querybuilder.
>
> `tsx
>
> ``