JS Excel file builder with zero dependencies.
npm install xldx
# or
bun add xldx- Zero dependencies
- Pattern-based styling and theming
- Multi-sheet support
- Full type safety
- Works in browsers and node, bun, or deno
- < 17KB minified
import { Xldx } from 'xldx';
// Sample data
const data = [
{ id: 1, name: 'John', age: 30, status: 'active' },
{ id: 2, name: 'Jane', age: 25, status: 'inactive' },
{ id: 3, name: 'Bob', age: 35, status: 'active' }
];
// Create Excel builder
const xlsx = new Xldx(data);
// Create a sheet with columns
xlsx.createSheet(
{ name: 'Users' },
{ key: 'id', header: 'ID', width: 10 },
{ key: 'name', header: 'Name', width: 20 },
{ key: 'age', header: 'Age', width: 10 },
{ key: 'status', header: 'Status', width: 15 }
);
// node, bun, or deno - write to file
await xlsx.write('users.xlsx');
// Browser - trigger download
await xlsx.download('users.xlsx');
// Get raw data
const buffer = await xlsx.toBuffer(); // Buffer
const uint8Array = await xlsx.toUint8Array(); // Uint8Array
const blob = await xlsx.toBlob(); // Browser Blobimport { Xldx, themes } from 'xldx';
const xlsx = new Xldx(data);
xlsx.setTheme(themes.dark);xlsx.createSheet(
{ name: 'StyledSheet' },
{
key: 'status',
header: 'Status',
patterns: {
bgColorPattern: (context) => {
if (context.value === 'active') {
return { fill: { type: 'pattern', pattern: 'solid', fgColor: '90EE90FF' } };
}
return null;
}
}
}
);xlsx.createSheet(
{ name: 'ZebraSheet' },
{
key: 'data',
patterns: {
bgColorPattern: 'zebra' // Built-in zebra pattern
}
}
);new Xldx(data: DataRow[] | SheetsData, options?: XldxOptions)setTheme(theme: ColorTheme): this- Set the color themecreateSheet(options: SheetOptions, ...columns: ColumnDefinition[]): this- Create a new worksheetcreateSheets(sheets: Array<{options: SheetOptions; columns: ColumnDefinition[]}>): this- Create multiple worksheetstoBuffer(): Promise<Buffer>- Generate Excel file as Buffer (node, bun, or deno)toUint8Array(): Promise<Uint8Array>- Generate Excel file as Uint8ArraytoBlob(): Promise<Blob>- Generate Excel file as Blob (Browser)download(filename?: string): Promise<void>- Trigger file download (Browser only)write(filePath: string): Promise<void>- Write Excel file to disk (node, bun, or deno only)toJSON(): any- Export workbook structure as JSONstatic fromJSON(json: any): Xldx- Create from JSON structurestatic read(data: Uint8Array | Buffer): Promise<any>- Read XLSX file
# Install dependencies
bun install
# Run tests
bun test
# Build
bun run build
# Lint
bun run lint
# Type check
bun run typecheckMIT
