Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ghiscoding/excel-builder-vanilla
Build Excel files from JavaScript
https://github.com/ghiscoding/excel-builder-vanilla
excel excel-export excelwriter spreadsheet
Last synced: about 2 months ago
JSON representation
Build Excel files from JavaScript
- Host: GitHub
- URL: https://github.com/ghiscoding/excel-builder-vanilla
- Owner: ghiscoding
- License: mit
- Created: 2024-02-02T05:20:54.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-10-24T17:37:14.000Z (about 2 months ago)
- Last Synced: 2024-10-24T21:17:01.610Z (about 2 months ago)
- Topics: excel, excel-export, excelwriter, spreadsheet
- Language: TypeScript
- Homepage: https://ghiscoding.github.io/excel-builder-vanilla/
- Size: 1.49 MB
- Stars: 6
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Excel-Builder-Vanilla
[](https://opensource.org/licenses/MIT)
[](http://www.typescriptlang.org/)
[](https://vitest.dev/)
[](https://codecov.io/gh/ghiscoding/excel-builder-vanilla)
[](https://github.com/ghiscoding/excel-builder-vanilla/actions)
[](https://npmjs.org/package/excel-builder-vanilla)
[](https://www.npmjs.com/package/excel-builder-vanilla)
[](https://bundlephobia.com/result?p=excel-builder-vanilla)
## Documentation
📘 [Documentation](https://ghiscoding.gitbook.io/excel-builder-vanilla/) website powered by GitBook (_previous project docs were pulled from [web archive](http://web.archive.org/web/20160907052007/http://excelbuilderjs.com)_)
## Description
This lib allows you to build and write an Excel file dynamically, it does **not** include any reader capabilities making the library super lightweight.
## Live Demo
Visit the [**Live demo**](https://ghiscoding.github.io/excel-builder-vanilla/) to get started and see all available options and methods that the library offers.
You can also take a look at the "[Used by](#used-by)" section below to see real world applications taking advantage of this library.
## Changelog
[CHANGELOG](https://github.com/ghiscoding/excel-builder-vanilla/blob/main/packages/excel-builder-vanilla/CHANGELOG.md)
## LICENSE
[MIT License](https://github.com/ghiscoding/excel-builder-vanilla/blob/main/LICENSE.md)
## Project History
Excel-Builder-Vanilla is a fork of the popular [excel-builder.js](https://github.com/stephenliberty/excel-builder.js) project (thanks to @stephenliberty for this great library). The main goal of creating this fork was to modernize the project by removing old dependencies that are no longer necessary and also replace `JSZip` by `fflate` which provides an ESM build and is indirectly giving us better Tree Shaking. The other goal was also to provide an ESM build to eventually get away from CommonJS (CJS bundle is still offered but we strongly suggest that you migrate to the ESM approach)
The modernization steps:
- migrate to TypeScript (which is giving us TS Types `d.ts`)
- drop `Q` dependency (we now simply use native `Promise`)
- drop `Lodash` dependency (we now use native JS code)
- replace `JSZip` dependency with [`fflate`](https://github.com/101arrowz/fflate) which has an ESM build and offers better performance.
- bump version to `v3.0.0` as a `major` release (_the original project version was in the `2.x` range._)
- note that the changelog did not exists prior to `v3.0.0`
The project now requires only 1 dependency which is [fflate](https://github.com/101arrowz/fflate).
### Summary
This modernization is providing a huge decrease in the final build size, with only 1 dependency, and also offers better performance 🚀
## Installation
[](https:///pr.new/ghiscoding/excel-builder-vanilla)
```sh
npm install excel-builder-vanilla
```
The project offers 3 different build types, choose the best one depending on your use case
1. **ESM**: to `import from` (_**preferred**_)
2. **CJS**: CommonJS to support old NodeJS `require()` - will probably be dropped in the future
3. **IIFE**: standalone script which provides `ExcelBuilder` on the `window` object
```ts
// ESM (preferred) - npm install
import { createWorksheet } from 'excel-builder-vanilla';
// CJS - npm install
const { createWorksheet } = require('excel-builder-vanilla');
// IIFE - CDN
const worksheet = ExcelBuilder.createWorksheet(); // or window.ExcelBuilder.createWorksheet();
```
### CSP (Content Security Policy)
Please note that since we use `fflate` (which creates and compresses the Excel file before sending it to the browser), you might get some CSP errors because of its use of Web Workers. For that reason, you might need to adjust your CSP rules by adding `worker-src 'self' blob:;`
```html
```
### Used by
This fork was created mostly to support Tree Shaking (ESM), to get away from CJS, to provide TS Types and finally to update all project dependencies. It is used by a few other Open Source libraries that I also maintain and require Excel export:
- [Angular-Slickgrid](https://github.com/ghiscoding/Angular-Slickgrid)
- [Aurelia-Slickgrid](https://github.com/ghiscoding/aurelia-slickgrid)
- [Slickgrid-React](https://github.com/ghiscoding/slickgrid-react)
- [Slickgrid-Universal](https://github.com/ghiscoding/slickgrid-universal)
## Contributions
[](https://github.com/ghiscoding/excel-builder-vanilla/pulls)
[Pull Request](https://github.com/ghiscoding/excel-builder-vanilla/pulls) are welcome, feel free to contribute.
### Development / Contributions
If you wish to contribute to the project, please follow the steps below:
**Note**: this project uses [pnpm workspaces](https://pnpm.io/workspaces), you can install pnpm by following their [installation](https://pnpm.io/installation) or use NodeJS `corepack enable` to run any of the pnpm scripts shown below:
1. clone the lib:
- `git clone https://github.com/ghiscoding/excel-builder-vanilla`
2. install it with **pnpm** from the project root:
- `pnpm install` OR `npx pnpm install`
3. run a full TypeScript build
- `pnpm run build` OR `npx pnpm run build`
4. run in development mode (lib & demo)
- `pnpm run dev` OR `npx pnpm run dev`
#### Pull Request Contribution
Before submitting a PR (pull request), please make sure that you followed these steps for a better chance of a successfull PR:
1. make sure that you have already executed `pnpm install`
2. run the Biome lint npm script (or simply use step 4)
- `pnpm run biome:lint:write`
3. run the Biome code formatting npm script (or simply use step 4)
- `pnpm run biome:format:write`
4. run a full Build (this will also run Biome lint/format, so you could skip step 2)
- `pnpm run build`
### Packages
| Package Name | NPM downloads | Size (gzip) | Changes | Description |
| -------------| ------- | ----------- | ------- | ----------- |
| [excel-builder-vanilla](https://github.com/ghiscoding/excel-builder-vanilla/tree/main/packages/excel-builder-vanilla) | [](https://npmjs.org/package/excel-builder-vanilla) | [](https://bundlephobia.com/result?p=excel-builder-vanilla) | [changelog](https://github.com/ghiscoding/excel-builder-vanilla/blob/main/packages/excel-builder-vanilla/CHANGELOG.md) | `excel-builder-vanilla` library package |
| [excel-builder-vanilla-types](https://github.com/ghiscoding/excel-builder/tree/main/packages/excel-builder-vanilla-types) | [](https://npmjs.org/package/@excel-builder-vanilla/types) | [](https://bundlephobia.com/result?p=@excel-builder-vanilla/types) | [changelog](https://github.com/ghiscoding/excel-builder-vanilla/blob/main/packages/excel-builder-vanilla-types/CHANGELOG.md) | `excel-builder-vanilla` dts types only package.
## Sponsors
