Material UI 框架 DataGridPro API 使用指南
DataGridPro 是 Material UI 提供的高级数据表格组件，适合需要处理大量数据的复杂应用场景。相比于基础版的 DataGrid，DataGridPro 提供了更多的高级功能，例如行分组、列分组、服务器端操作、编辑、导出、过滤和排序等功能。
在这篇博客中，我们将详细介绍 DataGridPro 的各个属性、方法、事件等，并通过示例代码演示如何使用这些功能来实现一个功能丰富的数据表格。
1. 安装 DataGridPro
在使用 DataGridPro 之前，需要安装 @mui/x-data-grid-pro 依赖包：
npm install @mui/x-data-grid-pro
引入组件后即可开始使用：
import * as React from 'react';
import { DataGridPro } from '@mui/x-data-grid-pro';
2. 基本使用示例
首先，我们构建一个基础的 DataGridPro 示例。我们将创建一组简单的数据，并定义表格的列。
import * as React from 'react';
import { DataGridPro } from '@mui/x-data-grid-pro';
const rows = [
{ id: 1, name: 'Apple', category: 'Fruit', price: 1.5 },
{ id: 2, name: 'Banana', category: 'Fruit', price: 1.0 },
{ id: 3, name: 'Carrot', category: 'Vegetable', price: 0.8 },
{ id: 4, name: 'Broccoli', category: 'Vegetable', price: 1.2 },
];
const columns = [
{ field: 'id', headerName: 'ID', width: 90 },
{ field: 'name', headerName: 'Name', width: 150 },
{ field: 'category', headerName: 'Category', width: 150 },
{ field: 'price', headerName: 'Price', width: 110, type: 'number' },
];
export default function BasicDataGridPro() {
return (
<div style={{ height: 400, width: '100%' }}>
<DataGridPro rows={rows} columns={columns} pageSize={5} />
</div>
);
}
在这个例子中，我们定义了一些简单的 rows 和 columns，并使用 DataGridPro 进行展示，启用了分页功能。
3. DataGridPro API 概述
DataGridPro 提供了一系列丰富的 API，包括：
- 属性（props）：用于配置表格的行为和外观。
- 方法（methods）：允许我们通过编程方式操作表格。
- 事件（events）：用于监听用户与表格的交互。
- 状态（state）：用于管理表格的内部状态。
接下来我们将逐一深入探讨这些 API，并提供代码示例。
4. DataGridPro 属性（Props）
4.1 分页与服务器端分页
DataGridPro 支持服务器端分页，这对于处理大规模数据集非常有用。可以通过 paginationMode="server" 来启用服务器端分页。
<DataGridPro
rows={rows}
columns={columns}
paginationMode="server"
onPageChange={(newPage) => {
// 在这里请求服务器数据
console.log(`New page: ${newPage}`);
}}
pageSize={5}
/>
在这个例子中，当分页改变时，onPageChange 会触发，并可以请求服务器数据。
4.2 分组（Row Grouping）
DataGridPro 支持根据某个字段对行进行分组，展示嵌套数据结构。
<DataGridPro
rows={rows}
columns={columns}
groupingColDef={{
headerName: 'Category',
}}
groupBy="category"
/>
这里我们对数据按 category 字段进行分组。每个分组都有一个标题栏，用户可以展开和折叠以查看分组内的行。
4.3 编辑功能（Editing）
DataGridPro 提供了内置的单元格编辑功能，可以通过 editable 属性来启用。
const columns = [
{ field: 'name', headerName: 'Name', width: 150, editable: true },
{ field: 'category', headerName: 'Category', width: 150 },
{ field: 'price', headerName: 'Price', width: 110, type: 'number', editable: true },
];
<DataGridPro
rows={rows}
columns={columns}
/>
在上面的代码中，name 和 price 列是可编辑的，用户可以直接在表格中进行修改。
4.4 过滤与排序
可以通过 filterModel 和 sortModel 来控制表格的过滤和排序功能。
<DataGridPro
rows={rows}
columns={columns}
filterModel={{
items: [{ columnField: 'category', operatorValue: 'contains', value: 'Fruit' }],
}}
sortModel={[
{ field: 'price', sort: 'desc' },
]}
/>
在这个例子中，表格会显示 category 字段包含 "Fruit" 的行，并按 price 进行降序排序。
4.5 导出功能
DataGridPro 提供了数据导出的功能，允许用户将数据导出为 CSV 或 Excel 文件。
import { GridToolbarExport } from '@mui/x-data-grid-pro';
<DataGridPro
rows={rows}
columns={columns}
components={{
Toolbar: GridToolbarExport,
}}
/>
使用 GridToolbarExport 组件，可以在表格工具栏中添加一个导出按钮，用户点击后即可将数据导出。
4.6 树形数据（Tree Data）
DataGridPro 还支持树形数据结构的展示，可以使用 treeData 属性和 getTreeDataPath 函数。
const rows = [
{ id: 1, name: 'Apple', category: ['Fruit', 'Tropical'] },
{ id: 2, name: 'Banana', category: ['Fruit', 'Tropical'] },
{ id: 3, name: 'Carrot', category: ['Vegetable', 'Root'] },
];
<DataGridPro
rows={rows}
columns={columns}
treeData
getTreeDataPath={(row) => row.category}
/>
这个示例展示了根据 category 字段来构建树形结构。
5. DataGridPro 方法（Methods）
5.1 获取和更新数据
DataGridPro 提供了丰富的 API 供开发者操作表格，可以通过 apiRef 来获取和更新数据。
import { useGridApiRef, DataGridPro } from '@mui/x-data-grid-pro';
const apiRef = useGridApiRef();
<DataGridPro
apiRef={apiRef}
rows={rows}
columns={columns}
/>
// 更新某一行数据
apiRef.current.updateRows([{ id: 1, price: 2.0 }]);
5.2 导航与聚焦
你可以使用 apiRef 方法进行表格导航或聚焦到特定的行或单元格。
// 聚焦到特定的行
apiRef.current.setRowFocus(1);
// 聚焦到特定的单元格
apiRef.current.setCellFocus(1, 'name');
6. DataGridPro 事件（Events）
DataGridPro 提供了一系列事件，用于监听表格中的交互行为。
6.1 行点击事件
<DataGridPro
rows={rows}
columns={columns}
onRowClick={(params) => {
console.log('Row clicked:', params.row);
}}
/>
当用户点击某一行时，onRowClick 事件将被触发，参数 params 包含点击行的数据。
6.2 编辑事件
当单元格进入或退出编辑状态时，可以通过 onCellEditStart 和 onCellEditStop 来监听这些事件。
<DataGridPro
rows={rows}
columns={columns}
onCellEditStart={(params) => {
console.log('Editing started:', params);
}}
onCellEditStop={(params) => {
console.log('Editing stopped:', params);
}}
/>
7. 与其他 Material UI 组件结合使用
DataGridPro 可以与其他 Material UI 组件一起使用，实现复杂的 UI 交互。
7.1 与 Dialog 结合使用
import React, { useState } from 'react';
import { DataGridPro } from '@mui/x-data-grid-pro';
import { Dialog, DialogActions, DialogContent, Button } from '@mui/material';
const rows = [
{ id: 1, name: 'Apple', price: 1.5 },
{ id: 2, name: 'Banana', price: 1.0 },
];
const columns = [
{ field: 'name', headerName: 'Name', width: 150 },
{ field: 'price', headerName: 'Price', width: 100 },
];
export default function GridWithDialog() {
const [open, setOpen] = useState(false);
const [selectedRow, setSelectedRow] = useState(null);
const handleRowClick = (params) => {
setSelectedRow(params.row);
setOpen(true);
};
return (
<div style={{ height: 400, width: '100%' }}>
<DataGridPro rows={rows} columns={columns} onRowClick={handleRowClick} />
<Dialog open={open} onClose={() => setOpen(false)}>
<DialogContent>
<p>Row data: {JSON.stringify(selectedRow)}</p>
</DialogContent>
<DialogActions>
<Button onClick={() => setOpen(false)}>Close</Button>
</DialogActions>
</Dialog>
</div>
);
}
7.2 与 Snackbar 结合使用
import React, { useState } from 'react';
import { DataGridPro } from '@mui/x-data-grid-pro';
import Snackbar from '@mui/material/Snackbar';
import Button from '@mui/material/Button';
const rows = [
{ id: 1, name: 'Apple', price: 1.5 },
{ id: 2, name: 'Banana', price: 1.0 },
];
const columns = [
{ field: 'name', headerName: 'Name', width: 150 },
{ field: 'price', headerName: 'Price', width: 100 },
];
export default function GridWithSnackbar() {
const [snackbarOpen, setSnackbarOpen] = useState(false);
const handleRowClick = () => {
setSnackbarOpen(true);
};
return (
<div style={{ height: 400, width: '100%' }}>
<DataGridPro rows={rows} columns={columns} onRowClick={handleRowClick} />
<Snackbar
open={snackbarOpen}
autoHideDuration={6000}
onClose={() => setSnackbarOpen(false)}
message="Row clicked!"
/>
</div>
);
}
8. 总结
Material UI 的 DataGridPro 是一个功能强大的企业级数据表格解决方案。通过丰富的 API、事件和方法，你可以灵活定制表格行为，处理复杂的数据场景。我们涵盖了分页、排序、行分组、数据导出、编辑等功能，提供了详细的代码示例，帮助开发者快速上手并运用到实际项目中。
希望通过本篇博客，你能够熟练掌握 DataGridPro 的使用，并在实际项目中灵活运用这些知识。
