@react-querybuilder/bootstrap

Official react-querybuilder compatibility package for Bootstrap.

- Demo
- Full documentation
- CodeSandbox / StackBlitz example projects

!Screenshot

Installation

``bash
npm i react-querybuilder @react-querybuilder/bootstrap bootstrap bootstrap-icons


OR yarn add / pnpm add / bun add


`

Usage

To configure the query builder to use Bootstrap-compatible components, place QueryBuilderBootstrap above QueryBuilder in the component hierarchy.

`tsx
import { QueryBuilderBootstrap } from '@react-querybuilder/bootstrap';
import 'bootstrap-icons/font/bootstrap-icons.scss';
import 'bootstrap/scss/bootstrap.scss';
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({ combinator: 'and', rules: [] });

return (



);
}
`

> [!NOTE]
>
> Some additional styling may be necessary. We recommend the following:
>
> `css
> .queryBuilder .form-control,
> .queryBuilder .form-select {
> display: inline-block;
> width: auto;
> }
> `

QueryBuilderBootstrap 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 |
| ---------------------------- | ----------------------------- |
| bootstrapControlClassnames | controlClassnames |
| bootstrapControlElements | controlElements |
| bootstrapTranslations | translations |
| BootstrapNotToggle | controlElements.notToggle |
| BootstrapValueEditor | controlElements.valueEditor |

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