# export-json-as-xlsx

> Create excel xlsx file from json

Latest version **0.0.9** (published 2023-07-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install export-json-as-xlsx
pnpm add export-json-as-xlsx
yarn add export-json-as-xlsx
bun add export-json-as-xlsx
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.9 |
| Published | 2023-07-20 |
| First published | 2023-07-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 14.3 KB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Aleksandr Kritskii |
| Maintainers | kritskii-a |
| Keywords | json, xlsx, excel, jsonc, json-xlsx, xlsx-json, create-xlsx, create-excel, json-as-xlsx, json-to-xlsx, json-as-excel, json-to-excel, xlsx-as-json, xlsx-from-json, microsoft, microsoft-xlsx, microsoft-excel, spreadsheet, xls |

## Links

- npm: https://www.npmjs.com/package/export-json-as-xlsx
- Repository: https://github.com/Kritskii-A/export-json-as-xlsx
- Homepage: https://export-json-as-xlsx.vercel.app
- Issues: https://github.com/Kritskii-A/export-json-as-xlsx/issues
- npm.io page: https://npm.io/package/export-json-as-xlsx

## Dependencies (1)

- [xlsx](https://npm.io/package/xlsx.md) ^0.18.5

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 0.0.9 (latest) — 2023-07-20
- 0.0.8 — 2023-07-19
- 0.0.7 — 2023-07-19
- 0.0.6 — 2023-07-19
- 0.0.5 — 2023-07-19
- 0.0.4 — 2023-07-19
- 0.0.3 — 2023-07-19
- 0.0.2 — 2023-07-19
- 0.0.1 — 2023-07-19

## README

# export-json-as-xlsx

This is a tool that helps to build an excel from a json and it depends only on `xlsx` library

You can see a live example of it working on any of this sites (there are many just in case):

- [export-json-as-xlsx.vercel.app](https://export-json-as-xlsx.vercel.app)

## Usage

```js
import xlsx from "export-json-as-xlsx"
// or require
let xlsx = require("export-json-as-xlsx")

let data = [
  {
    sheet: "Adults",
    columns: [
      { label: "User", value: "user", isFormula: true }, // Use formuls
      { label: "Age", value: "age", format: '# "years"' }, // Custom format
      { label: "Phone", value: (row: any) => row?.more?.phone ?? "", width: "5" }, // Run functions and add width
      { label: "Date", value: "date", format: "DD.MM.YYYY", type: "d" }, // Set type
    ],
    content: [
      { user: `=HYPERLINK("${window.location.origin}", "Alex")`, age: 20, more: { phone: "11111111" }, date: "1999.02.20" },
      { user: "Luis", age: 21, more: { phone: "12345678" }, date: "1999.01.21" },
    ],
  },
  {
    sheet: "Children",
    columns: [
      { label: "User", value: "user" }, // Top level data
      { label: "Age", value: "age", format: '# "years"' }, // Custom format
      { label: "Phone", value: (row: any) => row?.more?.phone ?? "" }, // Run functions
    ],
    content: [
      { user: "Manuel", age: 16, more: { phone: "99999999" } },
      { user: "Ana", age: 17, more: { phone: "87654321" } },
    ],
  },
]

let settings = {
  fileName: "MySpreadsheet", // Name of the resulting spreadsheet
  extraLength: 3, // A bigger number means that columns will be wider
  writeMode: "writeFile", // The available parameters are 'WriteFile' and 'write'. This setting is optional. Useful in such cases https://docs.sheetjs.com/docs/solutions/output#example-remote-file
  writeOptions: {}, // Style options from https://docs.sheetjs.com/docs/api/write-options
  RTL: true, // Display the columns from right-to-left (the default value is false)
}

xlsx(data, settings) // Will download the excel file
```

If you want to trigger something after the file is downloaded, you can use the `callback` parameter:

```js
let callback = function (sheet) {
  console.log("Download complete:", sheet)
}

xlsx(data, settings, callback) // Will download the excel file
```

### Column formatting

> **Note:** Cell formatting is type based, i.e. the format type and value type must match.
>
> If you want to use a Date format, the value must be of type Date; if you want a number format, the value must be a Number.

Column formatting can be provided in the column object, i.e.

```js
columns: [{ label: "Income", value: "income", format: "€#,##0.00" }]
```

- A list of SheetJS format examples can be found
  here: [SSF library](https://github.com/SheetJS/sheetjs/blob/f443aa8475ebf051fc4e888cf0a6c3e5b751813c/bits/10_ssf.js#L42)
- ECMA-376 number formatting
  specification: [Number formats](https://c-rex.net/projects/samples/ooxml/e1/Part4/OOXML_P4_DOCX_numFmts_topic_ID0E6KK6.html)

Examples

```js
// Number formats
"$0.00" // Basic
"\£#,##0.00" // Pound
"0%" // Percentage
'#.# "ft"' // Number and text

// Date formats
"d-mmm-yy" // 12-Mar-22
"ddd" // (eg. Sat)
"dddd" // (eg. Saturday)
"h:mm AM/PM" // 1:10 PM
```

### Cell Object

| Key         | Description                                                         |
| ----------- | ------------------------------------------------------------------- |
| `isFormula` | use formula                                                         |
| `format`    | use custom format                                                   |
| `type`      | cell type: `b` Boolean, `n` Number, `e` error, `s` String, `d` Date |
| `width`     | cell width (auto width default)                                     |

## Examples

This are files used for development, please change imports from `../../src/index` to `export-json-as-xlsx`

- [Express with TypeScript](https://github.com/Kritskii-A/export-json-as-xlsx/blob/main/packages/demo-express)
- [ReactJS with TypeScript](https://github.com/Kritskii-A/export-json-as-xlsx/blob/main/packages/demo-reactjs)

## 🙏 Thanks

This project is a fork of [SheetJS/sheetjs](https://github.com/sheetjs/sheetjs) combined with code from
[json-as-xlsx](https://github.com/LuisEnMarroquin/json-as-xlsx) (by [LuisEnMarroquin](https://github.com/LuisEnMarroquin)).

---
_Source: https://npm.io/package/export-json-as-xlsx · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._