# @smarterp/excel

Latest version **0.1.2** (published 2023-11-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install @smarterp/excel
pnpm add @smarterp/excel
yarn add @smarterp/excel
bun add @smarterp/excel
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2023-11-25 |
| First published | 2023-11-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 107.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | smarterp |
| Maintainers | zire_frizzy, turbotechlab |

## Links

- npm: https://www.npmjs.com/package/@smarterp/excel
- Repository: https://github.com/turbotechlabs/excel-report
- Homepage: https://hoeunpichet.github.io/export-excel/
- Issues: https://github.com/HoeunPichet/export-excel/issues/new
- npm.io page: https://npm.io/package/@smarterp/excel

## Dependencies (1)

- [query](https://npm.io/package/query.md) ^0.2.0

## Recent versions

- 0.1.2 (latest) — 2023-11-25
- 0.1.1 — 2023-11-22

## README

# SmartERP Excel
<p align="center">
    <img src="https://img.shields.io/npm/dt/@smarterp/excel">
</p>

## Exmaple

Import on `resource/js/app.js`
```js
import { SmartExportExcel } from "@smarterp/excel"

export default {
    ...
    SmartExportExcel
}
```
### Simple HTML
```js
<!DOCTYPE html>
<html lang="en">
<body>
    <table id="studentList">
        <thead>
            <tr>
                <th>No</th>
                <th>Name</th>
                <th>Gender</th>
            </tr>
        </thead>
        <tbody>
            <tr>
                <td>1</td>
                <td>Danit</td>
                <td>Male</td>
            </tr>
            <tr>
                <td>2</td>
                <td>Lyly</td>
                <td>Female</td>
            </tr>
        </tbody>
    </table>
    <button type="button" onclick="exportExcel()">Export</button>

    <script>
        function exportExcel () {
            const options = {
                filename: 'Excel',
                selector: '#studentList',
                title: 'Student List',
                titleKh: 'បញ្ជីសិស្ស',
                dateFrom: '15-11-2023',
                dateTo: '30-11-2023',
            };
            new SmartExportExcel(options);
        }
    </script>
</body>
</html>
```

## Uage Option 

| Option | Description | Default Value |
| ------ | ------ | ------ |
| `selector` | Require table (class, id, attr, tag) you want to export | none
| `fileName` | Set excel file name | Excel
| `sheetName` | Set excel sheet name | `fileName`
| `title` | Set header title | `fileName`
| `titleKh` | Set header Khmer title | none
| `subtitle` | Set header Subtitle | none
| `dateFrom` | Set date from in header | `null`
| `dateTo` | Set date to in header | `null`
| `customDate` | Customize date you want (HTML, CSS) | `null`
| `extension` | Set excel extension | .xls
| `select` | Show or hide select tag when export | `true`
| `checkbox` | Show or hide checkbox when export | `true`
| `fontSize` | Set excel font size | 15px
| `fontHeadEn` | Set excel header font-family title | Times New Roman
| `fontHeadKh` | Set excel header font-family Khmer title | Khmer OS Muol Light
| `removeCell` | Remove item(s) with (class, id, attr, tag) | none
| `zoom` | Set zoom percent when export | 100
| `image{src}` | Set header image url | none
| `image{width}` | Set header image width | 133
| `image{height}` | Set header image height | auto
| `image{alt}` | Set header image alt | Turbotech
| `border` | Set table border width (thin, 1px, etc) | none
| `borderStyle` | Set table border style (solid, dotted, double, etc) | none
| `borderColor` | Set table border color (rgb, hex, etc) | none
| `tableBorder` | Set only table border outside | none
| `setTopTheadHTML` | Customize header on top of table (HTML, CSS) | none
| `setTheadHTML` | Customize table's thead (HTML, CSS) | none
| `setTfootHTML` | Customize table's footer (HTML, CSS) | none
| `setHeaderHTML` | Customize header (HTML, CSS) | none
| `setFooterHTML` | Customize footer (HTML, CSS) | none
| `footer{show}` | Show or hide footer for signature | `false`
| `footer{topstart}` | Set top start point from table | 1
| `footer{leftspan}` | Set signature left span | 1
| `footer{rightspan}` | Set signature right span | 1
| `footer{inner}` | Set inner table footer (include border with table) | `true`

---
_Source: https://npm.io/package/@smarterp/excel · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._