Vue Data Grid - Edit State Management

Our DataGrid component manages its edit state automatically. If your use case requires full control over the editing process, you can use the API members below to manage state manually. In this demo, we manage state with a help of the Vuex library.

Was this demo helpful?

Thank you!

Feel free to share demo-related thoughts here.
If you have technical questions, please create a support ticket in the DevExpress Support Center.

Thank you for the feedback!

Backend API

<template> <div> <DxLoadPanel :position="loadPanelPosition" :visible="isLoading" /> <DxDataGrid id="gridContainer" key-expr="OrderID" :data-source="orders" :show-borders="true" :repaint-changes-only="true" @saving="onSaving" > <DxEditing mode="row" :allow-adding="true" :allow-deleting="true" :allow-updating="true" v-model:changes="changes" v-model:edit-row-key="editRowKey" /> <DxColumn data-field="OrderID" :allow-editing="false" /> <DxColumn data-field="ShipName"/> <DxColumn data-field="ShipCountry"/> <DxColumn data-field="ShipCity"/> <DxColumn data-field="ShipAddress"/> <DxColumn data-field="OrderDate" data-type="date" /> <DxColumn data-field="Freight"/> </DxDataGrid> <div class="options"> <div class="caption">Options</div> <div class="option"> <span>Edit Row Key:</span> <div id="editRowKey">{{ editRowKey === null ? "null" : editRowKey.toString() }}</div> </div> <div class="option"> <span>Changes:</span> <div id="changes">{{ changesText }}</div> </div> </div> </div> </template> <script setup lang="ts"> import { computed } from 'vue'; import { useStore } from 'vuex'; import { DxDataGrid, DxColumn, DxEditing, DxDataGridTypes, } from 'devextreme-vue/data-grid'; import { DxLoadPanel } from 'devextreme-vue/load-panel'; import { State } from './store.ts'; const loadPanelPosition = { of: '#gridContainer' }; // eslint-disable-next-line react-hooks/rules-of-hooks const store = useStore<State>(); const loadOrders = () => store.dispatch('loadOrders'); const setEditRowKey = (value: number | null) => store.dispatch('setEditRowKey', value); const setChanges = (value: DxDataGridTypes.DataChange[]) => store.dispatch('setChanges', value); const saveChange = (change: DxDataGridTypes.DataChange) => store.dispatch('saveChange', change); const orders = computed(() => store.state.orders); const isLoading = computed(() => store.state.isLoading); const changes = computed({ get: () => (store.state.changes), set: (value) => { setChanges(value); }, }); const editRowKey = computed({ get: () => store.state.editRowKey, set: (value) => { setEditRowKey(value); }, }); const changesText = computed(() => JSON.stringify(changes.value.map((change) => ({ type: change.type, key: change.type !== 'insert' ? change.key : undefined, data: change.data, })), null, ' ')); const onSaving = (e: DxDataGridTypes.SavingEvent) => { e.cancel = true; e.promise = saveChange(e.changes[0]); }; loadOrders(); </script> <style scoped> #gridContainer { height: 440px; } .options { padding: 20px; margin-top: 20px; background-color: rgba(191, 191, 191, 0.15); } .caption { margin-bottom: 10px; font-weight: 500; font-size: 18px; } .option { margin-bottom: 10px; } .option > span { position: relative; margin-right: 14px; } .option > div { display: inline-block; font-weight: bold; } </style>

export type Order = { OrderID: number; ShipName: string; ShipCountry: string; ShipCity: string; ShipAddress: string; OrderDate: string; Freight: number; };

import { createApp } from 'vue'; import App from './App.vue'; import store from './store.ts'; createApp(App).use(store).mount('#app');

import { createStore } from 'vuex'; import 'whatwg-fetch'; import applyChanges from 'devextreme/data/apply_changes'; import { DataChange } from 'devextreme/ui/data_grid'; // @ts-expect-error due to specific build options need to add .ts extension import { sendRequest } from './utils.ts'; // @ts-expect-error due to specific build options need to add .ts extension import { Order } from './data.ts'; const URL = 'https://js.devexpress.com/Demos/Mvc/api/DataGridWebApi'; export type State = { orders: Order[], changes: DataChange[], editRowKey: number | null, isLoading: boolean, }; export default createStore<State>({ state: { orders: [], changes: [], editRowKey: null, isLoading: false, }, mutations: { updateIsLoading(state, isLoading: boolean) { state.isLoading = isLoading; }, updateEditRowKey(state, editRowKey: number | null) { state.editRowKey = editRowKey; }, updateChanges(state, changes: DataChange[]) { state.changes = changes; }, updateOrders(state, orders: Order[]) { state.orders = orders; }, applyChangeToOrders(state, payload: { change: DataChange, data: Order }) { const { change, data } = payload; change.data = data; state.orders = applyChanges(state.orders, [change], { keyExpr: 'OrderID' }); }, }, actions: { setEditRowKey(context, value: number | null) { context.commit('updateEditRowKey', value); }, setChanges(context, value: DataChange[]) { context.commit('updateChanges', value); }, async loadOrders(context) { context.commit('updateIsLoading', true); try { const { data: orders } = await sendRequest(`${URL}/Orders?skip=700`); context.commit('updateOrders', orders); } finally { context.commit('updateIsLoading', false); } }, async insert(context, change: DataChange) { const newOrder = await sendRequest(`${URL}/InsertOrder`, 'POST', { values: JSON.stringify(change.data), }); context.commit('applyChangeToOrders', { change, data: newOrder }); }, async update(context, change: DataChange) { const updatedOrder = await sendRequest(`${URL}/UpdateOrder`, 'PUT', { key: change.key, values: JSON.stringify(change.data), }); context.commit('applyChangeToOrders', { change, data: updatedOrder }); }, async remove(context, change: DataChange) { const data = await sendRequest(`${URL}/DeleteOrder`, 'DELETE', { key: change.key }); context.commit('applyChangeToOrders', { change, data }); }, async saveChange({ commit, dispatch }, change: DataChange) { if (change && change.type) { commit('updateIsLoading', true); try { await dispatch(change.type, change); } finally { commit('updateIsLoading', false); } } commit('updateEditRowKey', null); commit('updateChanges', []); }, }, });

export async function sendRequest(url: string, method = 'GET', data: Record<string, string> = {}) { const params = Object.keys(data) .map((key) => `${encodeURIComponent(key)}=${encodeURIComponent(data[key])}`) .join('&'); const result = await fetch(url, { method, body: params || null, headers: method === 'GET' ? {} : { 'Content-Type': 'application/x-www-form-urlencoded;charset=UTF-8' }, credentials: 'include', }); if (result.ok) { const text = await result.text(); return text && JSON.parse(text); } const json = await result.json(); throw json.Message; }

<!DOCTYPE html> <html lang="en"> <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=5.0" /> <link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/24.1.6/css/dx.light.css" /> <script type="module"> import * as vueCompilerSFC from "https://unpkg.com/@vue/compiler-sfc@3.4.16/dist/compiler-sfc.esm-browser.js"; window.vueCompilerSFC = vueCompilerSFC; </script> <script src="https://unpkg.com/typescript@4.9.5/lib/typescript.js"></script> <script src="https://unpkg.com/core-js@2.6.12/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.ts"); </script> </head> <body class="dx-viewport"> <div class="demo-container"> <div id="app" /> </div> </body> </html>

Component Properties

editing.editRowKey
The key for the row being edited.
editing.editColumnName
The name or data field of the column being edited.
editing.changes
Pending row changes.

Use these properties to access and change edit state. Two-way bind them to component properties so that you can get and set the properties at runtime. In this demo, we bind the editRowKey and changes properties to computed properties and display their values under the DataGrid.

Utility Method

DevExpress.data.applyChanges(data, changes, options)
Applies an array of changes to a source data array.

Event Handlers

onSaving / onSaved
Functions that are called before / after pending row changes are saved via the UI or programmatically.
onEditCanceling / onEditCanceled
Functions that are called before / after editing is canceled and pending row changes are discarded.

Use these functions to perform custom actions. In this demo, the onSaving function sends pending changes to a server. The function's parameter e contains fields for this capability. To implement the same in your application, follow these steps:

Disable built-in edit state management
Set the e.cancel field to true.
Send a request to the server
Pending changes are stored in the e.changes array. This array has only a single element in all edit modes, except for batch. Check if this element is not empty and send it to the server (see the saveChange action in store.js).
Apply the same changes to the DataGrid's data source
If the server successfully saves changes, call the applyChanges method to save the same changes in the DataGrid's data source (see the updateOrders mutation in store.js).
Reset edit state
Assign null to the editRowKey and an empty array to the changes property (see the updateEditRowKey and updateChanges mutations in store.js).