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

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={setQuery} />
    </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

[v7.5.0] - 2024-06-15

Changed

• [#716] The React Native compatibility package uses gap for layout spacing, which means the minimum react-native version is now 0.71.0.

Added

• [#723] The useQueryBuilder hook has been reinstated. It does nothing more than call useQueryBuilderSetup and useQueryBuilderSchema, which no longer need to be called from separate components.
• [#723] useQueryBuilderQuery hook to retrieve the full, current query object during the render pass of a custom component. It requires no parameters and should be used in place of the previously recommended hook useQueryBuilderSelector, which requires a selector function generated with getQuerySelectorById(props.schema.qbId). While useQueryBuilderSelector is not deprecated, it is no longer recommended except in very special circumstances.

Fixed

• [#723] useQueryBuilderSelector no longer returns undefined during the first render pass (and neither does the new hook useQueryBuilderQuery).
• [#716] parse* methods properly escape commas in string values for "between" and "in" operators.