Inline Editing (React)

Although the FlexGrid control provides efficient, Excel-style editing by default, you may want to customize the editing behavior. If for some reason you don't like the Excel-style editing and prefer to add editing buttons to every row (typical of editable HTML tables), you can accomplish that using the formatItem event and a little code.

Learn about FlexGrid | FlexGrid API Reference

This example uses React.

import 'bootstrap.css'; import '@mescius/wijmo.styles/wijmo.css'; import ReactDOM from 'react-dom/client'; import React, { useRef } from 'react'; import useEvent from 'react-use-event-hook'; import * as wjGrid from '@mescius/wijmo.react.grid'; import * as wjcCore from '@mescius/wijmo'; import './app.css'; import { data } from './data'; function App() { const flexRef = useRef(null); const currentEditItemRef = useRef(null); const initializeGrid = useEvent((flex) => { flexRef.current = flex; flex.rows.defaultSize = 40; // custom formatter to paint buttons and editors flex.formatItem.addHandler((s, e) => { var _a, _b; if (e.panel == s.cells) { let col = s.columns[e.col], item = s.rows[e.row].dataItem; if (item == currentEditItemRef.current) { // create editors and buttons for the item being edited switch (col.binding) { case 'buttons': e.cell.innerHTML = (_a = document.getElementById('tplBtnEditMode')) === null || _a === void 0 ? void 0 : _a.innerHTML; e.cell['dataItem'] = item; break; case 'country': case 'sales': case 'expenses': e.cell.innerHTML = '<input class="form-control" ' + 'id="' + col.binding + '" ' + 'value="' + s.getCellData(e.row, e.col, true) + '"/>'; break; } } else { // create buttons for items not being edited switch (col.binding) { case 'buttons': e.cell.innerHTML = (_b = document.getElementById('tplBtnViewMode')) === null || _b === void 0 ? void 0 : _b.innerHTML; e.cell['dataItem'] = item; break; } } } }); // handle button clicks flex.addEventListener(flex.hostElement, 'click', (e) => { const target = e.target; const button = target instanceof HTMLButtonElement ? target : target.parentElement; if (button instanceof HTMLButtonElement) { // get button's data item let item = wjcCore.closest(button, '.wj-cell')['dataItem']; // handle buttons switch (button.id) { // start editing this item case 'btnEdit': editItem(item); break; // remove this item from the collection case 'btnDelete': (flex.collectionView).remove(item); break; // commit edits case 'btnOK': commitEdit(); break; // cancel edits case 'btnCancel': cancelEdit(); break; } } }); // exit edit mode when scrolling the grid or losing focus flex.scrollPositionChanged.addHandler(cancelEdit); flex.lostFocus.addHandler(cancelEdit); }); const editItem = useEvent((item) => { cancelEdit(); currentEditItemRef.current = item; flexRef.current.invalidate(); }); const commitEdit = useEvent(() => { if (currentEditItemRef.current) { flexRef.current.columns.forEach((col) => { let input = flexRef.current.hostElement.querySelector('#' + col.binding); if (input) { let value = wjcCore.changeType(input.value, col.dataType, col.format); if (wjcCore.getType(value) == col.dataType) { currentEditItemRef.current[col.binding] = value; } } }); } currentEditItemRef.current = null; flexRef.current.invalidate(); }); const cancelEdit = useEvent(() => { if (currentEditItemRef.current) { currentEditItemRef.current = null; flexRef.current.invalidate(); } }); return (<main className="container-fluid"> <wjGrid.FlexGrid isReadOnly={true} selectionMode="None" headersVisibility="Column" initialized={initializeGrid} itemsSource={data}> <wjGrid.FlexGridColumn binding="id" header="ID" width={50}/> <wjGrid.FlexGridColumn binding="country" header="Country" isRequired={true}/> <wjGrid.FlexGridColumn binding="sales" header="Sales" format="n2"/> <wjGrid.FlexGridColumn binding="expenses" header="Expenses" format="n2"/> <wjGrid.FlexGridColumn binding="buttons" header="Edit" width={160}/> </wjGrid.FlexGrid> <div id="tplBtnViewMode"> <button id="btnEdit" className="btn btn-default btn-sm"> <span className="glyphicon glyphicon-pencil"></span> Edit </button> <button id="btnDelete" className="btn btn-default btn-sm"> <span className="glyphicon glyphicon-remove"></span> Delete </button> </div> <div id="tplBtnEditMode"> <button id="btnOK" className="btn btn-primary btn-sm"> <span className="glyphicon glyphicon-ok"></span> OK </button> <button id="btnCancel" className="btn btn-warning btn-sm"> <span className="glyphicon glyphicon-ban-circle"></span> Cancel </button> </div> </main>); } const container = document.getElementById('app'); if (container) { const root = ReactDOM.createRoot(container); root.render(<App />); }
<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>MESCIUS Wijmo Wijmo FlexGrid Inline Editing</title> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <!-- SystemJS --> <script src="https://cdn.jsdelivr.net/npm/systemjs@0.19.40/dist/system.src.js" integrity="sha512-G6mEj6h18+m3MvzdviSDfPle/TfH0//cXcB33AKlNR/Rha0yQsKefDZKRTkIZos97HEGq2JMV1RT5ybMoQ3WsQ==" crossorigin="anonymous"></script> <script src="systemjs.config.js"></script> <script> System.import('./src/app'); </script> </head> <body> <div id="app"></div> </body> </html>
.wj-flexgrid { max-height: 200px; margin-bottom: 12px; } #tplBtnViewMode { display: none; } #tplBtnEditMode { display: none; }
function getData() { let data = []; for (let i = 0; i < countries.length; i++) { data.push({ id: i, country: countries[i], sales: Math.random() * 10000, expenses: Math.random() * 5000, overdue: i % 4 == 0 }); } return data; } export const countries = ['US', 'Germany', 'UK', 'Japan', 'Italy', 'Greece']; export const data = getData();
(function (global) { window.process = { env: { NODE_ENV: 'production', }, }; System.config({ transpiler: 'plugin-babel', babelOptions: { es2015: true, react: true, }, meta: { '*.css': { loader: 'css' }, }, paths: { // paths serve as alias 'npm:': 'node_modules/', 'cdn:': 'https://cdn.mescius.io/demoapps/packages/wijmojs/5.20261.50-rc/', 'pcdn:': 'https://cdn.jsdelivr.net/npm/' }, // map tells the System loader where to look for things map: { '@mescius/wijmo': 'cdn:@mescius/wijmo/index.js', '@mescius/wijmo.input': 'cdn:@mescius/wijmo.input/index.js', '@mescius/wijmo.styles': 'cdn:@mescius/wijmo.styles', '@mescius/wijmo.cultures': 'cdn:@mescius/wijmo.cultures', '@mescius/wijmo.chart': 'cdn:@mescius/wijmo.chart/index.js', '@mescius/wijmo.chart.analytics': 'cdn:@mescius/wijmo.chart.analytics/index.js', '@mescius/wijmo.chart.animation': 'cdn:@mescius/wijmo.chart.animation/index.js', '@mescius/wijmo.chart.annotation': 'cdn:@mescius/wijmo.chart.annotation/index.js', '@mescius/wijmo.chart.finance': 'cdn:@mescius/wijmo.chart.finance/index.js', '@mescius/wijmo.chart.finance.analytics': 'cdn:@mescius/wijmo.chart.finance.analytics/index.js', '@mescius/wijmo.chart.hierarchical': 'cdn:@mescius/wijmo.chart.hierarchical/index.js', '@mescius/wijmo.chart.interaction': 'cdn:@mescius/wijmo.chart.interaction/index.js', '@mescius/wijmo.chart.radar': 'cdn:@mescius/wijmo.chart.radar/index.js', '@mescius/wijmo.chart.render': 'cdn:@mescius/wijmo.chart.render/index.js', '@mescius/wijmo.chart.webgl': 'cdn:@mescius/wijmo.chart.webgl/index.js', '@mescius/wijmo.chart.map': 'cdn:@mescius/wijmo.chart.map/index.js', '@mescius/wijmo.gauge': 'cdn:@mescius/wijmo.gauge/index.js', '@mescius/wijmo.grid': 'cdn:@mescius/wijmo.grid/index.js', '@mescius/wijmo.grid.detail': 'cdn:@mescius/wijmo.grid.detail/index.js', '@mescius/wijmo.grid.filter': 'cdn:@mescius/wijmo.grid.filter/index.js', '@mescius/wijmo.grid.search': 'cdn:@mescius/wijmo.grid.search/index.js', '@mescius/wijmo.grid.style': 'cdn:@mescius/wijmo.grid.style/index.js', '@mescius/wijmo.grid.grouppanel': 'cdn:@mescius/wijmo.grid.grouppanel/index.js', '@mescius/wijmo.grid.multirow': 'cdn:@mescius/wijmo.grid.multirow/index.js', '@mescius/wijmo.grid.transposed': 'cdn:@mescius/wijmo.grid.transposed/index.js', '@mescius/wijmo.grid.transposedmultirow': 'cdn:@mescius/wijmo.grid.transposedmultirow/index.js', '@mescius/wijmo.grid.pdf': 'cdn:@mescius/wijmo.grid.pdf/index.js', '@mescius/wijmo.grid.sheet': 'cdn:@mescius/wijmo.grid.sheet/index.js', '@mescius/wijmo.grid.xlsx': 'cdn:@mescius/wijmo.grid.xlsx/index.js', '@mescius/wijmo.grid.selector': 'cdn:@mescius/wijmo.grid.selector/index.js', '@mescius/wijmo.grid.cellmaker': 'cdn:@mescius/wijmo.grid.cellmaker/index.js', '@mescius/wijmo.grid.immutable': 'cdn:@mescius/wijmo.grid.immutable/index.js', '@mescius/wijmo.touch': 'cdn:@mescius/wijmo.touch/index.js', '@mescius/wijmo.cloud': 'cdn:@mescius/wijmo.cloud/index.js', '@mescius/wijmo.nav': 'cdn:@mescius/wijmo.nav/index.js', '@mescius/wijmo.odata': 'cdn:@mescius/wijmo.odata/index.js', '@mescius/wijmo.olap': 'cdn:@mescius/wijmo.olap/index.js', '@mescius/wijmo.rest': 'cdn:@mescius/wijmo.rest/index.js', '@mescius/wijmo.pdf': 'cdn:@mescius/wijmo.pdf/index.js', '@mescius/wijmo.pdf.security': 'cdn:@mescius/wijmo.pdf.security/index.js', '@mescius/wijmo.viewer': 'cdn:@mescius/wijmo.viewer/index.js', '@mescius/wijmo.xlsx': 'cdn:@mescius/wijmo.xlsx/index.js', '@mescius/wijmo.undo': 'cdn:@mescius/wijmo.undo/index.js', '@mescius/wijmo.interop.grid': 'cdn:@mescius/wijmo.interop.grid/index.js', '@mescius/wijmo.barcode': 'cdn:@mescius/wijmo.barcode/index.js', '@mescius/wijmo.barcode.common': 'cdn:@mescius/wijmo.barcode.common/index.js', '@mescius/wijmo.barcode.composite': 'cdn:@mescius/wijmo.barcode.composite/index.js', '@mescius/wijmo.barcode.specialized': 'cdn:@mescius/wijmo.barcode.specialized/index.js', '@mescius/wijmo.react.chart.analytics': 'cdn:@mescius/wijmo.react.chart.analytics/index.js', '@mescius/wijmo.react.chart.animation': 'cdn:@mescius/wijmo.react.chart.animation/index.js', '@mescius/wijmo.react.chart.annotation': 'cdn:@mescius/wijmo.react.chart.annotation/index.js', '@mescius/wijmo.react.chart.finance.analytics': 'cdn:@mescius/wijmo.react.chart.finance.analytics/index.js', '@mescius/wijmo.react.chart.finance': 'cdn:@mescius/wijmo.react.chart.finance/index.js', '@mescius/wijmo.react.chart.hierarchical': 'cdn:@mescius/wijmo.react.chart.hierarchical/index.js', '@mescius/wijmo.react.chart.interaction': 'cdn:@mescius/wijmo.react.chart.interaction/index.js', '@mescius/wijmo.react.chart.radar': 'cdn:@mescius/wijmo.react.chart.radar/index.js', '@mescius/wijmo.react.chart': 'cdn:@mescius/wijmo.react.chart/index.js', '@mescius/wijmo.react.core': 'cdn:@mescius/wijmo.react.core/index.js', '@mescius/wijmo.react.chart.map': 'cdn:@mescius/wijmo.react.chart.map/index.js', '@mescius/wijmo.react.gauge': 'cdn:@mescius/wijmo.react.gauge/index.js', '@mescius/wijmo.react.grid.detail': 'cdn:@mescius/wijmo.react.grid.detail/index.js', '@mescius/wijmo.react.grid.filter': 'cdn:@mescius/wijmo.react.grid.filter/index.js', '@mescius/wijmo.react.grid.grouppanel': 'cdn:@mescius/wijmo.react.grid.grouppanel/index.js', '@mescius/wijmo.react.grid.search': 'cdn:@mescius/wijmo.react.grid.search/index.js', '@mescius/wijmo.react.grid.multirow': 'cdn:@mescius/wijmo.react.grid.multirow/index.js', '@mescius/wijmo.react.grid.sheet': 'cdn:@mescius/wijmo.react.grid.sheet/index.js', '@mescius/wijmo.react.grid.transposed': 'cdn:@mescius/wijmo.react.grid.transposed/index.js', '@mescius/wijmo.react.grid.transposedmultirow': 'cdn:@mescius/wijmo.react.grid.transposedmultirow/index.js', '@mescius/wijmo.react.grid.immutable': 'cdn:@mescius/wijmo.react.grid.immutable/index.js', '@mescius/wijmo.react.grid': 'cdn:@mescius/wijmo.react.grid/index.js', '@mescius/wijmo.react.input': 'cdn:@mescius/wijmo.react.input/index.js', '@mescius/wijmo.react.olap': 'cdn:@mescius/wijmo.react.olap/index.js', '@mescius/wijmo.react.viewer': 'cdn:@mescius/wijmo.react.viewer/index.js', '@mescius/wijmo.react.nav': 'cdn:@mescius/wijmo.react.nav/index.js', '@mescius/wijmo.react.base': 'cdn:@mescius/wijmo.react.base/index.js', '@mescius/wijmo.react.barcode.common': 'cdn:@mescius/wijmo.react.barcode.common/index.js', '@mescius/wijmo.react.barcode.composite': 'cdn:@mescius/wijmo.react.barcode.composite/index.js', '@mescius/wijmo.react.barcode.specialized': 'cdn:@mescius/wijmo.react.barcode.specialized/index.js', jszip: 'pcdn:jszip@3.8.0/dist/jszip.js', react: 'pcdn:react@19.0.0/index.js', 'react-dom': 'pcdn:react-dom@19.0.0/index.js', 'react-dom/client': 'pcdn:react-dom@19.0.0/client.js', scheduler: 'pcdn:scheduler@0.25.0/index.js', redux: 'pcdn:redux@5.0.1/dist/redux.legacy-esm.js', 'react-redux': 'pcdn:react-redux@9.2.0/dist/react-redux.legacy-esm.js', 'bootstrap.css': 'pcdn:bootstrap@3.3.7/dist/css/bootstrap.min.css', css: 'pcdn:systemjs-plugin-css@0.1.37/css.js', 'plugin-babel': 'pcdn:systemjs-plugin-babel@0.0.25/plugin-babel.js', 'systemjs-babel-build': 'pcdn:systemjs-plugin-babel@0.0.25/systemjs-babel-browser.js', 'react-use-event-hook': 'pcdn:react-use-event-hook@0.9.6/dist/esm/useEvent.js', }, // packages tells the System loader how to load when no filename and/or no extension packages: { src: { defaultExtension: 'jsx', }, node_modules: { defaultExtension: 'js', }, }, }); })(this);