UndoStack (Angular)

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 Angular.

import 'bootstrap.css'; import '@mescius/wijmo.styles/wijmo.css'; import './styles.css'; import '@angular/compiler'; import { Component, enableProdMode, ViewChild, ɵresolveComponentResources } from '@angular/core'; import { BrowserModule, bootstrapApplication } from '@angular/platform-browser'; import { WjInputModule } from '@mescius/wijmo.angular2.input'; import { WjGridModule } from '@mescius/wijmo.angular2.grid'; import { WjGaugeModule } from '@mescius/wijmo.angular2.gauge'; import { UndoStack } from '@mescius/wijmo.undo'; import { FlexGrid, CellRangeEventArgs } from '@mescius/wijmo.grid'; @Component({ standalone: true, imports: [WjInputModule, WjGridModule, WjGaugeModule, BrowserModule], selector: 'app-component', templateUrl: 'src/app.component.html' }) export class AppComponent { undoStack: UndoStack; grid: FlexGrid; data = this.getData(); colors =this.getColors(); countries = this.getCountries(); names = this.getNames(); canUndo = false; canRedo = false; actionCount = 0; // enable undo/redo for the form // use ngAfterViewInit to ensure all controls // have been initalized (ngOnInit is too soon) ngAfterViewInit() { this.undoStack = new UndoStack('#undoable-form', { maxActions: 50, stateChanged: (s: UndoStack) => { this.canUndo = s.canUndo; this.canRedo = s.canRedo; this.actionCount = s.actionCount; } }); } // initialize the grid initGrid(s: FlexGrid) { // save reference to the grid this.grid = s; // add data maps to some columns let col = s.getColumn('name'); col.dataMap = this.names as any; col.dataMap.isEditable = true; col = s.getColumn('country'); col.dataMap = this.countries as any; } // add a row in code, calling "onRowAdded" to enable undo for this action addRow(e: MouseEvent) { let g = this.grid, 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 } // delete a row in code, calling "onDeletingRow" to enable undo for this action deleteRow(e: MouseEvent) { let g = this.grid, 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 } // provide some data for the sample getColors() { return 'Black,Blue,Brown,Green,Magenta,Orange,Pink,Purple,Red,Teal,Violet,White,Yellow'.split(','); } getCountries() { return 'US,Germany,UK,Japan,Italy,Greece'.split(','); } getNames() { return 'Abe,Bob,Chuck,Dan,Ed,Fred'.split(','); } getData() { let countries = this.getCountries(), names = this.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; } } enableProdMode(); // Resolve resources (templateUrl, styleUrls etc), After resolution all URLs have been converted into `template` strings. ɵresolveComponentResources(fetch).then(() => { // Bootstrap application bootstrapApplication(AppComponent).catch(err => console.error(err)); });
<!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"> <!-- Polyfills --> <script src="node_modules/core-js/client/shim.min.js"></script> <script src="node_modules/zone.js/fesm2015/zone.min.js"></script> <!-- SystemJS --> <script src="https://cdnjs.cloudflare.com/ajax/libs/systemjs/0.21.5/system.src.js" integrity="sha512-skZbMyvYdNoZfLmiGn5ii6KmklM82rYX2uWctBhzaXPxJgiv4XBwJnFGr5k8s+6tE1pcR1nuTKghozJHyzMcoA==" crossorigin="anonymous"></script> <script src="systemjs.config.js"></script> <script> // workaround to load 'rxjs/operators' from the rxjs bundle System.import('rxjs').then(function (m) { System.set(SystemJS.resolveSync('rxjs/operators'), System.newModule(m.operators)); System.import('./src/app.component'); }); </script> </head> <body> <app-component></app-component> </body> </html>
<div class="container-fluid"> <!-- undo/redo toolbar --> <div class="toolbar"> <button id="undo" class="btn btn-primary" [disabled]="!canUndo" (click)="undoStack.undo()"> <span class="arrow">&#x21B6;</span> Undo (ctrl+Z) </button> <button id="redo" class="btn btn-primary" [disabled]="!canRedo" (click)="undoStack.redo()"> <span class="arrow">&#x21B7;</span> Redo (ctrl+Y) </button> <button class="btn" disabled> Action Count: {{actionCount}} </button> <button id="clear" class="btn btn-default" [disabled]="!actionCount" (click)="undoStack.clear()"> Clear Undo/Redo Stack </button> </div> <!-- undo/redo form --> <form id="undoable-form"> <div class="row"> <!-- HTML input elements --> <div class="col-md-5"> <h3>HTML Input Elements</h3> <div class="form-group"> <label for="firstName">First Name</label> <input id="firstName" class="form-control" placeholder="First Name" /> </div> <div class="form-group"> <label for="lastName">Last Name</label> <input id="lastName" class="form-control" placeholder="Last Name"/> </div> <div class="form-group"> <label for="select">Select</label> <select id="select" class="form-control"> <option value="value1">Apples</option> <option value="value2" selected>Oranges</option> <option value="value3">Grapes</option> </select> </div> <div class="form-group"> <label for="area">TextArea</label> <textarea id="area" class="form-control" placeholder="textarea"></textarea> </div> <div class="form-group label-indent"> <label class="checkbox-inline"> <input type="checkbox" id="inlineCheckbox1" value="option1" checked> Red </label> <label class="checkbox-inline"> <input type="checkbox" id="inlineCheckbox2" value="option2"> Green </label> <label class="checkbox-inline"> <input type="checkbox" id="inlineCheckbox3" value="option3"> Blue </label> </div> <div class="form-group label-indent"> <label class="radio-inline"> <input type="radio" name="inlineRadioOptions" id="inlineRadio1" value="option1" checked> Hot </label> <label class="radio-inline"> <input type="radio" name="inlineRadioOptions" id="inlineRadio2" value="option2"> Cold </label> <label class="radio-inline"> <input type="radio" name="inlineRadioOptions" id="inlineRadio3" value="option3"> Medium </label> </div> </div> <!-- Wijmo controls --> <div class="col-md-7"> <h3>Wijmo Controls</h3> <div class="form-group"> <label for="country">Country</label> <wj-combo-box id="country" placeholder="Country" [itemsSource]="countries" [isRequired]="false" [selectedIndex]="-1"> </wj-combo-box> </div> <div class="form-group"> <label for="amount">Amount</label> <wj-input-number id="amount" placeholder="Amount" [format]="'c2'" [min]="0" [step]="10" [isRequired]="false" [value]="null"> </wj-input-number> </div> <div class="form-group"> <label for="date">Date</label> <wj-input-date id="date" placeholder="Date" [isRequired]="false" [value]="null"> </wj-input-date> </div> <div class="form-group"> <label for="color" title="ComboBox">Color</label> <wj-combo-box id="color" [itemsSource]="colors" [isRequired]="false" [selectedIndex]="-1"> </wj-combo-box> </div> <div class="form-group"> <label for="ac" title="AutoComplete">Color</label> <wj-auto-complete id="ac" [itemsSource]="colors" [selectedIndex]="-1"> </wj-auto-complete> </div> <div class="form-group"> <label for="colors" title="MultiSelect">Colors</label> <wj-multi-select id="colors" [itemsSource]="colors"> </wj-multi-select> </div> <div class="form-group"> <label for="mac" title="MultiAutoComplete">Colors</label> <wj-multi-auto-complete id="mac" [itemsSource]="colors" [selectedIndex]="-1"> </wj-multi-auto-complete> </div> <div class="form-group"> <label for="gauge">Gauge</label> <wj-radial-gauge [thickness]=".2" [min]="0" [max]="100" [value]="50" [isReadOnly]="false" [tickSpacing]="10" [showTicks]="true" [showText]="'Value'" [needleShape]="'Outer'" [needleLength]="'Inner'"> </wj-radial-gauge> </div> <div class="form-group"> <label for="grid">Grid</label> <wj-flex-grid div id="grid" #theGrid [anchorCursor]="true" [frozenColumns]="2" [allowAddNew]="true" [allowDelete]="true" [itemsSource]="data" (initialized)="initGrid(theGrid)"> </wj-flex-grid> <button type="button" id="add-row" class="btn btn-primary" (click)="addRow($event)"> Add Row in Code </button> <button type="button" id="del-row" class="btn btn-primary" (click)="deleteRow($event)"> Delete Row in Code </button> <label> New Row At Top <input id="nr-top" class="wj-no-undo" type="checkbox" [checked]="grid && grid.newRowAtTop" (change)="grid.newRowAtTop = !grid.newRowAtTop"> </label> </div> </div> </div> </form> </div>
.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; margin-right: 6px; } .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; }
(function (global) { SystemJS.config({ transpiler: './plugin-typescript.js', typescriptOptions: { "target": "ES2022", "module": "system", "emitDecoratorMetadata": true, "experimentalDecorators": true, }, baseURL: 'node_modules/', meta: { 'typescript': { "exports": "ts" }, '*.css': { loader: 'systemjs-plugin-css' } }, paths: { // paths serve as alias 'npm:': '' }, packageConfigPaths: [ '/node_modules/*/package.json', "/node_modules/@angular/*/package.json", "/node_modules/@mescius/*/package.json" ], map: { 'core-js': 'https://cdn.jsdelivr.net/npm/core-js@2.6.12/client/shim.min.js', 'typescript': 'https://cdnjs.cloudflare.com/ajax/libs/typescript/5.2.2/typescript.min.js', "rxjs": "https://cdnjs.cloudflare.com/ajax/libs/rxjs/7.8.1/rxjs.umd.min.js", 'systemjs-plugin-css': 'https://cdn.jsdelivr.net/npm/systemjs-plugin-css@0.1.37/css.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.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.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.touch': 'npm:@mescius/wijmo.touch/index.js', '@mescius/wijmo.cloud': 'npm:@mescius/wijmo.cloud/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.angular2.chart.analytics": "npm:@mescius/wijmo.angular2.chart.analytics/index.js", "@mescius/wijmo.angular2.chart.animation": "npm:@mescius/wijmo.angular2.chart.animation/index.js", "@mescius/wijmo.angular2.chart.annotation": "npm:@mescius/wijmo.angular2.chart.annotation/index.js", "@mescius/wijmo.angular2.chart.finance.analytics": "npm:@mescius/wijmo.angular2.chart.finance.analytics/index.js", "@mescius/wijmo.angular2.chart.finance": "npm:@mescius/wijmo.angular2.chart.finance/index.js", "@mescius/wijmo.angular2.chart.hierarchical": "npm:@mescius/wijmo.angular2.chart.hierarchical/index.js", "@mescius/wijmo.angular2.chart.interaction": "npm:@mescius/wijmo.angular2.chart.interaction/index.js", "@mescius/wijmo.angular2.chart.radar": "npm:@mescius/wijmo.angular2.chart.radar/index.js", '@mescius/wijmo.angular2.chart.map': 'npm:@mescius/wijmo.angular2.chart.map/index.js', "@mescius/wijmo.angular2.chart": "npm:@mescius/wijmo.angular2.chart/index.js", "@mescius/wijmo.angular2.core": "npm:@mescius/wijmo.angular2.core/index.js", "@mescius/wijmo.angular2.gauge": "npm:@mescius/wijmo.angular2.gauge/index.js", "@mescius/wijmo.angular2.grid.detail": "npm:@mescius/wijmo.angular2.grid.detail/index.js", "@mescius/wijmo.angular2.grid.filter": "npm:@mescius/wijmo.angular2.grid.filter/index.js", "@mescius/wijmo.angular2.grid.grouppanel": "npm:@mescius/wijmo.angular2.grid.grouppanel/index.js", "@mescius/wijmo.angular2.grid.search": "npm:@mescius/wijmo.angular2.grid.search/index.js", "@mescius/wijmo.angular2.grid.multirow": "npm:@mescius/wijmo.angular2.grid.multirow/index.js", "@mescius/wijmo.angular2.grid.sheet": "npm:@mescius/wijmo.angular2.grid.sheet/index.js", '@mescius/wijmo.angular2.grid.transposed': 'npm:@mescius/wijmo.angular2.grid.transposed/index.js', '@mescius/wijmo.angular2.grid.transposedmultirow': 'npm:@mescius/wijmo.angular2.grid.transposedmultirow/index.js', "@mescius/wijmo.angular2.grid": "npm:@mescius/wijmo.angular2.grid/index.js", "@mescius/wijmo.angular2.input": "npm:@mescius/wijmo.angular2.input/index.js", "@mescius/wijmo.angular2.olap": "npm:@mescius/wijmo.angular2.olap/index.js", "@mescius/wijmo.angular2.viewer": "npm:@mescius/wijmo.angular2.viewer/index.js", "@mescius/wijmo.angular2.nav": "npm:@mescius/wijmo.angular2.nav/index.js", "@mescius/wijmo.angular2.directivebase": "npm:@mescius/wijmo.angular2.directivebase/index.js", '@mescius/wijmo.angular2.barcode.common': 'npm:@mescius/wijmo.angular2.barcode.common/index.js', '@mescius/wijmo.angular2.barcode.composite': 'npm:@mescius/wijmo.angular2.barcode.composite/index.js', '@mescius/wijmo.angular2.barcode.specialized': 'npm:@mescius/wijmo.angular2.barcode.specialized/index.js', 'bootstrap.css': 'npm:bootstrap/dist/css/bootstrap.min.css', 'jszip': 'https://cdnjs.cloudflare.com/ajax/libs/jszip/3.10.1/jszip.min.js', "@angular/common/http": "https://cdn.jsdelivr.net/npm/@angular/common@16.2.6/fesm2022/http.mjs", "@angular/core": "https://cdn.jsdelivr.net/npm/@angular/core@16.2.6/fesm2022/core.mjs", "@angular/platform-browser": "https://cdn.jsdelivr.net/npm/@angular/platform-browser@16.2.6/fesm2022/platform-browser.mjs", "@angular/common": "https://cdn.jsdelivr.net/npm/@angular/common@16.2.6/fesm2022/common.mjs", "@angular/compiler": "https://cdn.jsdelivr.net/npm/@angular/compiler@16.2.6/fesm2022/compiler.mjs", "@angular/forms": "https://cdn.jsdelivr.net/npm/@angular/forms@16.2.6/fesm2022/forms.mjs", "@angular/localize": "https://cdn.jsdelivr.net/npm/@angular/localize@16.2.6/fesm2022/localize.mjs", "@angular/platform-browser-dynamic": "https://cdn.jsdelivr.net/npm/@angular/platform-browser-dynamic@16.2.6/fesm2022/platform-browser-dynamic.mjs", }, // packages tells the System loader how to load when no filename and/or no extension packages: { "./src": { defaultExtension: 'ts' }, "node_modules": { defaultExtension: 'js' }, wijmo: { defaultExtension: 'js', } } }); })(this);