Vue Luckyexcel 将文件流转成file文件后使用Luckysheet回显数据 - 附完整示例

Web - Nancy

已于 2024-04-07 11:11:06 修改

阅读量5.3k

点赞数 9

分类专栏： Plugins Vue2 文章标签： vue.js 前端 javascript vue 前端框架

于 2023-06-26 09:15:00 首次发布

本文链接：https://blog.csdn.net/m0_48968874/article/details/131187416

版权

Vue2 同时被 2 个专栏收录

13 篇文章 0 订阅

订阅专栏

Plugins

10 篇文章 0 订阅

订阅专栏

Luckysheet ：一款纯前端类似excel的在线表格，功能强大、配置简单、完全开源。

官方文档：快速上手 | Luckysheet文档快速上手 | Luckysheet文档Luckysheet ，一款纯前端类似excel的在线表格，功能强大、配置简单、完全开源。本站包含官方配置文档,API,教程。https://mengshukeji.gitee.io/luckysheetdocs/zh/guide/

效果

注：因为项目只需要以Excel的形式展示，所以去除了工具栏、顶部信息栏、底部计数栏等配置，更多配置详见官方文档

一、准备工作

1、安装依赖包

npm install luckyexcel --save

2、示例版本

"luckyexcel": "^1.0.1",

二、使用步骤

1、在index.html文件中引入依赖包

代码如下（示例）：

  <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>

2、单文件使用

代码如下（示例）：

import LuckyExcel from 'luckyexcel';

3、调用

代码如下（示例）：

loadExcel() {
      const token = '用户token'
      axios.get('你的接口地址', {
        headers: { 'Token': token },
        responseType: 'blob',
        params: {
          // 参数
        }
      }).then((response) => {
        // 将获取到的文件对象传递给 uploadExcel 方法
        const file = new File([response.data], 'XXX.xlsx', { type: response.data.type });
        console.log(file);
        var files = [];
        files.push(file);
        this.uploadExcel(files);
      })
      .catch((error) => {
        console.error('文件获取失败：', error);
      })
    },
    uploadExcel(files) {
      if (files == null || files.length == 0) return alert('没有文件等待导入');

      let name = files[0].name;
      let suffixArr = name.split('.'),
        suffix = suffixArr[suffixArr.length - 1];
      if (suffix != 'xlsx') return alert('目前只支持导入xlsx文件');
        
      LuckyExcel.transformExcelToLucky(files[0], function (exportJson, luckysheetfile) {
        if (exportJson.sheets == null || exportJson.sheets.length == 0) return alert('读取excel文件内容失败, 目前不支持XLS文件!');
        window.luckysheet.destroy();

        window.luckysheet.create({
          data: exportJson.sheets,
          title: exportJson.info.name,
          userInfo: exportJson.info.name.creator,
          container: 'luckysheet', // 设定DOM容器的id
          showtoolbar: false, // 是否显示工具栏
          showinfobar: false, // 是否显示顶部信息栏
          showstatisticBar: false, // 是否显示底部计数栏
          sheetBottomConfig: false, // sheet页下方的添加行按钮和回到顶部按钮配置
          allowEdit: false, // 是否允许前台编辑
          enableAddRow: false, // 是否允许增加行
          enableAddCol: false, // 是否允许增加列
          sheetFormulaBar: false, // 是否显示公式栏
          enableAddBackTop: false, // 返回头部按钮
          showsheetbar: false, // 是否显示底部sheet页按钮
          enableAddRow: false,//允许添加行
          // 自定义配置底部sheet页按钮
          showsheetbarConfig: {
            add: false,
            menu: false,
          },
        });
      });
    },

三、注意事项

1、一定要给容器设置宽高等样式

<div style="position: relative;height: 100vh;;">
  <div
    id="luckysheet"
    style="padding: 0px; position: absolute; width: 100%; left: 0px; top: 10px; bottom: 10px"
   >
   </div>
 </div>

2、请求接口的时候需要配置 responseType: 'blob'，至少我的这个项目是这样的

responseType: 'blob',

3、接收接口响应回来的数据的处理 { type: response.data.type }，至少我的这个项目是这样的

const file = new File([response.data], 'XXX.xlsx', { type: response.data.type });

tips2、3如果没有配置的话，能够正常请求接口并返回数据，但是不会正常显示excel表格，这是一个不太明显坑。

四、完整示例

index.html

<!DOCTYPE html>
<html lang="zh-cmn-Hans">
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width,initial-scale=1.0">
    <title>XXX</title>
    <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>
  </head>
  <body>
    <div id="app"></div>
</html>

LuckyExcel.vue

<template>
  <div style="position: relative;height: 100vh;;">
    <div
      id="luckysheet"
      style="padding: 0px; position: absolute; width: 100%; left: 0px; top: 10px; bottom: 10px"
   >
    </div>
  </div>
</template>

<script>
  import LuckyExcel from 'luckyexcel';
  import axios from 'axios';
  
  mounted() {
    this.loadExcel();
  },

  methods: {
    loadExcel() {
      const token = '用户token'
      axios.get('你的接口地址', {
        headers: { 'Token': token },
        responseType: 'blob',
        params: {
          // 参数
        }
      }).then((response) => {
        // 将获取到的文件对象传递给 uploadExcel 方法
        const file = new File([response.data], 'XXX.xlsx', { type: response.data.type });
        console.log(file);
        var files = [];
        files.push(file);
        this.uploadExcel(files);
      })
      .catch((error) => {
        console.error('文件获取失败：', error);
      })
    },
    uploadExcel(files) {
      if (files == null || files.length == 0) return alert('没有文件等待导入');

      let name = files[0].name;
      let suffixArr = name.split('.'),
        suffix = suffixArr[suffixArr.length - 1];
      if (suffix != 'xlsx') return alert('目前只支持导入xlsx文件');
        
      LuckyExcel.transformExcelToLucky(files[0], function (exportJson, luckysheetfile) {
        if (exportJson.sheets == null || exportJson.sheets.length == 0) return alert('读取excel文件内容失败, 目前不支持XLS文件!');
        window.luckysheet.destroy();

        window.luckysheet.create({
          data: exportJson.sheets,
          title: exportJson.info.name,
          userInfo: exportJson.info.name.creator,
          container: 'luckysheet', // 设定DOM容器的id
          showtoolbar: false, // 是否显示工具栏
          showinfobar: false, // 是否显示顶部信息栏
          showstatisticBar: false, // 是否显示底部计数栏
          sheetBottomConfig: false, // sheet页下方的添加行按钮和回到顶部按钮配置
          allowEdit: false, // 是否允许前台编辑
          enableAddRow: false, // 是否允许增加行
          enableAddCol: false, // 是否允许增加列
          sheetFormulaBar: false, // 是否显示公式栏
          enableAddBackTop: false, // 返回头部按钮
          showsheetbar: false, // 是否显示底部sheet页按钮
          enableAddRow: false,//允许添加行
          // 自定义配置底部sheet页按钮
          showsheetbarConfig: {
            add: false,
            menu: false,
          },
        });
      });
    },
  }