Customization
Documentation
In this demo, a custom filter operation, "anyof", is implemented. The calculateFilterExpression function converts it into DataSource-compatible operations. The compatible and incompatible filter expressions are displayed under the FilterBuilder.
The set of available group operations is limited to "and" and "or" using the groupOperations array, and the groups’ maximum nesting level is limited to one using the maxGroupLevel.
Feel free to share demo-related thoughts here.
If you have technical questions, please create a support ticket in the DevExpress Support Center.
If you have technical questions, please create a support ticket in the DevExpress Support Center.
Thank you!
We appreciate your feedback.
We appreciate your feedback.
import React 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';
class App extends React.Component {
constructor(props) {
super(props);
this.state = {
value: filter
};
this.onValueChanged = this.onValueChanged.bind(this);
this.updateTexts = this.updateTexts.bind(this);
}
render() {
return (
<div>
<FilterBuilder
fields={fields}
value={this.state.value}
onInitialized={this.updateTexts}
groupOperations={groupOperations}
onValueChanged={this.onValueChanged}
>
<CustomOperation
name="anyof"
caption="Is any of"
icon="check"
editorComponent={EditorComponent}
calculateFilterExpression={calculateFilterExpression}
/>
</FilterBuilder>
<div className="results">
<div>
<b>Value</b>
<pre>{this.state.filterText}</pre>
</div>
<div>
<b>DataSource's filter expression</b>
<pre>{this.state.dataSourceText}</pre>
</div>
</div>
</div>
);
}
updateTexts(e) {
this.setState({
filterText: formatValue(e.component.option('value')),
dataSourceText: formatValue(e.component.getFilterExpression())
});
}
onValueChanged(e) {
this.setState({ value: e.value });
this.updateTexts(e);
}
}
function calculateFilterExpression(filterValue, field) {
return filterValue && filterValue.length
&& Array.prototype.concat.apply([], filterValue.map(function(value) {
return [[field.dataField, '=', value], 'or'];
})).slice(0, -1);
}
export default App;
import React from 'react';
import TagBox from 'devextreme-react/tag-box';
import { categories } from './data.js';
export class EditorComponent extends React.Component {
constructor(props) {
super(props);
this.onValueChanged = this.onValueChanged.bind(this);
}
render() {
return (
<TagBox
defaultValue={this.props.data.value}
items={categories}
onValueChanged={this.onValueChanged}
width="auto"
/>
);
}
onValueChanged(e) {
this.props.data.setValue(e.value && e.value.length ? e.value : null);
}
}
export function formatValue(value, spaces) {
if(value && Array.isArray(value[0])) {
var TAB_SIZE = 4;
spaces = spaces || TAB_SIZE;
return `[${getLineBreak(spaces)}${value.map(function(item) {
return Array.isArray(item[0]) ? formatValue(item, spaces + TAB_SIZE) : JSON.stringify(item);
}).join(`,${getLineBreak(spaces)}`)}${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')
);
<!DOCTYPE html>
<html>
<head>
<title>DevExtreme Demo</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0" />
<link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/20.2.4/css/dx.common.css" />
<link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/20.2.4/css/dx.light.css" />
<link rel="stylesheet" type="text/css" href="styles.css" />
<script src="https://unpkg.com/core-js@2.4.1/client/shim.min.js"></script>
<script src="https://unpkg.com/systemjs@0.21.3/dist/system.js"></script>
<script type="text/javascript" src="config.js"></script>
<script type="text/javascript">
System.import('./index.js');
</script>
</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 .dx-numberbox {
width: 80px;
}
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
}
}];
System.config({
transpiler: 'plugin-babel',
meta: {
},
paths: {
'npm:': 'https://unpkg.com/'
},
defaultExtension: 'js',
map: {
'react': 'npm:react@16.14.0/umd/react.development.js',
'react-dom': 'npm:react-dom@16.14.0/umd/react-dom.development.js',
'prop-types': 'npm:prop-types@15.7.2/prop-types.js',
'rrule': 'npm:rrule@2.6.6/dist/es5/rrule.js',
'luxon': 'npm:luxon@1.25.0/build/global/luxon.min.js',
'es6-object-assign': 'npm:es6-object-assign@1.1.0',
'devextreme': 'npm:devextreme@20.2.4',
'devextreme-react': 'npm:devextreme-react@20.2.4',
'jszip': 'npm:jszip@3.5.0/dist/jszip.min.js',
'devextreme-quill': 'npm:devextreme-quill@0.9.7/dist/dx-quill.min.js',
'devexpress-diagram': 'npm:devexpress-diagram@2.0.5/dist/dx-diagram.js',
'devexpress-gantt': 'npm:devexpress-gantt@2.0.8/dist/dx-gantt.js',
'preact': 'npm:preact@10.5.7/dist/preact.js',
'preact/hooks': 'npm:preact@10.5.7/hooks/dist/hooks.js',
// 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'
},
packages: {
'devextreme': {
defaultExtension: 'js'
},
'devextreme-react': {
main: 'index.js'
},
'devextreme/events/utils': {
main: 'index'
},
'devextreme/events': {
main: 'index'
},
'es6-object-assign': {
main: './index.js',
defaultExtension: 'js'
}
},
babelOptions: {
sourceMaps: false,
stage0: true,
react: true
}
});