react-querybuilder

8.5.0last stable release 5 days ago
Complexity Score
High
Open Issues
N/A
Dependent Projects
16
Weekly Downloadsglobal
79,352

License

  • MIT
    • Yesattribution
    • Permissivelinking
    • Permissivedistribution
    • Permissivemodification
    • Nopatent grant
    • Yesprivate use
    • Permissivesublicensing
    • Notrademark grant

Downloads

Readme

React Query Builder

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.

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'; // or .scss

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

  return <QueryBuilder defaultQuery={query} onQueryChange={setQuery} />;
}

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, use @react-querybuilder/dnd.

For enhanced date/time support, use @react-querybuilder/datetime.

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

Compatibility packages


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, MUI, and Tremor. A React Native component is also available.

Development

See the contribution guidelines.

Credits

This component was inspired by prior work from:

  • jQuery QueryBuilder
  • Angular QueryBuilder
  • React Awesome Query Builder

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Jake Boone
πŸ’» πŸ“– 🚧 ⚠️
Pavan Podila
πŸ’» πŸ“– ⚠️
Andrew Turgeon
πŸ’» ⚠️
AndrΓ© Drougge
πŸ’» ⚠️
Oumar Sharif DAMBABA
πŸ’»
Arte Ebrahimi
πŸ’» πŸ“– ⚠️
Carlos Azuaje
πŸ’»
Srinivas Damam
πŸ’»
Matthew Reishus
πŸ“–
Anish Duwal
πŸ’» ⚠️
RomanLamsal1337
πŸ’»
Dmitriy Kolesnikov
πŸ’»
Vitor Barbosa
πŸ’»
Laxminarayana
πŸ’» πŸ“–
Christian Mund
πŸ’» πŸ“–
Dallas Larsen
πŸ’»
Ayush Srivastava
πŸ“–
Fabio Espinosa
πŸ’» πŸ“– ⚠️
Anatoly Bubenkov
πŸ’» πŸ“– ⚠️
Saurabh Nemade
πŸ’» ⚠️
Edwin Xavier
πŸ’» πŸ“–
Code Monk
πŸ’» πŸ“– ⚠️
ZigZagT
πŸ’»
mylawacad
πŸ’»
Kyrylo Stepanchuk
πŸ’»
Kasey Culmback
πŸ’»
Ahmed Fasih
πŸ’»
Austin Stowe
πŸ’»
Manuel
πŸ“–
Victor Arowo
πŸ“–
Ekin Koc
πŸ’»
Zach Blume
πŸ’»
ηŽ‹ζ’
πŸ“–
Jan BednΓ‘Ε™
πŸ’» ⚠️
Stephen Peery
πŸ’» ⚠️
stil
πŸ’» ⚠️
Chiawei Ong
πŸ’» ⚠️
De Lille Felix
πŸ’» ⚠️
RaphaΓ«l Bideau
πŸ’»
Dave Anderson
πŸ’»
Roman Ogoreltsev
πŸ’» ⚠️
Abdullah Ebrahim
πŸ’»
sajov
πŸ’» ⚠️

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

Dependencies

CVE IssuesActive
0
Scorecards Score
5.40
Test Coverage
No Data
Follows Semver
Yes
Github Stars
1,441
Dependenciestotal
0
DependenciesOutdated
0
DependenciesDeprecated
0
Threat Modelling
No Data
Repo Audits
No Data

Learn how to distribute react-querybuilder in your own private NPM registry

npm config set registry  https://npm.cloudsmith.com/owner/repo
Processing...
Done
npm install react-querybuilder
Processing...
Done

202 Releases

NPM on Cloudsmith

Getting started with NPM on Cloudsmith is fast and easy.