JSPM

  • Created
  • Published
  • Downloads 1304
  • Score
    100M100P100Q114425F
  • License MIT

Custom Bootstrap components for react-querybuilder

Package Exports

  • @react-querybuilder/bootstrap
  • @react-querybuilder/bootstrap/dist/index.cjs.js
  • @react-querybuilder/bootstrap/dist/index.es.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@react-querybuilder/bootstrap) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@react-querybuilder/bootstrap

Official react-querybuilder components for Bootstrap.

To see them in action, check out the react-querybuilder demo or load the example in CodeSandbox.

Full documentation

Installation

npm i --save react-querybuilder @react-querybuilder/bootstrap bootstrap bootstrap-icons
# OR
yarn add react-querybuilder @react-querybuilder/bootstrap bootstrap bootstrap-icons

Usage

To render Bootstrap-compatible components in the query builder, wrap the <QueryBuilder /> element in <QueryBuilderBootstrap />.

import { QueryBuilderBootstrap } from '@react-querybuilder/bootstrap';
import 'bootstrap-icons/font/bootstrap-icons.scss';
import 'bootstrap/scss/bootstrap.scss';
import { QueryBuilder, RuleGroupType } from 'react-querybuilder';

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

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

  return (
    <QueryBuilderBootstrap>
      <QueryBuilder fields={fields} query={query} onQueryChange={q => setQuery(q)} />
    </QueryBuilderBootstrap>
  );
};

Notes

  • Some additional styling may be necessary, e.g.:

    .queryBuilder .form-control,
    .queryBuilder .form-select {
      display: inline-block;
      width: auto;
    }
  • This package exports bootstrapControlClassnames and bootstrapControlElements which can be assigned directly to the controlClassnames and controlElements props, respectively, on <QueryBuilder /> (each component is also exported individually). However, the recommended usage is to wrap a <QueryBuilder /> element in <QueryBuilderBootstrap />.