0

0

如何在 MUI X Data Grid 中通过自定义按钮导出单条记录为 CSV

心靈之曲

心靈之曲

发布时间:2026-01-08 14:39:40

|

668人浏览过

|

来源于php中文网

原创

如何在 MUI X Data Grid 中通过自定义按钮导出单条记录为 CSV

本文介绍如何利用 mui x data grid 的 exportdataascsv api,在点击自定义按钮时精准导出当前行(或指定行)数据为 csv 文件,无需依赖内置工具栏,支持灵活筛选与配置。

在 MUI X Data Grid(社区版)中,内置的 CSV 导出功能默认通过 <GridToolbarExport /> 组件触发,但实际业务中常需更精细的控制——例如:仅导出用户点击的某一行、导出筛选后的子集、或集成到操作列(Action Column)中的「下载」按钮。这完全可通过 useGridApiContext 获取 Grid API 实例,并调用 apiRef.current.exportDataAsCsv() 方法实现。

✅ 核心思路

exportDataAsCsv() 接收一个可选的 GridCsvExportOptions 对象,其中关键配置项包括:

  • allColumns: 是否导出所有字段(含隐藏列),默认 false
  • fileName: 自定义导出文件名(如 'record-123.csv')
  • skipHeader: 是否跳过表头,默认 false
  • getRowsToExport: 最关键——用于指定要导出的行 ID 数组,实现「单行导出」

? 示例:为每行添加「下载此行」按钮(操作列)

import { DataGrid, GridActionsCellItem, GridColDef, GridRowParams, useGridApiContext } from '@mui/x-data-grid';
import { FileDownload as FileDownloadIcon } from '@mui/icons-material';
import { Button } from '@mui/material';

// 自定义操作列
const columns: GridColDef[] = [
  // ...其他列
  {
    field: 'actions',
    type: 'actions',
    headerName: '操作',
    width: 120,
    getActions: (params: GridRowParams) => [
      <GridActionsCellItem
        icon={<FileDownloadIcon fontSize="small" />}
        label="下载本行"
        onClick={() => {
          const apiRef = useGridApiContext();
          // 仅导出当前行
          apiRef.current.exportDataAsCsv({
            fileName: `record-${params.id}.csv`,
            getRowsToExport: () => [params.id], // ? 关键:只传入当前行 ID
          });
        }}
      />,
    ],
  },
];
⚠️ 注意:useGridApiContext() 必须在 DataGrid 组件树内部使用(如列定义函数内不可直接调用)。因此推荐将导出逻辑封装为独立 Hook 或在事件回调中通过 params.api 访问(v6.15+ 支持 params.api.exportDataAsCsv):
// ✅ 更安全的写法(推荐)
getActions: (params: GridRowParams) => [
  <GridActionsCellItem
    icon={<FileDownloadIcon fontSize="small" />}
    label="下载本行"
    onClick={() => {
      params.api.exportDataAsCsv({
        fileName: `user-${params.row.id}.csv`,
        getRowsToExport: () => [params.id],
      });
    }}
  />,
],

?️ 进阶:导出多选行或自定义数据

若需导出当前多选行,可结合 apiRef.current.getSelectedRows():

智川X-Agent
智川X-Agent

中科闻歌推出的一站式AI智能体开发平台

下载
const handleExportSelected = () => {
  const selectedIds = Array.from(apiRef.current.getSelectedRows().keys());
  apiRef.current.exportDataAsCsv({
    fileName: 'selected-records.csv',
    getRowsToExport: () => selectedIds,
  });
};

? 注意事项

  • exportDataAsCsv 是客户端纯前端导出,不发送网络请求;
  • 导出内容严格基于当前 Grid 渲染的数据模型(即 rows prop + 过滤/排序后状态);
  • 若需导出原始未处理数据(如服务端全量),应改用 fetch + 后端接口生成 CSV 流;
  • 文件名不支持路径字符(如 /, \),建议对 id 做 URL 安全转义(如 encodeURIComponent)。

通过以上方式,你即可完全脱离默认工具栏,按需触发任意粒度的 CSV 导出,大幅提升交互自由度与用户体验。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
硬盘接口类型介绍
硬盘接口类型介绍

硬盘接口类型有IDE、SATA、SCSI、Fibre Channel、USB、eSATA、mSATA、PCIe等等。详细介绍:1、IDE接口是一种并行接口,主要用于连接硬盘和光驱等设备,它主要有两种类型:ATA和ATAPI,IDE接口已经逐渐被SATA接口;2、SATA接口是一种串行接口,相较于IDE接口,它具有更高的传输速度、更低的功耗和更小的体积;3、SCSI接口等等。

1926

2023.10.19

PHP接口编写教程
PHP接口编写教程

本专题整合了PHP接口编写教程,阅读专题下面的文章了解更多详细内容。

656

2025.10.17

php8.4实现接口限流的教程
php8.4实现接口限流的教程

PHP8.4本身不内置限流功能,需借助Redis(令牌桶)或Swoole(漏桶)实现;文件锁因I/O瓶颈、无跨机共享、秒级精度等缺陷不适用高并发场景。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2395

2025.12.29

java接口相关教程
java接口相关教程

本专题整合了java接口相关内容,阅读专题下面的文章了解更多详细内容。

47

2026.01.19

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

74

2026.03.11

Go高并发任务调度与Goroutine池化实践
Go高并发任务调度与Goroutine池化实践

本专题围绕 Go 语言在高并发任务处理场景中的实践展开,系统讲解 Goroutine 调度模型、Channel 通信机制以及并发控制策略。内容包括任务队列设计、Goroutine 池化管理、资源限制控制以及并发任务的性能优化方法。通过实际案例演示,帮助开发者构建稳定高效的 Go 并发任务处理系统,提高系统在高负载环境下的处理能力与稳定性。

38

2026.03.10

Kotlin Android模块化架构与组件化开发实践
Kotlin Android模块化架构与组件化开发实践

本专题围绕 Kotlin 在 Android 应用开发中的架构实践展开,重点讲解模块化设计与组件化开发的实现思路。内容包括项目模块拆分策略、公共组件封装、依赖管理优化、路由通信机制以及大型项目的工程化管理方法。通过真实项目案例分析,帮助开发者构建结构清晰、易扩展且维护成本低的 Android 应用架构体系,提升团队协作效率与项目迭代速度。

83

2026.03.09

JavaScript浏览器渲染机制与前端性能优化实践
JavaScript浏览器渲染机制与前端性能优化实践

本专题围绕 JavaScript 在浏览器中的执行与渲染机制展开,系统讲解 DOM 构建、CSSOM 解析、重排与重绘原理,以及关键渲染路径优化方法。内容涵盖事件循环机制、异步任务调度、资源加载优化、代码拆分与懒加载等性能优化策略。通过真实前端项目案例,帮助开发者理解浏览器底层工作原理,并掌握提升网页加载速度与交互体验的实用技巧。

97

2026.03.06

Rust内存安全机制与所有权模型深度实践
Rust内存安全机制与所有权模型深度实践

本专题围绕 Rust 语言核心特性展开,深入讲解所有权机制、借用规则、生命周期管理以及智能指针等关键概念。通过系统级开发案例,分析内存安全保障原理与零成本抽象优势,并结合并发场景讲解 Send 与 Sync 特性实现机制。帮助开发者真正理解 Rust 的设计哲学,掌握在高性能与安全性并重场景中的工程实践能力。

223

2026.03.05

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
CSS3 教程
CSS3 教程

共18课时 | 7.1万人学习

Vue 教程
Vue 教程

共42课时 | 9.5万人学习

React 教程
React 教程

共58课时 | 6万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号