@react-querybuilder/bulma

@react-querybuilder/bulma

Official Bulma components for react-querybuilder.

To see them in action, check out the react-querybuilder demo and choose "Bulma" from the Style drop-down.

Installation

npm i --save react-querybuilder @react-querybuilder/bulma bulma react-bulma-components
# OR
yarn add react-querybuilder @react-querybuilder/bulma bulma react-bulma-components

Usage

import QueryBuilder, { RuleGroupType } from 'react-querybuilder';
import {
  BulmaActionElement,
  BulmaNotToggle,
  BulmaValueEditor,
  BulmaValueSelector,
} from '@react-querybuilder/bulma';
import 'bulma/bulma.sass';

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

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

  return (
    <QueryBuilder
      fields={fields}
      query={query}
      onQueryChange={q => setQuery(q)}
      controlElements={{
        addGroupAction: BulmaActionElement,
        addRuleAction: BulmaActionElement,
        cloneGroupAction: BulmaActionElement,
        cloneRuleAction: BulmaActionElement,
        combinatorSelector: BulmaValueSelector,
        fieldSelector: BulmaValueSelector,
        notToggle: BulmaNotToggle,
        operatorSelector: BulmaValueSelector,
        removeGroupAction: BulmaActionElement,
        removeRuleAction: BulmaActionElement,
        valueEditor: BulmaValueEditor,
      }}
    />
  );
};

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

.input {
  width: auto;
}

Changelog

[v4.1.0] - 2022-01-09

Fixed

• Minimum TypeScript version has been lowered to 4.1.2, down from 4.5 in react-querybuilder v4.0.0.

Added

• All ValueSelector-based components, including field selectors, operator selectors, combinator selectors, and value editors where the type is "select" now support option groups. Pass { label: string; options: NameLabelPair[] }[] instead of NameLabelPair[].
• TypeScript types for rules and groups now use generics which can be used to narrow certain member types more easily.