pengchen96/table-xlsx

基于SheetJS封装，实现导出文件和解析文件生成表数据功能

table-xlsx

基于SheetJS封装，帮助你快速将xlsx文件转换成表格数据或表格数据导出生成xlsx文件，导出支持简单样式设置、多sheet页、行/列合并等

文档&演示地址：https://pengchen96.github.io/table-xlsx/docs/intro

📦 安装

使用npm或yarn

npm install --save table-xlsx @pengchen/xlsx
# or
yarn add table-xlsx @pengchen/xlsx

使用CDN

<!-- 注意: 部署时，将 "development.umd.js" 替换为 "production.umd.js"-->
<script crossorigin src="https://unpkg.com/table-xlsx/dist/table-xlsx.development.umd.js"></script>

如果使用CDN的方式引入table-xlsx，建议设置crossorigin属性

CDN Availability (click to show)

CDN	URL
unpkg	https://unpkg.com/table-xlsx/
jsDelivr	https://jsdelivr.com/package/npm/table-xlsx

🔨 使用

导出

import { exportFile } from "table-xlsx";

const columns = [
  { title: '姓名', dataIndex: 'name' },
  { title: '年龄', dataIndex: 'age' },
  { title: '住址', dataIndex: 'address' },
];
const dataSource = [
  { key: '1', name: '胡彦斌', age: 32, address: '西湖区湖底公园1号' },
  { key: '2', name: '胡彦祖', age: 42, address: '西湖区湖底公园1号' },
];

exportFile({ columns, dataSource });

解析

import { parseFile } from "table-xlsx";

parseFile({ file/*binary*/ }).then((result) => {
  // result = {
  //   wb, // wookbook对象
  //   tables: [{
  //     sheetName,
  //     dataSource,
  //     columns,
  //   },
  //   ...
  //   ]
  // }
});

📖 API

exportFile

参数	说明	类型	默认值
columns	表格列	array	[]
cellStyle	单元格样式	object	{}
headerCellStyle	表头单元格样式	object	{}
bodyCellStyle	主体单元格样式	object	{}
dataSource	表格数据	array	[]
fileName	文件名	string	'table.xlsx'
showHeader	显示表头	bool	true
raw	是否格式化值的类型	bool	false
rowHpx	行高	number	25
sheetNames	sheet页	array	['sheet1']
useRender	使用render返回的值	boolean	true
onTxBodyRow	设置表格主体行，@return里可设置单元格样式	function(record, index) { return { style } }	-

columns

参数	说明	类型	默认值
dataIndex	列数据在数据项中对应的路径，支持通过数组查询嵌套路径	string/string[]	-
title	列头显示文字	string	-
width	列宽度	string/number	100
txHeaderCellStyle	列头单元格样式	object	-
render	生成复杂数据的渲染函数，参数分别为当前行的值，当前行数据，行索引，@return 里面可以设置表格行/列合并	function(text, record, index) {}	-
xlsxRender	设置xlsx列导出值，参数分别为当前行的值，当前行数据，行索引，返回String类型	function(text, record, index) { return String }	-
onTxBodyCell	设置表格主体单元格，@return里可设置单元格样式；如果是多级表头，需要设置在末级列	function(record, index) { return { style } }	-

cellStyle、headerCellStyle、bodyCellStyle、txHeaderCellStyle、onTxBodyCell().style

参数	说明	类型	默认值
fontName	字体	string	'Calibri'
fontColorRgb	字体颜色（ARGB）	string	'333333'
fontBold	加粗	boolean	false
fillFgColorRgb	背景填充颜色（ARGB）	string	'ffffff'
borderStyle	边框风格（thin、medium、thick、dotted、hair、dashed、mediumDashed、dashDot、mediumDashDot、dashDotDot、mediumDashDotDot、slantDashDot）	string	'thin'
borderColorRgb	边框颜色（ARGB）	string	'd1d3d8'
alignmentHorizontal	水平对齐（left、center、right）	string	'center'
alignmentVertical	垂直对齐（top、center、bottom）	string	'center'
alignmentWrapText	自动换行（true、false）	boolean	false
alignmentReadingOrder	阅读顺序	number	2
alignmentTextRotation	文本旋转（0 to 180 or 255）	number	0

parseFile

参数	说明	类型	默认值
file	文件	binary	-

输出内容

    [
      {
        columns: [],
        dataSource: [],
        sheetName: ''
      },
      ...
    ]

📝 License

table-xlsx is available under the MIT License.

table-xlsx's Issues

数据为 null 的时候导出文件 有异常

使用：render: (value) => <>{value !== null ? value: '-'}</> 也无效。

点击是 后

cdn是不是没用了，请求失败了

ReferenceError: exportFile is not defined
at Proxy.exportComplexUtils (page.js:1101:3)

你好，最近使用发现设置导出excel样式没生效，默认的样式也没了

解析时报错：table-xlsx.production.js，升级不到0.1.9，react和react-dom都是16.14 antd是最新的v4

表格的宽度能不能支持根据内容自动计算？

你好想问下如图的宽度怎么设置默认下面的编辑器宽，看文档好像没有参数设置项

老版本的项目使用会报错误umi的发布者虽然有提到怎么解决应该是你发布es6没转es这个视频你可以看下

老版本的项目使用会报错误umi的发布者虽然有提到怎么解决应该是你发布es6没转es这个视频你可以看下 https://www.youtube.com/watch?v=z4pWFpPiIoc 视频里面一分50秒的报错位置在你的包里找不到 帮忙看下是哪里没有转 谢谢啦

导出的数字列不能自动求和

比如金额字段 , 不能自动求和

可否暴露一些工具函数、对象，例如formatToSheet、wb，方便独立调用

现在项目再用webworker做导出，有些windows上的方法无法使用，希望可以暴露一些方法，可以组合使用

行高能否设置

页面导入直接页面加载不了，也没有报错，是因为我得项目不是TS得原因嘛？

页面渲染不出来，注释掉，就正常了

打包到dev，导出文件直接是已损坏的

项目本身存在xlsx ，这个会影响不？

怎么没有自动换行属性

alignmentWrapText这个属性设置了无效

语序错乱

具体时间和末尾的句号都被提到前边了，大佬有时间帮忙看下

请问下，这个框架支持添加水印吗？

最新的需求要求导出的报表有水印，翻了文档里没有相关的教程。

能支持表头带斜线分割符的导出吗？要如何配置呢？

如一个表头单元格中通过分割线划分为多部分内容填充的，一般用于表格左上角展示的

parseFile 报错

报错

原因

ws['!merges'] 值为undefined