1.0.5 • Published 6 months ago

pikaz-excel-js v1.0.5

Weekly downloads
215
License
MIT
Repository
github
Last release
6 months ago

介绍

导入导出 excel 的 js 插件,在 xlsx 和 xlsx-style 的基础上做了简单的封装,开箱即用。

特性

  • 支持导出 excel 文件,并可设置列宽,边框,字体,字体颜色,字号,对齐方式,背景色等样式。
  • 支持 excel 文件导入,生成 json 数据,考虑到客户端机器性能,导入大量数据时,推荐拆分数据分成多个文件导入。

版本更新

本插件库已更新至 1.x 版本,历史版本 0.2.x 文档请看这里

  • 新版本改为纯 js 库,支持多种框架如 vue2, vue3, react 及无其他依赖的 html 中使用
  • 合并项与单元格格式中的单元格名称,现在支持传入数字,而非只能使用 excel 单元格名称,如第一行第三列,可使用 A3 或 3-1
  • 新增 esmodule 模块化,支持 vite 等使用

demo 示例点击这里体验

demo 代码点击这里一键 copy

安装

使用 npm 或 yarn

yarn add pikaz-excel-js

npm i -S pikaz-excel-js
import { excelExport, excelImport } from "pikaz-excel-js";

使用 cdn 引入

<script
  type="text/javascript"
  src="https://cdn.jsdelivr.net/npm/pikaz-excel-js"
></script>
或者
<script type="text/javascript" src="https://unpkg.com/pikaz-excel-js"></script>
const { excelExport, excelImport } = window.pikazExcelJs;

导出函数

函数示例

import { excelExport } from "pikaz-excel-js";
excelExport({
  sheet: [
    {
      // 表格标题
      title: "水果的味道1",
      // 表头
      tHeader: ["种类", "味道"],
      // 数据键名
      keys: ["name", "taste"],
      // 表格数据
      table: [
        {
          name: "荔枝",
          taste: "甜",
        },
        {
          name: "菠萝蜜",
          taste: "甜",
        },
      ],
      sheetName: "水果的味道1",
    },
  ],
});

函数参数:

参数说明类型可选值默认值
bookType文件格式stringxlsxxlsx
filename文件名称string--excel
sheet表格数据,每个表格数据对象配置具体看下方表格配置object[]----
beforeStart处理数据之前的钩子,参数为导出的文件格式,文件名,表格数据,若抛出 Error 则停止导出function(bookType, filename, sheet)----
beforeExport导出文件之前的钩子,参数为 blob 文件流,文件格式,文件名,若抛出 Error 则停止导出function(blob, bookType, filename)----
onError导出失败的钩子,参数为错误信息function(err)----
参数说明类型可选值默认值
title表格标题,自动设置合并,非必须项string----
tHeader表头, 非必须项string[]----
table表格数据,如果无数据,设置为空字符"",避免使用 null 或 undefinedobject[]----
merges合并两个单元格之间所有的单位格,支持 excel 行列格式或数字格式(如合并第一排第一列至第一排第三列为'A1: A3'或'1-1:3-1'),合并的表格单元多余数据项以空字符串填充,非必须项string[]----
keys数据键名,需与表头内容顺序对应string[]----
colWidth列宽,若不传,则列宽自适应(自动列宽时数据类型必须为 string,如有其他数据类型,请手动设置列宽)number[]----
sheetName表格名称string--sheet
globalStyle表格全局样式,具体参数查看下方表格全局样式object--表格全局样式
cellStyle单元格样式,每个单元格对象配置具体参数查看下方单元格样式object[]----

其他属性与表格全局样式设置方式一致

导入函数

函数示例

import { excelImport } from "pikaz-excel-js";
excelImport().then((res) => {
  console.log(res);
});

函数参数:

参数说明类型可选值默认值
file导入的文件,若不传,则自动调起上传功能file--null
sheetNames需要导入表的表名,如'插件信息',若不传则读取 excel 中所有表格,非必传string[]----
removeBlankspace是否移除数据中字符串的空格Booleantrue/falsefalse
removeSpecialchar是否移除不同版本及环境下 excel 数据中出现的特殊不可见字符,如 u202D 等, 使用此功能,返回的数据将被转化为字符串Booleantrue/falsetrue
beforeImport文件导入前的钩子,参数 file 为导入文件function(file)----
onProgress文件导入时的钩子function(event, file)----
onChange文件状态改变时的钩子,导入文件、导入成功和导入失败时都会被调用function(file)----
onSuccess文件导入成功的钩子,参数 response 为生成的 json 数据function(response, file)----
onError文件导入失败的钩子,参数 error 为错误信息function(error)----
1.0.5

6 months ago

1.0.4

6 months ago

1.0.2

2 years ago

1.0.1

2 years ago

1.0.3

2 years ago

1.0.0

3 years ago

0.2.16

5 years ago

0.2.15

5 years ago

0.2.14

5 years ago

0.2.13

5 years ago

0.2.12

5 years ago

0.2.11

5 years ago

0.2.10

5 years ago

0.2.9

5 years ago

0.2.8

5 years ago

0.2.7

5 years ago

0.2.6

5 years ago

0.2.5

5 years ago

0.2.4

5 years ago

0.2.3

5 years ago

0.2.2

5 years ago

0.2.1

5 years ago

0.2.0

5 years ago