@react-querybuilder/dnd

@react-querybuilder/dnd

Augments react-querybuilder with drag-and-drop functionality.

To see this in action, check out the react-querybuilder demo with the drag-and-drop option enabled.

Full documentation

Installation

npm i --save react-querybuilder @react-querybuilder/dnd react-dnd react-dnd-html5-backend
# OR
yarn add react-querybuilder @react-querybuilder/dnd react-dnd react-dnd-html5-backend

Usage

To enable the drag-and-drop functionality of a query builder, wrap the <QueryBuilder /> element in <QueryBuilderDnD /> and pass in the exports from react-dnd and react-dnd-html5-backend as props to QueryBuilderDnD.

import { QueryBuilderDnD } from '@react-querybuilder/dnd';
import * as ReactDnD from 'react-dnd';
import * as ReactDndHtml5Backend from 'react-dnd-html5-backend';
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 (
    <QueryBuilderDnD dnd={{ ...ReactDnD, ...ReactDndHtml5Backend }}>
      <QueryBuilder fields={fields} query={query} onQueryChange={q => setQuery(q)} />
    </QueryBuilderDnD>
  );
};

Notes

• While not strictly necessary, we strongly recommend passing the react-dnd and react-dnd-html5-backend exports in as props to <QueryBuilderDnD />. If they are not passed in as props, the initial render of the query builder will have drag-and-drop disabled until the dependencies are asynchronously loaded via import().

• <QueryBuilderDnD /> will automatically set the enableDragAndDrop prop to true on any descendant <QueryBuilder /> elements unless enableDragAndDrop is explicitly set to false on the <QueryBuilder /> element.

• <QueryBuilderDnD /> does not need to be an immediate ancestor to <QueryBuilder />.

• Multiple <QueryBuilder />s may be nested beneath a single <QueryBuilderDnD />. The same drag-and-drop settings will be applied to each of them.

• If your application already uses react-dnd outside the scope of a query builder, use QueryBuilderDndWithoutProvider instead of QueryBuilderDnD to inherit context from your existing <DndProvider />. Example:

  import { QueryBuilderDndWithoutProvider } from '@react-querybuilder/dnd';
  import { DndProvider } from 'react-dnd';
  import { HTML5Backend } from 'react-dnd-html5-backend';
  import { QueryBuilder, RuleGroupType } from 'react-querybuilder';
  import { SomeOtherDndContextConsumer } from './SomeOtherDndContextConsumer';
  
  const fields = [
    { name: 'firstName', label: 'First Name' },
    { name: 'lastName', label: 'Last Name' },
  ];
  
  const ChildComponentOfDndProvider = () => {
    const [query, setQuery] = useState<RuleGroupType>({ combinator: 'and', rules: [] });
  
    return (
      <QueryBuilderDndWithoutProvider>
        <QueryBuilder fields={fields} query={query} onQueryChange={q => setQuery(q)} />
      </QueryBuilderDndWithoutProvider>
    );
  };
  
  const App = () => {
    return (
      <DndProvider backend={HTML5Backend}>
        <SomeOtherDndContextConsumer />
        <ChildComponentOfDndProvider />
      </DndProvider>
    );
  };