# LuckySheet Vue 组件

**Repository Path**: onlyxc/lucky-sheet-vue-component

## Basic Information

- **Project Name**: LuckySheet Vue 组件
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 1
- **Created**: 2022-01-29
- **Last Updated**: 2025-09-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# luckysheet

## 预览

```
npm run serve
```

## 打包

```
npm run lib
```

## 使用

1. 安装

```
npm i git+https://gitee.com/onlyxc/lucky-sheet-vue-component.git
```

2. 在入口 html 中添加以下代码

```html
<!-- style -->
<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 -->
<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>
```

3. main.js

```javascript
import Vue from "vue";
import luckysheet from "luckysheet";

Vue.use(luckysheet);
```

4. 模板中使用

```vue
<template>
  <LuckySheet></LuckySheet>
</template>
```

## 说明

### Props

| 参数 | 说明           | 类型   | 可选值                            | 默认值 |
| ---- | -------------- | ------ | --------------------------------- | ------ |
| type | 指定表格的模式 | String | design(设计模式)、use（使用模式） | design |

### Api

| 方法名     | 说明                                        | 参数      |
| ---------- | ------------------------------------------- | --------- |
| parseExcel | 解析 excel 文件，返回解析之后的数据         | file      |
| render     | 通过 excel 数据来渲染表格                   | excelData |
| save       | 保存设计之后的 excel 数据                   |           |
| saveImg    | 将展示的 excel 保存为图片，返回 base64 数据 |           |
| savePdf    | 将展示的 excel 保存为 pdf，直接下载         | name      |