@react-querybuilder/bulma

@react-querybuilder/bulma

Official react-querybuilder components for Bulma.

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/bulma bulma
# OR
yarn add react-querybuilder @react-querybuilder/bulma bulma

Usage

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

import { QueryBuilderBulma } from '@react-querybuilder/bulma';
import 'bulma/bulma.sass';
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 (
    <QueryBuilderBulma>
      <QueryBuilder fields={fields} query={query} onQueryChange={q => setQuery(q)} />
    </QueryBuilderBulma>
  );
};

Notes

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

  .queryBuilder .input {
    width: auto;
  }
  

• This package exports bulmaControlElements which can be assigned directly to the controlElements prop on <QueryBuilder /> (and also exports each component individually), but wrapping <QueryBuilder /> in <QueryBuilderBulma /> is the recommended method.

Changelog

[v6.5.0] - 2023-06-13

Changed

• [#529] Drag handle components will no longer be rendered unless drag-and-drop is enabled. Previously, drag handle components were rendered unconditionally. Accordingly, the default stylesheet no longer applies display: none to the queryBuilder-dragHandle class when drag-and-drop is disabled since the components will not be rendered anyway.

Added

• [#529] New props for several sub-components:
  • The parent rule object will now be provided to fieldSelector, operatorSelector, valueSourceSelector, and valueEditor components.
  • The parent ruleGroup object will now be provided to notToggle components.
  • The parent ruleOrGroup object will now be provided to dragHandle components.

Fixed

• [#529] The full rule object will now be passed to field-based validator functions. Previously, the parameter object only included the field, operator, valueSource, and value properties of the rule.