A lightweight JavaScript/TypeScript library to export data to Excel XLSX files with advanced formatting options.
- Export JavaScript/TypeScript arrays to Excel XLSX files
- Customizable column headers and sizes
- Support for styling (colors, fonts, etc.)
- Group data with subtitles
- Split data across multiple sheets
- Exclude specific columns
- Order columns as needed
# npm
npm install to-xlsx
# pnpm
pnpm add to-xlsximport { exportToXlsx } from "to-xlsx";
// Your data array
const employees = [
{ name: "John", age: 18, department: "IT", salary: 45000 },
{ name: "Jane", age: 25, department: "HR", salary: 55000 },
{ name: "Bob", age: 17, department: "IT", salary: 35000 },
// ...more data
];
// Basic usage
exportToXlsx({
data: employees,
fileName: "employees-report",
});
// Advanced usage with styling and grouping
exportToXlsx({
data: employees,
fileName: "employees-grouped-by-age",
title: {
text: "Employee Report - Grouped by Age",
bg: "4472C4",
color: "FFFFFF",
fontSize: 18,
},
columnsStyle: {
bg: "70AD47",
color: "FFFFFF",
fontSize: 12,
},
columnHeaders: {
name: "Employee Name",
age: "Age",
department: "Department",
salary: "Annual Salary",
},
groupBy: {
field: "age",
ranges: [
{ min: 0, max: 18, label: "Under 18" },
{ min: 18, max: 25, label: "18-25" },
{ min: 25, max: 35, label: "25-35" },
{ min: 35, max: Infinity, label: "35+" },
],
subtitleStyle: {
bg: "BDD7EE",
color: "000000",
fontSize: 14,
},
},
});Main function to export data to Excel.
| Property | Type | Description | Default |
|---|---|---|---|
| data | Array | The data array to export | Required |
| fileName | string | Name of the output file | "ExportSheet" |
| columnHeaders | Record<string, string> | null | Custom headers for columns | null |
| columnSizes | Record<string, number> | null | Custom widths for columns | null |
| columnsStyle | ColumnsStyleType | Style for column headers | null |
| columnsOrder | string[] | Order of columns in the output | null |
| excludeColumns | string[] | Columns to exclude from export | null |
| sheetsBy | SheetsByType | Split data into multiple sheets | null |
| title | TitleType | Title with optional borders | null |
| subtitle | SubTitleType | Subtitle with optional borders | null |
| groupBy | GroupByType | Group data with optional borders | null |
You can now add custom borders to Title, Subtitle, and GroupBy sections:
exportToXlsx({
// ...other props
title: {
text: "Employee Report",
bg: "4472C4",
color: "FFFFFF",
fontSize: 18,
border: {
// Apply the same border to all sides
all: {
style: "thick",
color: "000000",
},
// Or specify individual sides
// top: { style: "thin", color: "FF0000" },
// left: { style: "dotted", color: "00FF00" },
// bottom: { style: "medium", color: "0000FF" },
// right: { style: "dashed", color: "FFFF00" }
},
},
// GroupBy with custom borders for subtitles
groupBy: {
// ...other groupBy properties
subtitleStyle: {
bg: "BDD7EE",
color: "000000",
fontSize: 14,
border: {
bottom: { style: "medium", color: "0070C0" },
},
},
},
});thin- A thin border (default if style is not specified)dotted- A dotted borderdashDot- A dash-dot borderhair- A hair (very thin) borderdashDotDot- A dash-dot-dot borderslantDashDot- A slant dash-dot bordermediumDashed- A medium dashed bordermediumDashDotDot- A medium dash-dot-dot bordermediumDashDot- A medium dash-dot bordermedium- A medium borderdouble- A double borderthick- A thick border
- exceljs - Excel workbook manager
- runtime-save - File saving utility
Please see CONTRIBUTING Guide for details on how to contribute to this project.
This project adheres to a Code of Conduct. By participating, you are expected to uphold this code.
This project is licensed under the MIT License.