React Filter Builder - Customization

import React, { useCallback, useState } from 'react';

import FilterBuilder, { CustomOperation } from 'devextreme-react/filter-builder';

import { filter, fields, groupOperations } from './data.js';

import { formatValue } from './helpers.js';

import { EditorComponent } from './EditorComponent.js';

​

function App() {

  const [value, setValue] = useState(filter);

  const [filterText, setFilterText] = useState('');

  const [dataSourceText, setDataSourceText] = useState('');

  const updateTexts = useCallback(

    (e) => {

      setFilterText(formatValue(e.component.option('value')));

      setDataSourceText(formatValue(e.component.getFilterExpression()));

    },

    [setFilterText, setDataSourceText],

  );

  const onValueChanged = useCallback(

    (e) => {

      setValue(e.value);

      updateTexts(e);

    },

    [updateTexts, setValue],

  );

  const calculateFilterExpression = useCallback(

    (filterValue, field) =>

      filterValue

      && filterValue.length

      && Array.prototype.concat

        .apply(

          [],

          filterValue.map((i) => [[field.dataField, '=', i], 'or']),

        )

        .slice(0, -1),

    [],

  );

  return (

    <div>

      <FilterBuilder

        fields={fields}

        value={value}

        onInitialized={updateTexts}

        groupOperations={groupOperations}

        onValueChanged={onValueChanged}

      >

        <CustomOperation

          name="anyof"

          caption="Is any of"

          icon="check"

          editorComponent={EditorComponent}

          calculateFilterExpression={calculateFilterExpression}

        />

      </FilterBuilder>

      <div className="results">

        <div>

          <b>Value</b>

          <pre>{filterText}</pre>

        </div>

        <div>

          <b>DataSource&apos;s filter expression</b>

          <pre>{dataSourceText}</pre>

        </div>

      </div>

    </div>

  );

}

export default App;

​

import React, { useCallback } from 'react';

import TagBox, { type TagBoxTypes } from 'devextreme-react/tag-box';

import { categories, categoryLabel } from './data.ts';

​

export const EditorComponent = (props: { data: { value: any, setValue: (value: any) => void } }) => {

  const onValueChanged = useCallback((e: TagBoxTypes.ValueChangedEvent) => {

    props.data.setValue(e.value && e.value.length ? e.value : null);

  }, [props.data]);

​

  return (

    <TagBox

      inputAttr={categoryLabel}

      defaultValue={props.data.value}

      items={categories}

      onValueChanged={onValueChanged}

      width="auto"

    />

  );

};

​

import React from 'react';

import ReactDOM from 'react-dom';

​

import App from './App.tsx';

​

ReactDOM.render(

  <App />,

  document.getElementById('app'),

);

​

import { FilterBuilderTypes } from 'devextreme-react/filter-builder';

​

export const filter = [

  ['Category', 'anyof', ['Automation', 'Monitors']],

  'or',

  [

    ['Category', '=', 'Televisions'],

    'and',

    ['Price', 'between', [2000, 4000]],

  ],

];

export const categories = [

  'Video Players',

  'Televisions',

  'Monitors',

  'Projectors',

  'Automation',

];

export const groupOperations: FilterBuilderTypes.GroupOperation[] = ['and', 'or'];

export const fields: FilterBuilderTypes.Field[] = [{

  dataField: 'Name',

}, {

  dataField: 'Price',

  dataType: 'number',

  format: 'currency',

}, {

  dataField: 'Current_Inventory',

  dataType: 'number',

  caption: 'Inventory',

}, {

  dataField: 'Category',

  filterOperations: ['=', 'anyof'],

  lookup: {

    dataSource: categories,

  },

}];

​

export const categoryLabel = { 'aria-label': 'Category' };

​

const TAB_SIZE = 4;

​

function prepareItem(item, spaces) {

  return Array.isArray(item[0])

    ? formatValue(item, spaces + TAB_SIZE)

    : JSON.stringify(item);

}

​

export function formatValue(value, spaces = TAB_SIZE) {

  if (value && Array.isArray(value[0])) {

    const formattedValue = value

      .map((item) => prepareItem(item, spaces))

      .join(`,${getLineBreak(spaces)}`);

​

    return `[${getLineBreak(spaces)}${formattedValue}${getLineBreak(spaces - TAB_SIZE)}]`;

  }

  return JSON.stringify(value);

}

​

function getLineBreak(spaces: number) {

  return `\r\n${new Array(spaces + 1).join(' ')}`;

}

​

window.exports = window.exports || {};

window.config = {

  transpiler: 'ts',

  typescriptOptions: {

    module: 'system',

    emitDecoratorMetadata: true,

    experimentalDecorators: true,

    jsx: 'react',

  },

  meta: {

    'react': {

      'esModule': true,

    },

    'typescript': {

      'exports': 'ts',

    },

    'devextreme/time_zone_utils.js': {

      'esModule': true,

    },

    'devextreme/localization.js': {

      'esModule': true,

    },

    'devextreme/viz/palette.js': {

      'esModule': true,

    },

    'openai': {

      'esModule': true,

    },

  },

  paths: {

    'npm:': 'https://unpkg.com/',

    'bundles:': 'bundles/',

    'externals:': 'bundles/externals/',

  },

  defaultExtension: 'js',

  map: {

    'ts': 'npm:plugin-typescript@8.0.0/lib/plugin.js',

    'typescript': 'npm:typescript@4.2.4/lib/typescript.js',

    'jszip': 'npm:jszip@3.10.1/dist/jszip.min.js',

    'react': 'npm:react@17.0.2/umd/react.development.js',

    'react-dom': 'npm:react-dom@17.0.2/umd/react-dom.development.js',

    'prop-types': 'npm:prop-types/prop-types.js',

    'rrule': 'npm:rrule@2.6.4/dist/es5/rrule.js',

    'luxon': 'npm:luxon@3.4.4/build/global/luxon.min.js',

    'es6-object-assign': 'npm:es6-object-assign',

    'devextreme': 'npm:devextreme@24.2.6/cjs',

    'devextreme-react': 'npm:devextreme-react@24.2.6/cjs',

    'devextreme-quill': 'npm:devextreme-quill@1.7.1/dist/dx-quill.min.js',

    'devexpress-diagram': 'npm:devexpress-diagram@2.2.15/dist/dx-diagram.js',

    'devexpress-gantt': 'npm:devexpress-gantt@4.1.60/dist/dx-gantt.js',

    '@devextreme/runtime': 'npm:@devextreme/runtime@3.0.12',

    'inferno': 'npm:inferno@7.4.11/dist/inferno.min.js',

    'inferno-compat': 'npm:inferno-compat/dist/inferno-compat.min.js',

    'inferno-create-element': 'npm:inferno-create-element@7.4.11/dist/inferno-create-element.min.js',

    'inferno-dom': 'npm:inferno-dom/dist/inferno-dom.min.js',

    'inferno-hydrate': 'npm:inferno-hydrate/dist/inferno-hydrate.min.js',

    'inferno-clone-vnode': 'npm:inferno-clone-vnode/dist/inferno-clone-vnode.min.js',

    'inferno-create-class': 'npm:inferno-create-class/dist/inferno-create-class.min.js',

    'inferno-extras': 'npm:inferno-extras/dist/inferno-extras.min.js',

    'devextreme-cldr-data': 'npm:devextreme-cldr-data@1.0.3',

    // SystemJS plugins

    'plugin-babel': 'npm:systemjs-plugin-babel@0.0.25/plugin-babel.js',

    'systemjs-babel-build': 'npm:systemjs-plugin-babel@0.0.25/systemjs-babel-browser.js',

    // Prettier

    'prettier/standalone': 'npm:prettier@2.8.8/standalone.js',

    'prettier/parser-html': 'npm:prettier@2.8.8/parser-html.js',

  },

  packages: {

    'devextreme': {

      defaultExtension: 'js',

    },

    'devextreme-react': {

      main: 'index.js',

    },

    'devextreme/events/utils': {

      main: 'index',

    },

    'devextreme/common/core/events/utils': {

      main: 'index',

    },

    'devextreme/localization/messages': {

      format: 'json',

      defaultExtension: 'json',

    },

    'devextreme/events': {

      main: 'index',

    },

    'es6-object-assign': {

      main: './index.js',

      defaultExtension: 'js',

    },

  },

  packageConfigPaths: [

    'npm:@devextreme/*/package.json',

    'npm:@devextreme/runtime@3.0.12/inferno/package.json',

  ],

  babelOptions: {

    sourceMaps: false,

    stage0: true,

    react: true,

  },

};

System.config(window.config);

​

import React, { useCallback } from 'react';

import TagBox from 'devextreme-react/tag-box';

import { categories, categoryLabel } from './data.js';

export const EditorComponent = (props) => {

  const onValueChanged = useCallback(

    (e) => {

      props.data.setValue(e.value && e.value.length ? e.value : null);

    },

    [props.data],

  );

  return (

    <TagBox

      inputAttr={categoryLabel}

      defaultValue={props.data.value}

      items={categories}

      onValueChanged={onValueChanged}

      width="auto"

    />

  );

};

​

const TAB_SIZE = 4;

function prepareItem(item, spaces) {

  return Array.isArray(item[0]) ? formatValue(item, spaces + TAB_SIZE) : JSON.stringify(item);

}

export function formatValue(value, spaces = TAB_SIZE) {

  if (value && Array.isArray(value[0])) {

    const formattedValue = value

      .map((item) => prepareItem(item, spaces))

      .join(`,${getLineBreak(spaces)}`);

    return `[${getLineBreak(spaces)}${formattedValue}${getLineBreak(spaces - TAB_SIZE)}]`;

  }

  return JSON.stringify(value);

}

function getLineBreak(spaces) {

  return `\r\n${new Array(spaces + 1).join(' ')}`;

}

​

import React from 'react';

import ReactDOM from 'react-dom';

import App from './App.js';

​

ReactDOM.render(<App />, document.getElementById('app'));

​

export const filter = [

  ['Category', 'anyof', ['Automation', 'Monitors']],

  'or',

  [['Category', '=', 'Televisions'], 'and', ['Price', 'between', [2000, 4000]]],

];

export const categories = ['Video Players', 'Televisions', 'Monitors', 'Projectors', 'Automation'];

export const groupOperations = ['and', 'or'];

export const fields = [

  {

    dataField: 'Name',

  },

  {

    dataField: 'Price',

    dataType: 'number',

    format: 'currency',

  },

  {

    dataField: 'Current_Inventory',

    dataType: 'number',

    caption: 'Inventory',

  },

  {

    dataField: 'Category',

    filterOperations: ['=', 'anyof'],

    lookup: {

      dataSource: categories,

    },

  },

];

export const categoryLabel = { 'aria-label': 'Category' };

​

<!DOCTYPE html>

<html lang="en">

  <head>↔</head>

​

  <body class="dx-viewport">

    <div class="demo-container">

      <div id="app"></div>

    </div>

  </body>

</html>

​

.results {

  margin-top: 50px;

  display: flex;

  justify-content: space-between;

}

​

.results > div {

  flex-basis: 49%;

  max-width: 50%;

  background-color: rgba(191, 191, 191, 0.15);

  position: relative;

}

​

.results b {

  position: absolute;

  top: -25px;

}

​

.results pre {

  padding: 10px 20px;

  height: 100%;

  font-size: 13px;

  overflow: auto;

  box-sizing: border-box;

}

​

.dx-tagbox {

  min-width: 150px;

}

​

.dx-filterbuilder {

  background-color: transparent;

  box-shadow: 0 8px 16px 0 rgba(0, 0, 0, 0.14), 0 0 2px 0 rgba(0, 0, 0, 0.12);

  border-radius: 6px;

  padding: 15px;

  margin: 24px;

}

​

.dx-filterbuilder .dx-numberbox {

  width: 80px;

}

​