UndoStack (React)

The UndoStack class lets you add and undo/redo stack to a page, a form, or any element.

It tracks changes to regular HTML input elements as well as most Wijmo controls, handles the undo/redo keys automatically, and provides commands for executing undo and redo actions programmatically.

Learn about Wijmo | UndoStack API Reference

This example uses React.

import 'bootstrap.css'; import '@mescius/wijmo.styles/wijmo.css'; import React, { useEffect, useRef, useState } from 'react'; import * as ReactDOM from 'react-dom/client'; import { ComboBox, InputNumber, InputDate, AutoComplete, MultiAutoComplete, MultiSelect } from '@mescius/wijmo.react.input'; import { RadialGauge } from '@mescius/wijmo.react.gauge'; import { FlexGrid } from '@mescius/wijmo.react.grid'; import { CellRangeEventArgs } from '@mescius/wijmo.grid'; import { UndoStack } from '@mescius/wijmo.undo'; import './app.css'; import { colors, countries, names, data } from './data'; function App() { const [canUndo, setCanUndo] = useState(false); const [canRedo, setCanRedo] = useState(false); const [actionCount, setActionCount] = useState(0); const undoStackRef = useRef(null); const gridRef = useRef(null); const countryCombo = useRef(null); const inputNumber = useRef(null); const inputDate = useRef(null); const colorCombo = useRef(null); const autoComplete = useRef(null); const multiAutoComplete = useRef(null); const gauge = useRef(null); // enable undo/redo for the form useEffect(() => { undoStackRef.current = new UndoStack('#undoable-form', { maxActions: 50, stateChanged: (s) => { setCanUndo(s.canUndo); setCanRedo(s.canRedo); setActionCount(s.actionCount); } }); countryCombo.current.control.selectedIndex = -1; inputNumber.current.control.value = null; inputDate.current.control.value = null; colorCombo.current.control.selectedIndex = -1; autoComplete.current.control.selectedIndex = -1; gauge.current.control.value = 50; }, []); return (<div className="container-fluid"> {/* undo toolbar */} <div className="toolbar"> <button id="undo" className="btn btn-primary" disabled={!canUndo} onClick={() => { var _a; return (_a = undoStackRef.current) === null || _a === void 0 ? void 0 : _a.undo(); }}> <span className="arrow">&#x21B6;</span> Undo (ctrl+Z) </button>{' '} <button id="redo" className="btn btn-primary" disabled={!canRedo} onClick={() => { var _a; return (_a = undoStackRef.current) === null || _a === void 0 ? void 0 : _a.redo(); }}> <span className="arrow">&#x21B7;</span> Redo (ctrl+Y) </button>{' '} <button className="btn" disabled> Action Count: {actionCount} </button>{' '} <button id="clear" className="btn btn-default" disabled={!actionCount} onClick={() => { var _a; return (_a = undoStackRef.current) === null || _a === void 0 ? void 0 : _a.clear(); }}> Clear Undo/Redo Stack </button> </div> {/* undoable form */} <form id="undoable-form"> <div className="row"> {/* HTML input elements */} <div className="col-md-5"> <h3>HTML Input Elements</h3> <div className="form-group"> <label htmlFor="firstName">First Name</label> <input id="firstName" className="form-control" placeholder="First Name"/> </div> <div className="form-group"> <label htmlFor="lastName">Last Name</label> <input id="lastName" className="form-control" placeholder="Last Name"/> </div> <div className="form-group"> <label htmlFor="select">Select</label> <select id="select" className="form-control" defaultValue={"value2"}> <option value="value1">Apples</option> <option value="value2">Oranges</option> <option value="value3">Grapes</option> </select> </div> <div className="form-group"> <label htmlFor="area">TextArea</label> <textarea id="area" className="form-control" placeholder="textarea"></textarea> </div> <div className="form-group label-indent"> <label className="checkbox-inline"> <input type="checkbox" value="red" defaultChecked={true}/> Red </label> <label className="checkbox-inline"> <input type="checkbox" value="green"/> Green </label> <label className="checkbox-inline"> <input type="checkbox" value="blue"/> Blue </label> </div> <div className="form-group label-indent"> <label className="radio-inline"> <input type="radio" name="radio" value="hot" defaultChecked={true}/> Hot </label> <label className="radio-inline"> <input type="radio" name="radio" value="cold"/> Cold </label> <label className="radio-inline"> <input type="radio" name="radio" value="medium"/> Medium </label> </div> </div> {/* Wijmo controls */} <div className="col-md-7"> <h3>Wijmo Controls</h3> <div className="form-group"> <label htmlFor="country">Country</label> <ComboBox ref={countryCombo} id="country" placeholder="Country" itemsSource={countries} isRequired={false}/> </div> <div className="form-group"> <label htmlFor="amount">Amount</label> <InputNumber ref={inputNumber} id="amount" placeholder="Amount" format="c2" min={0} step={10} isRequired={false}/> </div> <div className="form-group"> <label htmlFor="date">Date</label> <InputDate ref={inputDate} id="date" placeholder="Date" isRequired={false}/> </div> <div className="form-group"> <label htmlFor="color" title="ComboBox">Color</label> <ComboBox ref={colorCombo} id="color" itemsSource={colors} isRequired={false}/> </div> <div className="form-group"> <label htmlFor="ac" title="AutoComplete">Color</label> <AutoComplete ref={autoComplete} id="ac" itemsSource={colors}/> </div> <div className="form-group"> <label htmlFor="colors" title="MultiSelect">Colors</label> <MultiSelect id="colors" itemsSource={colors}/> </div> <div className="form-group"> <label htmlFor="mac" title="MultiAutoComplete">Colors</label> <MultiAutoComplete id="mac" itemsSource={colors} selectedIndex={-1}/> </div> <div className="form-group"> <label htmlFor="gauge">Gauge</label> <RadialGauge ref={gauge} thickness={.2} min={0} max={100} isReadOnly={false} tickSpacing={10} showTicks={true} showText="Value" needleShape="Outer" needleLength="Inner"/> </div> <div className="form-group"> <label htmlFor="grid">Grid</label> <FlexGrid id="grid" anchorCursor={true} frozenColumns={2} allowAddNew={true} allowDelete={true} itemsSource={data} initialized={(s) => { // save reference to grid gridRef.current = s; // add data maps to some columns let col = s.getColumn('name'); col.dataMap = names; col.dataMap.isEditable = true; col = s.getColumn('country'); col.dataMap = countries; }}/> <button type="button" id="add-row" className="btn btn-primary" onClick={(e) => { let g = gridRef.current; if (g) { let view = g.editableCollectionView, newItem = view.addNew(); g.focus(); newItem.id = -1; newItem.name = 'new item'; newItem.active = true; g.onRowAdded(new CellRangeEventArgs(g.cells, g.selection)); // create undoable action view.commitNew(); } e.preventDefault(); // don't submit the form }}> Add Row in Code </button>{' '} <button type="button" id="del-row" className="btn btn-primary" onClick={(e) => { let g = gridRef.current; if (g) { let view = g.editableCollectionView; g.focus(); if (view.items.length) { let sel = g.selection; if (sel.row > -1) { let item = g.rows[sel.row].dataItem; g.onDeletingRow(new CellRangeEventArgs(g.cells, g.selection)); // create undoable action view.remove(item); } } } e.preventDefault(); // don't submit the form }}> Delete Row in Code </button>{' '} <label> New Row At Top{' '} <input id="nr-top" className="wj-no-undo" type="checkbox" onChange={e => { if (gridRef.current) { gridRef.current.newRowAtTop = e.target.checked; } }}/> </label> </div> </div> </div> </form> </div>); } setTimeout(() => { const container = document.getElementById('app'); if (container) { const root = ReactDOM.createRoot(container); root.render(<App />); } }, 100);
<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>MESCIUS Wijmo UndoStack</title> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <!-- SystemJS --> <script src="https://cdnjs.cloudflare.com/ajax/libs/systemjs/0.19.40/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>
.toolbar { position: sticky; top: 0; z-index: 10; padding: 12px; margin-left: -12px; background: #eee; } .arrow { display: inline-block; transform: scale(2); margin-right: 8px; } .form-group label { min-width: 100px; text-align: right; margin-right: 12px; } .label-indent { margin-left: 100px; } .label-indent label { min-width: 0; } .form-control { display: inline-block; width: auto; } .btn { outline: none !important; } .wj-dropdown, .wj-inputnumber { width: 200px; } .wj-multi-autocomplete { width: 300px; } .wj-flexgrid { height: 250px; } .wj-radialgauge { display: inline-block; width: 200px; } .wj-gauge .wj-needle { fill: orangered; stroke: orangered; } .wj-gauge .wj-needle .wj-inner-needle-cap { fill: white; }
// create some data const getColors = () => { return 'Black,Blue,Brown,Green,Magenta,Orange,Pink,Purple,Red,Teal,Violet,White,Yellow'.split(','); }; const getCountries = () => { return ['US', 'Germany', 'UK', 'Japan', 'Italy', 'Greece']; }; const getNames = () => { return 'Abe,Bob,Chuck,Dan,Ed,Fred'.split(','); }; const getData = () => { let countries = getCountries(), names = getNames(), data = []; for (let i = 0; i < 50; i++) { data.push({ id: i, name: names[i % names.length], country: countries[i % countries.length], active: i % 5 != 0, downloads: Math.round(Math.random() * 200000), sales: Math.round(Math.random() * 20000), }); } return data; }; export const colors = getColors(); export const countries = getCountries(); export const names = getNames(); 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/' }, // map tells the System loader where to look for things map: { 'jszip': 'npm:jszip/dist/jszip.js', '@mescius/wijmo': 'npm:@mescius/wijmo/index.js', '@mescius/wijmo.input': 'npm:@mescius/wijmo.input/index.js', '@mescius/wijmo.styles': 'npm:@mescius/wijmo.styles', '@mescius/wijmo.cultures': 'npm:@mescius/wijmo.cultures', '@mescius/wijmo.chart': 'npm:@mescius/wijmo.chart/index.js', '@mescius/wijmo.chart.analytics': 'npm:@mescius/wijmo.chart.analytics/index.js', '@mescius/wijmo.chart.animation': 'npm:@mescius/wijmo.chart.animation/index.js', '@mescius/wijmo.chart.annotation': 'npm:@mescius/wijmo.chart.annotation/index.js', '@mescius/wijmo.chart.finance': 'npm:@mescius/wijmo.chart.finance/index.js', '@mescius/wijmo.chart.finance.analytics': 'npm:@mescius/wijmo.chart.finance.analytics/index.js', '@mescius/wijmo.chart.hierarchical': 'npm:@mescius/wijmo.chart.hierarchical/index.js', '@mescius/wijmo.chart.interaction': 'npm:@mescius/wijmo.chart.interaction/index.js', '@mescius/wijmo.chart.radar': 'npm:@mescius/wijmo.chart.radar/index.js', '@mescius/wijmo.chart.render': 'npm:@mescius/wijmo.chart.render/index.js', '@mescius/wijmo.chart.webgl': 'npm:@mescius/wijmo.chart.webgl/index.js', '@mescius/wijmo.chart.map': 'npm:@mescius/wijmo.chart.map/index.js', '@mescius/wijmo.gauge': 'npm:@mescius/wijmo.gauge/index.js', '@mescius/wijmo.grid': 'npm:@mescius/wijmo.grid/index.js', '@mescius/wijmo.grid.detail': 'npm:@mescius/wijmo.grid.detail/index.js', '@mescius/wijmo.grid.filter': 'npm:@mescius/wijmo.grid.filter/index.js', '@mescius/wijmo.grid.search': 'npm:@mescius/wijmo.grid.search/index.js', '@mescius/wijmo.grid.style': 'npm:@mescius/wijmo.grid.style/index.js', '@mescius/wijmo.grid.grouppanel': 'npm:@mescius/wijmo.grid.grouppanel/index.js', '@mescius/wijmo.grid.multirow': 'npm:@mescius/wijmo.grid.multirow/index.js', '@mescius/wijmo.grid.transposed': 'npm:@mescius/wijmo.grid.transposed/index.js', '@mescius/wijmo.grid.transposedmultirow': 'npm:@mescius/wijmo.grid.transposedmultirow/index.js', '@mescius/wijmo.grid.pdf': 'npm:@mescius/wijmo.grid.pdf/index.js', '@mescius/wijmo.grid.sheet': 'npm:@mescius/wijmo.grid.sheet/index.js', '@mescius/wijmo.grid.xlsx': 'npm:@mescius/wijmo.grid.xlsx/index.js', '@mescius/wijmo.grid.selector': 'npm:@mescius/wijmo.grid.selector/index.js', '@mescius/wijmo.grid.cellmaker': 'npm:@mescius/wijmo.grid.cellmaker/index.js', '@mescius/wijmo.grid.immutable': 'npm:@mescius/wijmo.grid.immutable/index.js', '@mescius/wijmo.touch': 'npm:@mescius/wijmo.touch/index.js', '@mescius/wijmo.cloud': 'npm:@mescius/wijmo.cloud/index.js', '@mescius/wijmo.nav': 'npm:@mescius/wijmo.nav/index.js', '@mescius/wijmo.odata': 'npm:@mescius/wijmo.odata/index.js', '@mescius/wijmo.olap': 'npm:@mescius/wijmo.olap/index.js', '@mescius/wijmo.rest': 'npm:@mescius/wijmo.rest/index.js', '@mescius/wijmo.pdf': 'npm:@mescius/wijmo.pdf/index.js', '@mescius/wijmo.pdf.security': 'npm:@mescius/wijmo.pdf.security/index.js', '@mescius/wijmo.viewer': 'npm:@mescius/wijmo.viewer/index.js', '@mescius/wijmo.xlsx': 'npm:@mescius/wijmo.xlsx/index.js', '@mescius/wijmo.undo': 'npm:@mescius/wijmo.undo/index.js', '@mescius/wijmo.interop.grid': 'npm:@mescius/wijmo.interop.grid/index.js', '@mescius/wijmo.barcode': 'npm:@mescius/wijmo.barcode/index.js', '@mescius/wijmo.barcode.common': 'npm:@mescius/wijmo.barcode.common/index.js', '@mescius/wijmo.barcode.composite': 'npm:@mescius/wijmo.barcode.composite/index.js', '@mescius/wijmo.barcode.specialized': 'npm:@mescius/wijmo.barcode.specialized/index.js', "@mescius/wijmo.react.chart.analytics": "npm:@mescius/wijmo.react.chart.analytics/index.js", "@mescius/wijmo.react.chart.animation": "npm:@mescius/wijmo.react.chart.animation/index.js", "@mescius/wijmo.react.chart.annotation": "npm:@mescius/wijmo.react.chart.annotation/index.js", "@mescius/wijmo.react.chart.finance.analytics": "npm:@mescius/wijmo.react.chart.finance.analytics/index.js", "@mescius/wijmo.react.chart.finance": "npm:@mescius/wijmo.react.chart.finance/index.js", "@mescius/wijmo.react.chart.hierarchical": "npm:@mescius/wijmo.react.chart.hierarchical/index.js", "@mescius/wijmo.react.chart.interaction": "npm:@mescius/wijmo.react.chart.interaction/index.js", "@mescius/wijmo.react.chart.radar": "npm:@mescius/wijmo.react.chart.radar/index.js", "@mescius/wijmo.react.chart": "npm:@mescius/wijmo.react.chart/index.js", "@mescius/wijmo.react.core": "npm:@mescius/wijmo.react.core/index.js", '@mescius/wijmo.react.chart.map': 'npm:@mescius/wijmo.react.chart.map/index.js', "@mescius/wijmo.react.gauge": "npm:@mescius/wijmo.react.gauge/index.js", "@mescius/wijmo.react.grid.detail": "npm:@mescius/wijmo.react.grid.detail/index.js", "@mescius/wijmo.react.grid.filter": "npm:@mescius/wijmo.react.grid.filter/index.js", "@mescius/wijmo.react.grid.grouppanel": "npm:@mescius/wijmo.react.grid.grouppanel/index.js", '@mescius/wijmo.react.grid.search': 'npm:@mescius/wijmo.react.grid.search/index.js', "@mescius/wijmo.react.grid.multirow": "npm:@mescius/wijmo.react.grid.multirow/index.js", "@mescius/wijmo.react.grid.sheet": "npm:@mescius/wijmo.react.grid.sheet/index.js", '@mescius/wijmo.react.grid.transposed': 'npm:@mescius/wijmo.react.grid.transposed/index.js', '@mescius/wijmo.react.grid.transposedmultirow': 'npm:@mescius/wijmo.react.grid.transposedmultirow/index.js', '@mescius/wijmo.react.grid.immutable': 'npm:@mescius/wijmo.react.grid.immutable/index.js', "@mescius/wijmo.react.grid": "npm:@mescius/wijmo.react.grid/index.js", "@mescius/wijmo.react.input": "npm:@mescius/wijmo.react.input/index.js", "@mescius/wijmo.react.olap": "npm:@mescius/wijmo.react.olap/index.js", "@mescius/wijmo.react.viewer": "npm:@mescius/wijmo.react.viewer/index.js", "@mescius/wijmo.react.nav": "npm:@mescius/wijmo.react.nav/index.js", "@mescius/wijmo.react.base": "npm:@mescius/wijmo.react.base/index.js", '@mescius/wijmo.react.barcode.common': 'npm:@mescius/wijmo.react.barcode.common/index.js', '@mescius/wijmo.react.barcode.composite': 'npm:@mescius/wijmo.react.barcode.composite/index.js', '@mescius/wijmo.react.barcode.specialized': 'npm:@mescius/wijmo.react.barcode.specialized/index.js', 'jszip': 'npm:jszip/dist/jszip.js', 'react': 'npm:react/index.js', 'react-dom': 'npm:react-dom/index.js', 'react-dom/client': 'npm:react-dom/client.js', "scheduler": "npm:scheduler/index.js", 'redux': 'npm:redux/dist/redux.min.js', 'react-redux': 'npm:react-redux/dist/react-redux.min.js', 'bootstrap.css': 'npm:bootstrap/dist/css/bootstrap.min.css', 'css': 'npm:systemjs-plugin-css/css.js', 'plugin-babel': 'npm:systemjs-plugin-babel/plugin-babel.js', 'systemjs-babel-build':'npm:systemjs-plugin-babel/systemjs-babel-browser.js', "react-use-event-hook": "npm:react-use-event-hook/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);