ExcelJS

Read, manipulate and write spreadsheet data and styles to XLSX and JSON.

Reverse engineered from Excel spreadsheet files as a project.

Translations

中文文档

Installation

npm install exceljs

New Features!

Merged Add pivot table with limitations #2551. Many thanks to Protobi and <a href="https://github.com/mikez">Michael</a> for this contribution!
Merged fix: styles rendering in case when "numFmt" is present in conditional formatting rules (resolves #1814) #1815. Many thanks to @andreykrupskii for this contribution!
Merged inlineStr cell type support #1575 #1576. Many thanks to @drdmitry for this contribution!
Merged Fix parsing of boolean attributes #1849. Many thanks to @bno1 for this contribution!
Merged add optional custom auto-filter to table #1670. Many thanks to @thambley for this contribution!
Merged Deep copy inherited style #1850. Many thanks to @ikzhr for this contribution!
Merged Upgrade actions/cache and actions/setup-node #1846. Many thanks to @cclauss for this contribution!
Merged Check object keys in isEqual #1831. Many thanks to @bno1 for this contribution!
Merged Add v17 to testing workflow #1856. Many thanks to @Siemienik for this contribution!
Merged Upgrade jszip to its latest version to date. This version does not have any vulnerability found by Snyk so far #1895. Many thanks to @ValerioSevilla for this contribution!
Merged Update README.md #1677. Many thanks to @xjrcode for this contribution!
Merged (docs): set prototype of RegExp correctly. #1700. Many thanks to @joeldenning for this contribution!
Merged Added timeouts to github actions #1733. Many thanks to @alexbjorlig for this contribution!
Merged fix issue 1676 #1701. Many thanks to @skypesky for this contribution!
Merged ExcelJS/ExcelJS#2237 : Update CI Tests, Drop support for Node v8 #2242. Many thanks to @Siemienik for this contribution!
Merged Fix types for getWorksheet() #2223. Many thanks to @hfhchan-plb for this contribution!
Merged add characters cannot be used for worksheet name #2126. Many thanks to @tkm-kj for this contribution!
Merged Fix issue #1753 Reject promise when workbook reader is writing to temporary file stream and error occurs #1756. Many thanks to @pauliusg for this contribution!
Merged README.md to have correct link for Streaming XLSX #2186. Many thanks to @wulfsolter for this contribution!
Merged Added a polyfill of promise.finally to support lower versions of Firefox. #1982. Many thanks to @DemoJj for this contribution!
Merged Fix read this.worksheet before assign it #1934. Many thanks to @ZyqGitHub1 for this contribution!
Merged chore: upgrade jszip to ^3.10.1 #2211. Many thanks to @jarrod-cocoon for this contribution!
Merged fixed spelling error in README.md file #2208. Many thanks to @HugoP27 for this contribution!
Merged fix: Fix xlsx.writeFile() not catching error when error occurs #2244. Many thanks to @zurmokeeper for this contribution!
Merged Improve worksheets' naming validation logic. #2257. Many thanks to @Siemienik for this contribution!
Merged fix issue 2125 - spliceRows remove last row #2140. Many thanks to @babu-ch for this contribution!
Merged fix: fix the loss of column attributes due to incorrect column order #2222. Many thanks to @cpaiyueyue for this contribution!
Merged Fix: Sheet Properties Types #2327. Many thanks to @albeniraouf for this contribution!
Merged Use node 18 LTS for tsc, and benchmark. Add node 20. to test matrix. … #2354. Many thanks to @Siemienik for this contribution!
Merged Add missing tooltip attribute to CellHyperlinkValue index.d.ts #2350. Many thanks to @NiklasPor for this contribution!
Merged Increase resilience to generating large workbooks #2320. Many thanks to @hfhchan-plb for this contribution!
Merged repair all 'c2fo.io' links ('c2fo.github.io') #2324. Many thanks to @justintunev7 for this contribution!
Merged fix: fix type definitions about last column, formula values and protection #2309. Many thanks to @gltjk for this contribution!
Merged fix: add spinCount field for WorksheetProtection type #2284. Many thanks to @damingerdai for this contribution!
Merged Add type definition for WorksheetModel.merges #2281. Many thanks to @ytjmt for this contribution!

Contributions

Contributions are very welcome! It helps me know what features are desired or what bugs are causing the most pain.

I have just one request; If you submit a pull request for a bugfix, please add a unit-test or integration-test (in the spec folder) that catches the problem. Even a PR that just has a failing test is fine - I can analyse what the test is doing and fix the code from that.

Note: Please try to avoid modifying the package version in a PR. Versions are updated on release and any change will most likely result in merge collisions.

To be clear, all contributions added to this library will be included in the library's MIT licence.

Let's chat together:

<ul> <li><a href="#importing">Importing</a></li> <li> <a href="#interface">Interface</a> <ul> <li><a href="#create-a-workbook">Create a Workbook</a></li> <li><a href="#set-workbook-properties">Set Workbook Properties</a></li> <li><a href="#workbook-views">Workbook Views</a></li> <li><a href="#add-a-worksheet">Add a Worksheet</a></li> <li><a href="#remove-a-worksheet">Remove a Worksheet</a></li> <li><a href="#access-worksheets">Access Worksheets</a></li> <li><a href="#worksheet-state">Worksheet State</a></li> <li><a href="#worksheet-properties">Worksheet Properties</a></li> <li><a href="#page-setup">Page Setup</a></li> <li><a href="#headers-and-footers">Headers and Footers</a></li> <li> <a href="#worksheet-views">Worksheet Views</a> <ul> <li><a href="#frozen-views">Frozen Views</a></li> <li><a href="#split-views">Split Views</a></li> </ul> </li> <li><a href="#auto-filters">Auto Filters</a></li> <li><a href="#columns">Columns</a></li> <li><a href="#rows">Rows</a> <ul> <li><a href="#add-rows">Add Rows</a></li> <li><a href="#handling-individual-cells">Handling Individual Cells</a></li> <li><a href="#merged-cells">Merged Cells</a></li> <li><a href="#insert-rows">Insert Rows</a></li> <li><a href="#splice">Splice</a></li> <li><a href="#duplicate-a-row">Duplicate Row</a></li> </ul> </li> <li><a href="#defined-names">Defined Names</a></li> <li><a href="#data-validations">Data Validations</a></li> <li><a href="#cell-comments">Cell Comments</a></li> <

Exceljs

Install / Use

README