---
type: Basic
title: xlsx
order: 6
subtitle: Excel
cols: 1
module: XlsxModule
config: XlsxConfig
---

An Excel file operation based on [sheetjs](http://sheetjs.com/).

> Note: You can also use [js-xlsx](https://github.com/protobi/js-xlsx) to be another Fork by sheetjs library that provides additional options including: images, styles, and more. Finally, use `callback` option to render your excel.

## Dependencies

```
yarn add file-saver
```

The sheetjs script file takes the form of lazy loading. Allows you to specify a CDN URL in `XlsxModule.forRoot({})` module. The default is `//cdn.bootcss.com/xlsx/0.12.13/xlsx.full.min.js`.

## API

### LazyService

Property | Description | Type | Default
----|------|-----|------
`import(fileOrUrl: File | string)` | Import Excel, return JSON  | `Promise<{ [key: string]: any[][] }>` | -
`export(options: XlsxExportOptions)` | Export Excel  | `Promise<void>` | -

### XlsxExportOptions

Property | Description | Type | Default
----|------|-----|------
`[sheets]` | Data source | `{ [sheet: string]: WorkSheet } | XlsxExportSheet[]` | -
`[filename]` | file name of excel | `string` | `export.xlsx`
`[opts]` | Excel options, see [WritingOptions](https://docs.sheetjs.com/#writing-options) | `WritingOptions` | -
`[callback]` | Trigger before saving | `(wb: WorkBook) => void` | -

### [xlsx]

xlsx directive.

```html
<div [xlsx]="XlsxExportOptions">Export</div>
```

## FAQ

### csv format

The file encoding format must be UTF8 with BOM.