Skip to content

Latest commit

 

History

History
117 lines (91 loc) · 4.28 KB

README.md

File metadata and controls

117 lines (91 loc) · 4.28 KB
Raw

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):

Usage

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:

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.

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

Examples

// 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

🙏 Thanks

This project is a fork of SheetJS/sheetjs combined with code from json-as-xlsx (by LuisEnMarroquin).