# vxe-table-plugin-export-xlsx

**Repository Path**: x-extends/vxe-table-plugin-export-xlsx

## Basic Information

- **Project Name**: vxe-table-plugin-export-xlsx
- **Description**:  基于 vxe-table 表格的增强插件，支持导出 xlsx 格式
- **Primary Language**: TypeScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 49
- **Forks**: 15
- **Created**: 2019-11-13
- **Last Updated**: 2024-12-03

## Categories & Tags

**Categories**: webui

**Tags**: None

## README

# vxe-table-plugin-export-xlsx

[![gitee star](https://gitee.com/x-extends/vxe-table-plugin-export-xlsx/badge/star.svg?theme=dark)](https://gitee.com/x-extends/vxe-table-plugin-export-xlsx/stargazers)
[![npm version](https://img.shields.io/npm/v/vxe-table-plugin-export-xlsx.svg?style=flat-square)](https://www.npmjs.com/package/vxe-table-plugin-export-xlsx)
[![npm downloads](https://img.shields.io/npm/dm/vxe-table-plugin-export-xlsx.svg?style=flat-square)](http://npm-stat.com/charts.html?package=vxe-table-plugin-export-xlsx)
[![npm license](https://img.shields.io/github/license/mashape/apistatus.svg)](LICENSE)

基于 [vxe-table](https://www.npmjs.com/package/vxe-table) 的表格插件，支持导出 xlsx 格式，基于 [exceljs](https://github.com/exceljs/exceljs) 实现

## Compatibility

对应 vxe-table v4 版本  

## Installing

```shell
npm install vxe-table vxe-table-plugin-export-xlsx exceljs
```

```javascript
// ...
import { VxeUI } from 'vxe-table'
import VXETablePluginExportXLSX from 'vxe-table-plugin-export-xlsx'
import ExcelJS from 'exceljs'
// ...

// 方式1：NPM 安装，注入 ExcelJS 对象
VxeUI.use(VXETablePluginExportXLSX, {
  ExcelJS
})

// 方式2：CDN 安装，只要确保 window.ExcelJS 存在即可
// VxeUI.use(VXETablePluginExportXLSX)
```

## Demo

```html
<vxe-toolbar>
  <template v-slot:buttons>
    <vxe-button @click="exportEvent">导出.xlsx</vxe-button>
  </template>
</vxe-toolbar>

<vxe-table
  ref="xTable"
  height="600"
  :data="tableData">
  <vxe-column type="seq" width="60"></vxe-column>
  <vxe-column field="name" title="Name"></vxe-column>
  <vxe-column field="age" title="Age"></vxe-column>
  <vxe-column field="date" title="Date"></vxe-column>
</vxe-table>
```

```javascript
export default {
  data () {
    return {
      tableData: [
        { id: 100, name: 'test', age: 26, date: null },
        { id: 101, name: 'test1', age: 30, date: null },
        { id: 102, name: 'test2', age: 34, date: null }
      ]
    }
  },
  methods: {
    exportEvent() {
      this.$refs.xTable.exportData({
        filename: 'export',
        sheetName: 'Sheet1',
        type: 'xlsx'
      })
    }
  }
}
```

## Contributors

Thank you to everyone who contributed to this project.

[![vxe-table-plugin-export-xlsx](https://contrib.rocks/image?repo=x-extends/vxe-table-plugin-export-xlsx)](https://github.com/x-extends/vxe-table-plugin-export-xlsx/graphs/contributors)

## License

[MIT](LICENSE) © 2019-present, Xu Liangzhan