Skip to content

cjmaio/react-querybuilder

Β 
Β 

Repository files navigation

React Query Builder

npm Demo Docs Learn from the maintainer Chat

CI codecov.io All Contributors

React Query Builder is a fully customizable query builder component for React, along with a collection of utility functions for importing from, and exporting to, various query languages like SQL, MongoDB, and more. Demo is here.

Complete documentation is available at react-querybuilder.js.org.

Screenshot

Getting started

To get started, import the main component and the default stylesheet, then render the component in your app:

import { QueryBuilder } from 'react-querybuilder';
import 'react-querybuilder/dist/query-builder.css';

export const App = () => {
  return <QueryBuilder />;
};

For a more complete introduction, see the main package README, dive into the full documentation, or browse the example projects.

To enable drag-and-drop functionality, see the @react-querybuilder/dnd package README.

For instructions on migrating from earlier versions of react-querybuilder, click here.

Compatibility packages

Ant Design Bootstrap Bulma Chakra UI Fluent UI Mantine MUI React Native

In addition to the main react-querybuilder package, this repo also hosts official compatibility component packages for use with several popular style libraries including Ant Design, Bootstrap, Bulma, Chakra UI, Fluent UI, Mantine, and MUI. A functionally equivalent React Native-compatible component is also available.

Development

Most scripts in this repository require Bun.

To run a test page with a basic query builder using the default components, run bun run start.

To run the documentation website, run bun run website:start. Click "Demo" in the page header to load the full demo with all options and compatibility components available.

Credits

This component was inspired by prior work from:

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Jake Boone
Jake Boone

πŸ’» πŸ“– 🚧 ⚠️
Pavan Podila
Pavan Podila

πŸ’» πŸ“– ⚠️
Andrew Turgeon
Andrew Turgeon

πŸ’» ⚠️
AndrΓ© Drougge
AndrΓ© Drougge

πŸ’» ⚠️
Oumar Sharif DAMBABA
Oumar Sharif DAMBABA

πŸ’»
Arte Ebrahimi
Arte Ebrahimi

πŸ’» πŸ“– ⚠️
Carlos Azuaje
Carlos Azuaje

πŸ’»
Srinivas Damam
Srinivas Damam

πŸ’»
Matthew Reishus
Matthew Reishus

πŸ“–
Anish Duwal
Anish Duwal

πŸ’» ⚠️
RomanLamsal1337
RomanLamsal1337

πŸ’»
Dmitriy Kolesnikov
Dmitriy Kolesnikov

πŸ’»
Vitor Barbosa
Vitor Barbosa

πŸ’»
Laxminarayana
Laxminarayana

πŸ’» πŸ“–
Christian Mund
Christian Mund

πŸ’» πŸ“–
Dallas Larsen
Dallas Larsen

πŸ’»
Ayush Srivastava
Ayush Srivastava

πŸ“–
Fabio Espinosa
Fabio Espinosa

πŸ’» πŸ“– ⚠️
Anatoly Bubenkov
Anatoly Bubenkov

πŸ’» πŸ“– ⚠️
Saurabh Nemade
Saurabh Nemade

πŸ’» ⚠️
Edwin Xavier
Edwin Xavier

πŸ’» πŸ“–
Code Monk
Code Monk

πŸ’» πŸ“– ⚠️
ZigZagT
ZigZagT

πŸ’»
mylawacad
mylawacad

πŸ’»
Kyrylo Stepanchuk
Kyrylo Stepanchuk

πŸ’»
Kasey Culmback
Kasey Culmback

πŸ’»
Ahmed Fasih
Ahmed Fasih

πŸ’»
Austin Stowe
Austin Stowe

πŸ’»

This project follows the all-contributors specification. Contributions of any kind welcome!

About

A QueryBuilder component for React

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 54.4%
  • MDX 40.6%
  • Yacc 2.0%
  • SCSS 1.7%
  • JavaScript 0.8%
  • CSS 0.3%
  • Other 0.2%