Matarialize中文技术社区-Material UI Data Grid - 编辑功能详解与使用示例

Material UI Data Grid - 编辑功能详解与使用示例

smartzeng 2024-10-11 14:14:09

105 Editing recipes 专栏

Material UI 的 Data Grid 组件提供了强大的编辑功能，使开发者能够轻松构建支持数据交互和动态更新的表格。本文将详细介绍 Data Grid 的编辑功能，包括基础编辑、单元格编辑、行内编辑和一些实用的编辑配置。通过多个详细示例，全面覆盖编辑属性、方法和与其他组件的结合使用。

1. 安装 Material UI 和 Data Grid

确保在项目中已经安装了 Material UI 和 Data Grid。可以通过 npm 或 yarn 安装：

npm install @mui/material @mui/x-data-grid

2. Data Grid 编辑模式概述

Data Grid 提供了不同的编辑模式，以满足表格数据的编辑需求，主要包括：

单元格编辑：用户直接在某个单元格中进行数据修改。
行内编辑：整个行进入编辑模式，允许用户在多个单元格之间编辑。
自定义编辑组件：为每个列提供定制化的编辑组件，例如选择框、日期选择器等。

主要编辑功能属性

editable：控制某一列是否可编辑。
processRowUpdate：处理行数据更新的回调函数。
onProcessRowUpdateError：处理行更新时出错的回调函数。
editMode：设置编辑模式为单元格编辑或行内编辑。
onCellEditStart / onCellEditStop：监听单元格编辑的开始和结束。
onRowEditStart / onRowEditStop：监听行内编辑的开始和结束。

3. 基础示例 - 单元格编辑

3.1 基本设置

在此示例中，我们将展示如何启用单元格编辑功能，用户可以直接编辑某些列的值。

import * as React from 'react';
import { DataGrid } from '@mui/x-data-grid';

const rows = [
  { id: 1, name: 'John Doe', age: 35 },
  { id: 2, name: 'Jane Smith', age: 28 },
  { id: 3, name: 'Jack White', age: 40 },
];

const columns = [
  { field: 'name', headerName: 'Name', width: 150, editable: true },
  { field: 'age', headerName: 'Age', width: 100, type: 'number', editable: true },
];

export default function EditableGrid() {
  return (
    <div style={{ height: 400, width: '100%' }}>
      <DataGrid
        rows={rows}
        columns={columns}
        pageSize={5}
        checkboxSelection
        disableSelectionOnClick
      />
    </div>
  );
}

3.2 说明

editable: true：我们在列定义中使用此属性标记该列为可编辑。
用户可以直接点击某个单元格进入编辑模式，并修改值。

4. 行内编辑

行内编辑模式允许用户编辑整行的数据，而不仅仅是单个单元格。它适用于用户需要同时编辑多列数据的场景。

4.1 启用行内编辑

import * as React from 'react';
import { DataGrid } from '@mui/x-data-grid';

const rows = [
  { id: 1, name: 'John Doe', age: 35 },
  { id: 2, name: 'Jane Smith', age: 28 },
  { id: 3, name: 'Jack White', age: 40 },
];

const columns = [
  { field: 'name', headerName: 'Name', width: 150, editable: true },
  { field: 'age', headerName: 'Age', width: 100, type: 'number', editable: true },
];

export default function RowEditGrid() {
  const processRowUpdate = (newRow) => {
    // 处理更新逻辑
    console.log('Updated row:', newRow);
    return newRow;
  };

  return (
    <div style={{ height: 400, width: '100%' }}>
      <DataGrid
        rows={rows}
        columns={columns}
        pageSize={5}
        editMode="row"
        processRowUpdate={processRowUpdate}
        checkboxSelection
        disableSelectionOnClick
      />
    </div>
  );
}

4.2 说明

editMode="row"：启用行内编辑模式，允许用户在行内进行编辑。
processRowUpdate：当用户完成编辑时，这个函数会被调用以处理更新。

5. 自定义编辑组件

有时，内置的编辑方式可能不够灵活，您可以为特定列指定自定义的编辑组件。例如，某一列可能需要日期选择器，而不是直接的文本输入。

5.1 自定义编辑示例

import * as React from 'react';
import { DataGrid } from '@mui/x-data-grid';
import { GridEditDateCell } from './CustomDateEditCell';  // 假设这是我们自定义的组件

const rows = [
  { id: 1, name: 'John Doe', birthDate: new Date('1990-01-01') },
  { id: 2, name: 'Jane Smith', birthDate: new Date('1992-03-05') },
  { id: 3, name: 'Jack White', birthDate: new Date('1985-10-15') },
];

const columns = [
  { field: 'name', headerName: 'Name', width: 150 },
  { 
    field: 'birthDate', 
    headerName: 'Birth Date', 
    width: 180, 
    editable: true, 
    renderEditCell: (params) => <GridEditDateCell {...params} /> 
  },
];

export default function CustomEditorGrid() {
  return (
    <div style={{ height: 400, width: '100%' }}>
      <DataGrid
        rows={rows}
        columns={columns}
        pageSize={5}
        checkboxSelection
        disableSelectionOnClick
      />
    </div>
  );
}

5.2 自定义编辑组件解释

renderEditCell：此属性允许我们为每个单元格定义自定义的编辑组件。在这个例子中，我们使用了一个自定义的 GridEditDateCell 组件，该组件提供日期选择功能。

6. 编辑事件处理

Data Grid 提供了一系列事件处理器，用于监听和控制编辑行为。这些事件可以帮助我们更好地管理数据更新、错误处理等。

6.1 常用编辑事件

onCellEditStart：监听单元格编辑的开始。
onCellEditStop：监听单元格编辑的结束。
onRowEditStart：监听行内编辑的开始。
onRowEditStop：监听行内编辑的结束。

6.2 示例代码

const handleCellEditStart = (params, event) => {
  console.log('Editing started for cell:', params);
};

const handleCellEditStop = (params, event) => {
  console.log('Editing stopped for cell:', params);
};

<DataGrid
  rows={rows}
  columns={columns}
  onCellEditStart={handleCellEditStart}
  onCellEditStop={handleCellEditStop}
/>

通过这些事件处理器，我们可以实现一些额外的逻辑，例如：在开始编辑时显示提示信息，或在编辑完成后保存数据到远程服务器。

7. 集成其他组件

Data Grid 可以与 Material UI 的其他组件很好地集成，比如 Snackbar、Dialog 等，用于在数据更新后显示反馈消息或提示。

7.1 使用 Snackbar 显示编辑反馈

import React, { useState } from 'react';
import { DataGrid } from '@mui/x-data-grid';
import Snackbar from '@mui/material/Snackbar';

const EditableGridWithSnackbar = () => {
  const [snackbarOpen, setSnackbarOpen] = useState(false);
  const [snackbarMessage, setSnackbarMessage] = useState('');

  const processRowUpdate = (newRow) => {
    setSnackbarMessage(`Row ${newRow.id} updated successfully!`);
    setSnackbarOpen(true);
    return newRow;
  };

  return (
    <div style={{ height: 400, width: '100%' }}>
      <DataGrid
        rows={rows}
        columns={columns}
        pageSize={5}
        editMode="row"
        processRowUpdate={processRowUpdate}
        checkboxSelection
        disableSelectionOnClick
      />
      <Snackbar
        open={snackbarOpen}
        autoHideDuration={3000}
        message={snackbarMessage}
        onClose={() => setSnackbarOpen(false)}
      />
    </div>
  );
};