sylturner/react-querybuilder

A QueryBuilder component for React

react-querybuilder

• Getting Started
• Demo
• Usage
• API
  • QueryBuilder
  • formatQuery
• Development
  • Changelog Generation
• Credits

Getting Started

npm install react-querybuilder --save

OR

yarn add react-querybuilder

Demo

See live demo

OR

To run the demo yourself, go through the following steps:

1. npm install Install npm packages
2. npm start Run a local server
3. http://localhost:8080/ Visit your localhost in your browser

Usage

import QueryBuilder from 'react-querybuilder';

const fields = [
  { name: 'firstName', label: 'First Name' },
  { name: 'lastName', label: 'Last Name' },
  { name: 'age', label: 'Age' },
  { name: 'address', label: 'Address' },
  { name: 'phone', label: 'Phone' },
  { name: 'email', label: 'Email' },
  { name: 'twitter', label: 'Twitter' },
  { name: 'isDev', label: 'Is a Developer?', value: false }
];

const dom = <QueryBuilder fields={fields} onQueryChange={logQuery} />;

function logQuery(query) {
  console.log(query);
}

API

This library exposes a React component, <QueryBuilder />, and a utility function, formatQuery. <QueryBuilder /> is the default export, and formatQuery is exposed as a named export.

QueryBuilder

<QueryBuilder /> supports the following properties:

query (Optional)

{id?: string, combinator: string, rules: ({field: string, value: any, operator: string} | {rules: ...[], combinator: string})[]}

The initial query, in JSON form (follows the same format as the parameter passed to the onQueryChange callback). id is optional. See the demo source for examples.

fields (Required)

{name: string, label: string, id?: string}[]

The array of fields that should be used. Each field should be an object with at least:

{name: string, label: string}

The id is optional. If you do not provide an id for a field then the name will be used.

Field objects can also contain other data. Each field object will be passed to the appropriate OperatorSelector and ValueEditor components as fieldData (see the section on controlElements).

operators (Optional)

{name: string, label: string}[]

The array of operators that should be used. The default operators include:

[
  { name: 'null', label: 'is null' },
  { name: 'notNull', label: 'is not null' },
  { name: 'in', label: 'in' },
  { name: 'notIn', label: 'not in' },
  { name: '=', label: '=' },
  { name: '!=', label: '!=' },
  { name: '<', label: '<' },
  { name: '>', label: '>' },
  { name: '<=', label: '<=' },
  { name: '>=', label: '>=' },
  { name: 'contains', label: 'contains' },
  { name: 'beginsWith', label: 'begins with' },
  { name: 'endsWith', label: 'ends with' },
  { name: 'doesNotContain', label: 'does not contain' },
  { name: 'doesNotBeginWith', label: 'does not begin with' },
  { name: 'doesNotEndWith', label: 'does not end with' }
];

combinators (Optional)

{name: string, label: string}[]

The array of combinators that should be used for RuleGroups. The default set includes:

[
  { name: 'and', label: 'AND' },
  { name: 'or', label: 'OR' }
];

controlElements (Optional)

React.PropTypes.shape({
  addGroupAction: React.PropTypes.func, // returns ReactClass
  removeGroupAction: React.PropTypes.func, // returns ReactClass
  addRuleAction: React.PropTypes.func, // returns ReactClass
  removeRuleAction: React.PropTypes.func, // returns ReactClass
  combinatorSelector: React.PropTypes.func, // returns ReactClass
  fieldSelector: React.PropTypes.func, // returns ReactClass
  operatorSelector: React.PropTypes.func, // returns ReactClass
  valueEditor: React.PropTypes.func, // returns ReactClass
  notToggle: React.PropTypes.func // returns ReactClass
});

This is a custom controls object that allows you to override the control elements used. The following control overrides are supported:

• addGroupAction: By default a <button /> is used. The following props are passed:

{
  label: React.PropTypes.string, // "+Group"
  className: React.PropTypes.string, // CSS classNames to be applied
  handleOnClick: React.PropTypes.func, // Callback function to invoke adding a <RuleGroup />
  rules: React.PropTypes.array, // Provides the number of rules already present for this group,
  level: React.PropTypes.number // The level of the current group
}

• removeGroupAction: By default a <button /> is used. The following props are passed:

{
  label: React.PropTypes.string, // "x"
  className: React.PropTypes.string, // CSS classNames to be applied
  handleOnClick: React.PropTypes.func, // Callback function to invoke removing a <RuleGroup />
  rules: React.PropTypes.array, // Provides the number of rules already present for this group,
  level: React.PropTypes.number // The level of the current group
}

• addRuleAction: By default a <button /> is used. The following props are passed:

{
  label: React.PropTypes.string, // "+Rule"
  className: React.PropTypes.string, // CSS classNames to be applied
  handleOnClick: React.PropTypes.func, // Callback function to invoke adding a <Rule />
  rules: React.PropTypes.array, // Provides the number of rules already present for this group,
  level: React.PropTypes.number // The level of the current group
}

• removeRuleAction: By default a <button /> is used. The following props are passed:

{
  label: React.PropTypes.string, // "x"
  className: React.PropTypes.string, // CSS classNames to be applied
  handleOnClick: React.PropTypes.func, // Callback function to invoke removing a <Rule />
  level: React.PropTypes.number // The level of the current group
}

• combinatorSelector: By default a <select /> is used. The following props are passed:

{
  options: React.PropTypes.array.isRequired, // Same as 'combinators' passed into QueryBuilder
  value: React.PropTypes.string, // Selected combinator from the existing query representation, if any
  className: React.PropTypes.string, // CSS classNames to be applied
  handleOnChange: React.PropTypes.func, // Callback function to update query representation
  rules: React.PropTypes.array, // Provides the number of rules already present for this group
  level: React.PropTypes.number // The level of the current group
}

• fieldSelector: By default a <select /> is used. The following props are passed:

{
  options: React.PropTypes.array.isRequired, // Same as 'fields' passed into QueryBuilder
  value: React.PropTypes.string, // Selected field from the existing query representation, if any
  operator: React.PropTypes.string, // Selected operator from the existing query representation, if any
  className: React.PropTypes.string, // CSS classNames to be applied
  handleOnChange: React.PropTypes.func, // Callback function to update query representation
  level: React.PropTypes.number // The level the group this rule belongs to
}

• operatorSelector: By default a <select /> is used. The following props are passed:

{
  field: React.PropTypes.string, // Field name corresponding to this Rule
  fieldData: React.PropTypes.object, // The entire object from the fields array for this field
  options: React.PropTypes.array.isRequired, // Return value of getOperators(field)
  value: React.PropTypes.string, // Selected operator from the existing query representation, if any
  className: React.PropTypes.string, // CSS classNames to be applied
  handleOnChange: React.PropTypes.func, // Callback function to update query representation
  level: React.PropTypes.number // The level the group this rule belongs to
}

• valueEditor: By default an <input type="text" /> is used. The following props are passed:

{
  field: React.PropTypes.string, // Field name corresponding to this Rule
  fieldData: React.PropTypes.object, // The entire object from the fields array for this field
  operator: React.PropTypes.string, // Operator name corresponding to this Rule
  value: React.PropTypes.string, // Value from the existing query representation, if any
  handleOnChange: React.PropTypes.func, // Callback function to update the query representation
  type: React.PropTypes.oneOf(['text', 'select', 'checkbox', 'radio']), // Type of editor to be displayed
  inputType: React.PropTypes.string, // Type of <input> if `type` is "text"
  values: React.PropTypes.arrayOf(React.PropTypes.object), //
  level: React.PropTypes.number, // The level the group this rule belongs to
  className: React.PropTypes.string, // CSS classNames to be applied
}

• notToggle: By default, <label><input type="checkbox" />Not</label> is used. The following props are passed:

{
  checked: React.PropTypes.bool, // Whether the input should be checked or not
  handleOnChange: React.PropTypes.func, // Callback function to update the query representation
  title: React.PropTypes.string, // Tooltip for the label
  level: React.PropTypes.number, // The level of the group
  className: React.PropTypes.string, // CSS classNames to be applied
}

getOperators (Optional)

function(field: string): []

This is a callback function invoked to get the list of allowed operators for the given field.

getValueEditorType (Optional)

function(field: string, operator: string): string

This is a callback function invoked to get the type of ValueEditor for the given field and operator. Allowed values are "text" (the default), "select", "checkbox", and "radio".

getInputType (Optional)

function(field: string, operator: string): string

This is a callback function invoked to get the type of <input /> for the given field and operator (only applicable when getValueEditorType returns "text" or a falsy value). If no function is provided, "text" is used as the default.

getValues (Optional)

function(field: string, operator: string): []

This is a callback function invoked to get the list of allowed values for the given field and operator (only applicable when getValueEditorType returns "select" or "radio"). If no function is provided, an empty array is used as the default.

onQueryChange (Optional)

function(queryJSON: RuleGroup): void

This is a notification that is invoked anytime the query configuration changes. The query is provided as a JSON structure, as shown below:

{
  "combinator": "and",
  "not": false,
  "rules": [
    {
      "field": "firstName",
      "operator": "null",
      "value": ""
    },
    {
      "field": "lastName",
      "operator": "null",
      "value": ""
    },
    {
      "combinator": "and",
      "rules": [
        {
          "field": "age",
          "operator": ">",
          "value": "30"
        }
      ]
    }
  ]
}

controlClassnames (Optional)

This can be used to assign specific CSS classes to various controls that are created by the <QueryBuilder />. This is an object with the following properties:

{
    queryBuilder: string, // Root <div> element

    ruleGroup: string, // <div> containing the RuleGroup
    header: string, // <div> containing the RuleGroup header controls
    combinators: string, // <select> control for combinators
    addRule: string, // <button> to add a Rule
    addGroup: string, // <button> to add a RuleGroup
    removeGroup: string, // <button> to remove a RuleGroup
    notToggle: string, // <label> on the "not" toggle

    rule: string, // <div> containing the Rule
    fields: string, // <select> control for fields
    operators: string, // <select> control for operators
    value: string, // <input> for the field value
    removeRule: string // <button> to remove a Rule

}

translations (Optional)

This can be used to override translatable texts applied to various controls that are created by the <QueryBuilder />. This is an object with the following properties:

{
    fields: {
        title: "Fields",
    },
    operators: {
        title: "Operators",
    },
    value: {
        title: "Value",
    },
    removeRule: {
        label: "x",
        title: "Remove rule",
    },
    removeGroup: {
        label: "x",
        title: "Remove group",
    },
    addRule: {
        label: "+Rule",
        title: "Add rule",
    },
    addGroup: {
        label: "+Group",
        title: "Add group",
    },
    combinators: {
        title: "Combinators",
    },
    notToggle: {
        title: "Invert this group",
    }
}

showCombinatorsBetweenRules (Optional)

boolean

Pass true to show the combinators (and/or) between rules and rule groups instead of at the top of rule groups. This can make some queries easier to understand as it encourages a more natural style of reading.

showNotToggle (Optional)

boolean

Pass true to show the "Not" toggle switch for each rule group.

resetOnFieldChange (Optional)

boolean

Pass false not to reset operator and value for field change.

formatQuery

formatQuery formats a given query in either SQL, JSON, or JSON without IDs (which can be useful if you need to serialize the rules). Example:

import { formatQuery } from 'react-querybuilder';

const query = {
  id: 'g-b6SQ6WCcup8e37xhydwHE',
  rules: [
    {
      id: 'r-zITQOjVEWlsU1fncraSNn',
      field: 'firstName',
      value: 'Steve',
      operator: '='
    },
    {
      id: 'r-zVx7ARNak3TCZNFHkwMG2',
      field: 'lastName',
      value: 'Vai',
      operator: '='
    }
  ],
  combinator: 'and',
  not: false
};

console.log(formatQuery(query, 'sql')); // '(firstName = "Steve" and lastName = "Vai")'

An optional third argument can be passed into formatQuery if you need to control the way the value portion of the output is processed. (This is only applicable when the format is "sql".)

const query = {
  id: 'g-J5GsbcFmZ6xOJCLPPKIfE',
  rules: [
    {
      id: 'r-KneYcwIPPHDGSogtKhG4g',
      field: 'instrument',
      value: ['Guitar', 'Vocals'],
      operator: 'in'
    },
    {
      id: 'r-wz6AkZbzSyDYbPk1AxgvO',
      field: 'lastName',
      value: 'Vai',
      operator: '='
    }
  ],
  combinator: 'and',
  not: false
};

const valueProcessor = (field, operator, value) => {
  if (operator === 'in') {
    // Assuming `value` is an array, such as from a multi-select
    return `(${value.map((v) => `"${v.trim()}"`).join(',')})`;
  } else {
    return `"${value}"`;
  }
};

console.log(formatQuery(query, 'sql', valueProcessor)); // '(instrument in ("Guitar","Vocals") and lastName = "Vai")'

The 'json_without_ids' format will return the same query without the IDs. This can be useful, for example, if you need to save the query to the URL so that it becomes bookmarkable:

const query = {
  id: 'g-J5GsbcFmZ6xOJCLPPKIfE',
  rules: [
    {
      id: 'r-KneYcwIPPHDGSogtKhG4g',
      field: 'instrument',
      value: ['Guitar', 'Vocals'],
      operator: 'in'
    },
    {
      id: 'r-wz6AkZbzSyDYbPk1AxgvO',
      field: 'lastName',
      value: 'Vai',
      operator: '='
    }
  ],
  combinator: 'and',
  not: false
};

console.log(formatQuery(query, 'json_without_ids')); 
// {
//   rules: [
//     {
//       field: 'instrument',
//       value: ['Guitar', 'Vocals'],
//       operator: 'in'
//     },
//     {
//       field: 'lastName',
//       value: 'Vai',
//       operator: '='
//     }
//   ],
//   combinator: 'and',
//   not: false
// };

Development

Changelog Generation

We are using github-changes to generate the changelog.

To use it:

1. tag your commit using semantic versioning
2. run npm run generate-changelog
3. enter your github credentials at the prompt
4. commit
5. push your commit and tags

Credits

This component was inspired by prior work from:

• jQuery QueryBuilder
• Angular QueryBuilder