前言
最近发现了一个库Luckysheet可以用来实现在线excel，感觉不错，简单学习一下。
官方提供了一些例子，这里基于官方的Luckysheet Vue3 例子来学习如何在vue中使用。
搭建
准备
引入css和js
在public文件下的index.html中引入Luckysheet的cdn文件
<link rel='stylesheet' href='https://cdn.jsdelivr.net/npm/luckysheet@latest/dist/plugins/css/pluginsCss.css' />
<link rel='stylesheet' href='https://cdn.jsdelivr.net/npm/luckysheet@latest/dist/plugins/plugins.css' />
<link rel='stylesheet' href='https://cdn.jsdelivr.net/npm/luckysheet@latest/dist/css/luckysheet.css' />
<link rel='stylesheet' href='https://cdn.jsdelivr.net/npm/luckysheet@latest/dist/assets/iconfont/iconfont.css' />
<script src="https://cdn.jsdelivr.net/npm/luckysheet@latest/dist/plugins/js/plugin.js"></script>
<script src="https://cdn.jsdelivr.net/npm/luckysheet@latest/dist/luckysheet.umd.js"></script>
这里遇到了个问题，本来是打算将css和js下载到本地使用的，但是本地加载 好像有问题，只能还是使用cdn方式。
安装依赖
npm i -S exceljs file-saver luckyexcel
exceljs和 file-saver用来导出，luckyexcel用来处理导入数据
导出工具：export.js
官方例子中有这个文件，直接拿来用就好。
// import { createCellPos } from './translateNumToLetter'
import Excel from 'exceljs';
import FileSaver from 'file-saver';
const exportExcel = function(luckysheet, value) {
// 参数为luckysheet.getluckysheetfile()获取的对象
// 1.创建工作簿，可以为工作簿添加属性
const workbook = new Excel.Workbook();
// 2.创建表格，第二个参数可以配置创建什么样的工作表
if (Object.prototype.toString.call(luckysheet) === '[object Object]') {
luckysheet = [luckysheet];
}
luckysheet.forEach(function(table) {
if (table.data.length === 0) {
return true; }
// ws.getCell('B2').fill = fills.
const worksheet = workbook.addWorksheet(table.name);
const merge = (table.config && table.config.merge) || {
};
const borderInfo = (table.config && table.config.borderInfo) || {
};
// 3.设置单元格合并,设置单元格边框,设置单元格样式,设置值
setStyleAndValue(table.data, worksheet);
setMerge(merge, worksheet);
setBorder(borderInfo, worksheet);
return true;
});
// return
// 4.写入 buffer
const buffer = workbook.xlsx.writeBuffer().then(data => {
// console.log('data', data)
const blob = new Blob([data], {
type: 'application/vnd.ms-excel;charset=utf-8'
});
console.log('导出成功！');
FileSaver.saveAs(blob, `${
value}.xlsx`);
});
return buffer;
};
var setMerge = function(luckyMerge = {
}, worksheet) {
const mergearr = Object.values(luckyMerge);
mergearr.forEach(function(elem) {
// elem格式：{r: 0, c: 0, rs: 1, cs: 2}
// 按开始行，开始列，结束行，结束列合并（相当于 K10:M12）
worksheet.mergeCells(
elem.r + 1,
elem.c + 1,
elem.r + elem.rs,
elem.c + elem.cs
);
});
};
var setBorder = function(luckyBorderInfo, worksheet) {
if (!Array.isArray(luckyBorderInfo)) {
return; }
// console.log('luckyBorderInfo', luckyBorderInfo)
luckyBorderInfo.forEach(function(elem) {
// 现在只兼容到borderType 为range的情况
// console.log('ele', elem)
if (elem.rangeType === 'range') {
let border = borderConvert(elem.borderType, elem.style, elem.color);
let rang = elem.range[0];
// console.log('range', rang)
let row = rang.row;
let column = rang.column;
for (let i = row[0] + 1; i < row[1] + 2; i++) {
for (let y = column[0] + 1; y < column[1] + 2; y++) {
worksheet.getCell(i, y).border = border;
}
}
}
if (elem.rangeType === 'cell') {
// col_index: 2
// row_index: 1
// b: {
// color: '#d0d4e3'
// style: 1
// }
const {
col_index, row_index } = elem.value;
const borderData = Object.assign({
}, elem.value);
delete borderData.col_index;
delete borderData.row_index;
let border = addborderToCell(borderData, row_index, col_index);
// console.log('bordre', border, borderData)
worksheet.getCell(row_index + 1, col_index + 1).border = border;
}
// console.log(rang.column_focus + 1, rang.row_focus + 1)
// worksheet.getCell(rang.row_focus + 1, rang.column_focus + 1).border = border
});
};
var setStyleAndValue = function(cellArr, worksheet) {
if (!Array.isArray(cellArr)) {
return; }
cellArr.forEach(function(row, rowid) {
row.every(function(cell, columnid) {
if (!cell) {
return true; }
let fill = fillConvert(cell.bg);
let font = fontConvert(
cell.ff,
cell.fc,
cell.bl,
cell.it,
cell.fs,
cell.cl,
cell.ul
);
let alignment = alignmentConvert(cell.vt, cell.ht, cell.tb, cell.tr);
let value = '';
if (cell.f) {
value = {
formula: cell.f, result: cell.v };
} else if (!cell.v && cell.ct && cell.ct.s) {
// xls转为xlsx之后，内部存在不同的格式，都会进到富文本里，即值不存在与cell.v，而是存在于cell.ct.s之后
// value = cell.ct.s[0].v
cell.ct.s.forEach(arr => {
value += arr.v;
});
} else {
value = cell.v;
}
// style 填入到_value中可以实现填充色
let letter = createCellPos(columnid);
let target = worksheet.getCell(letter + (rowid + 1));
// console.log('1233', letter + (rowid + 1))
for (const key in fill) {
target.fill = fill;
break;
}
target.font = font;
target.alignment = alignment;
target.value = value;
return true;
});
});
};
var fillConvert = function(bg) {
if (!bg) {
return {
};
}
// const bgc = bg.replace('#', '')
let fill = {
type: 'pattern',
pattern: 'solid',
fgColor: {
argb: bg.replace('#', '') }
};
return fill;
};
var fontConvert = function(
ff = 0,
fc = '#000000',
bl = 0,
it = 0,
fs = 10,
cl = 0,
ul = 0
) {
// luckysheet：ff(样式), fc(颜色), bl(粗体), it(斜体), fs(大小), cl(删除线), ul(下划线)
const luckyToExcel = {
0: '微软雅黑',
1: '宋体（Song）',
2: '黑体（ST Heiti）',
3: '楷体（ST Kaiti）',
4: '仿宋（ST FangSong）',
5: '新宋体（ST Song）',
6: '华文新魏',
7: '华文行楷',
8: '华文隶书',
9: 'Arial',
10: 'Times New Roman ',
11: 'Tahoma ',
12: 'Verdana',
num2bl: function(num) {
return num === 0 ? false : true;
}
};
// 出现Bug，导入的时候ff为luckyToExcel的val
let font = {
name: typeof ff === 'number' ? luckyToExcel[ff] : ff,
family: 1,
size: fs,
color: {
argb: fc.replace('#', '') },
bold: luckyToExcel.num2bl(bl),
italic: luckyToExcel.num2bl(it),
underline: luckyToExcel.num2bl(ul),
strike: luckyToExcel.num2bl(cl)
};
return font;
};
var alignmentConvert = function(
vt = 'default',
ht = 'default',
tb = 'default',
tr = 'default'
) {
// luckysheet:vt(垂直), ht(水平), tb(换行), tr(旋转)
const luckyToExcel = {
vertical: {
0: 'middle',
1: 'top',
2: 'bottom',
default: 'top'
},
horizontal: {
0: 'center',
1: 'left',
2: 'right',
default: 'left'
},
wrapText: {
0: false,
1: false,
2: true,
default: false
},
textRotation: {
0: 0,
1: 45,
2: -45,
3: 'vertical',
4: 90,
5: -90,
default: 0
}
};
let alignment = {
vertical: luckyToExcel.vertical[vt],
horizontal: luckyToExcel.horizontal[ht],
wrapText: luckyToExcel.wrapText[tb],
textRotation: luckyToExcel.textRotation[tr]
};
return alignment;
};
var borderConvert = function(borderType, style = 1, color = '#000') {
// 对应luckysheet的config中borderinfo的的参数
if (!borderType) {
return {
};
}
const luckyToExcel = {
type: {
'border-all': 'all',
'border-top': 'top',
'border-right': 'right',
'border-bottom': 'bottom',
'border-left': 'left'
},
style: {
0: 'none',
1: 'thin',
2: 'hair',
3: 'dotted',
4: 'dashDot', // 'Dashed',
5: 'dashDot',
6: 'dashDotDot',
7: 'double',
8: 'medium',
9: 'mediumDashed',
10: 'mediumDashDot',
11: 'mediumDashDotDot',
12: 'slantDashDot',
13: 'thick'
}
};
let template = {
style: luckyToExcel.style[style],
color: {
argb: color.replace('#', '') }
};
let border = {
};
if (luckyToExcel.type[borderType] === 'all') {
border['top'] = template;
border['right'] = template;
border['bottom'] = template;
border['left'] = template;
} else {
border[luckyToExcel.type[borderType]] = template;
}
// console.log('border', border)
return border;
};
function addborderToCell(borders, row_index, col_index) {
let border = {
};
const luckyExcel = {
type: {
l: 'left',
r: 'right',
b: 'bottom',
t: 'top'
},
style: {
0: 'none',
1: 'thin',
2: 'hair',
3: 'dotted',
4: 'dashDot', // 'Dashed',
5: 'dashDot',
6: 'dashDotDot',
7: 'double',
8: 'medium',
9: 'mediumDashed',
10: 'mediumDashDot',
11: 'mediumDashDotDot',
12: 'slantDashDot',
13: 'thick'
}
};
// console.log('borders', borders)
for (const bor in borders) {
// console.log(bor)
if (borders[bor].color.indexOf('rgb') === -1) {
border[luckyExcel.type[bor]] = {
style: luckyExcel.style[borders[bor].style],
color: {
argb: borders[bor].color.replace('#', '') }
};
} else {
border[luckyExcel.type[bor]] = {
style: luckyExcel.style[borders[bor].style],
color: {
argb: borders[bor].color }
};
}
}
return border;
}
function createCellPos(n) {
let ordA = 'A'.charCodeAt(0);
let ordZ = 'Z'.charCodeAt(0);
let len = ordZ - ordA + 1;
let s = '';
while (n >= 0) {
s = String.fromCharCode((n % len) + ordA) + s;
n = Math.floor(n / len) - 1;
}
return s;
}
export {
exportExcel
};
开始
创建一个.vue文件
引入依赖
import LuckyExcel from 'luckyexcel';
import {
exportExcel } from './js/export';
创建一个容器
<div style="width:1500px;height:600px;border:1px solid #ddd;position:relative;">
<p>在线表格练习</p>
<!-- luckysheet容器 -->
<div id="luckysheet" style="margin:0px;padding:0px;position:absolute;width:100%;height:100%;left: 0px;top: 20px;"></div>
</div>
配置项
基础配置项如下，其他配置自行查看官方文档
options: {
container: 'container', //容器id名
title: '测试Excel', // 表 头名
lang: 'zh', // 中文
showtoolbar: true, // 是否显示工具栏
showinfobar: false, // 是否显示顶部信息栏
showsheetbar: true // 是否显示底部sheet按钮
}
初始化表格
window.luckysheet.destroy()
window.luckysheet.create(this.options)
带数据的表格
const data = [
{
name: "这个是sheet1",
color: "",
index: 1,
status: 0,
order: 1,
celldata: [
{
r: 0, // 行
c: 0, // 列
v: "姓名", // 值
},
{
r: 1, // 行
c: 0, // 列
v: "张三", // 值
},
{
r: 2, // 行
c: 0, // 列
v: "李四", // 值
},
{
r: 3, // 行
c: 0, // 列
v: "王五", // 值
},
{
r: 0,
c: 1,
v: "年龄",
},
{
r: 1,
c: 1,
v: "1",
},
{
r: 2,
c: 1,
v: "2",
},
{
r: 3,
c: 1,
v: "3",
},
],
config: {
},
},
{
name: "Sheet2",
color: "",
index: 1,
status: 0,
order: 1,
celldata: [],
config: {
},
},
];
window.luckysheet.destroy();
this.options.data = data;
window.luckysheet.create(this.options);
本地导入excel
该方法来源于官方示例
//导入本地文件
loadExcel(evt) {
const files = evt.target.files;
if (files == null || files.length == 0) {
alert("请选择文件");
return;
}
//获取文件名
let name = files[0].name;
//获取文件后缀
let suffixArr = name.split("."),
suffix = suffixArr[suffixArr.length - 1];
if (suffix != "xlsx") {
alert("目前只能导入xlsx类型的文件");
return;
}
//转换数据
LuckyExcel.transformExcelToLucky(
files[0],
function (exportJson, luckysheetfile) {
if (exportJson.sheets == null || exportJson.sheets.length == 0) {
alert("无法读取excel文件的内容，当前不支持xls文件!");
return;
}
console.log("exportJson", exportJson);
console.log("luckysheetfile",luckysheetfile)
jsonData.value = exportJson;
window.luckysheet.destroy();
window.luckysheet.create({
container: "luckysheet", //luckysheet is the container id
showinfobar: false,
data: exportJson.sheets,
title: exportJson.info.name,
userInfo: exportJson.info.name.creator,
});
}
);
},
导出
const downloadExcel = () => {
console.log("下载的数据：", luckysheet.getAllSheets());
//第2个参数是导出的文件名
exportExcel(luckysheet.getAllSheets(), "下载");
};
完整代码
<template>
<div
style="
width: 1500px;
height: 600px;
border: 1px solid #ddd;
position: relative;
"
>
<div style="display: flex">
<p>在线表格练习</p>
<input id="uploadBtn" type="file" @change="loadExcel" />
<el-button type="primary" @click="downloadExcel">下载</el-button>
</div>
<!-- luckysheet容器 -->
<div
id="luckysheet"
style="
margin: 0px;
padding: 0px;
position: absolute;
width: 100%;
height: 100%;
left: 0px;
top: 50px;
"
></div>
</div>
</template>
<script setup>
import {
ref, onMounted } from "vue";
import {
exportExcel } from "./js/export";
import LuckyExcel from "luckyexcel";
const jsonData = ref({
});
//导入excel
const loadExcel = (evt) => {
const files = evt.target.files;
if (files == null || files.length == 0) {
alert("请选择文件");
return;
}
//获取文件名
let name = files[0].name;
//获取文件后缀
let suffixArr = name.split("."),
suffix = suffixArr[suffixArr.length - 1];
if (suffix != "xlsx") {
alert("当前只能导入xlsx格式文件");
return;
}
//转换导入的excel
LuckyExcel.transformExcelToLucky(
files[0],
function (exportJson, luckysheetfile) {
if (exportJson.sheets == null || exportJson.sheets.length == 0) {
alert("无法读取excel文件的内容，当前不支持xls文件!");
return;
}
console.log("exportJson", exportJson);
jsonData.value = exportJson;
//销毁之前的表格
window.luckysheet.destroy();
//创建新的表格
window.luckysheet.create({
container: "luckysheet",
showinfobar: false,
data: exportJson.sheets,
title: exportJson.info.name,
userInfo: exportJson.info.name.creator,
});
}
);
};
const downloadExcel = () => {
console.log("下载的数据：", luckysheet.getAllSheets());
//第2个参数是导出的文件名
exportExcel(luckysheet.getAllSheets(), "下载");
};
onMounted(() => {
console.log("表格：", luckysheet);
luckysheet.create({
container: "luckysheet",
title: "测试Excel", // 表 头名
lang: "zh", // 中文
showtoolbar: true, // 是否显示工具栏
showinfobar: false, // 是否显示顶部信息栏
showsheetbar: true, // 是否显示底部sheet按钮
});
});
</script>
<style scoped lang="scss"></style>
