sheetkit-core 0.5.0

Core library for reading and writing Excel (.xlsx) files
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122

<h1>
  <img src="https://raw.githubusercontent.com/Nebu1eto/sheetkit/main/logo.svg" alt="SheetKit logo" width="40" height="40" align="absmiddle" />
  SheetKit
</h1>

[![crates.io](https://img.shields.io/crates/v/sheetkit?logo=rust)](https://crates.io/crates/sheetkit)
[![npm](https://img.shields.io/npm/v/%40sheetkit%2Fnode?logo=npm)](https://www.npmjs.com/package/@sheetkit/node)
[![Docs](https://img.shields.io/badge/docs-vitepress-059669)](https://nebu1eto.github.io/sheetkit/)
[![CI](https://github.com/Nebu1eto/sheetkit/actions/workflows/ci.yml/badge.svg)](https://github.com/Nebu1eto/sheetkit/actions/workflows/ci.yml)
[![License: MIT OR Apache-2.0](https://img.shields.io/badge/license-MIT%20OR%20Apache--2.0-blue.svg)](#license)

A Rust library for reading and writing Excel (.xlsx) files, with Node.js bindings via napi-rs.

한국어 버전은 [README.ko.md](https://github.com/Nebu1eto/sheetkit/blob/main/README.ko.md)를 참조하세요.

> **Warning**: SheetKit is experimental. APIs may change without notice. This project is under active development.

Quick links:
- [Docs](https://nebu1eto.github.io/sheetkit/)
- [Rust crate (crates.io)](https://crates.io/crates/sheetkit)
- [npm package (@sheetkit/node)](https://www.npmjs.com/package/@sheetkit/node)
- [Repository (GitHub)](https://github.com/Nebu1eto/sheetkit)

## Features

- Read/write .xlsx files
- Rust core + Node.js bindings via napi-rs (also works with Deno and Bun)
- Cell operations (string, number, boolean, date, formula)
- Sheet management (create, delete, rename, copy, active sheet)
- Row/column operations (insert, delete, resize, hide, outline)
- Style system (font, fill, border, alignment, number format, protection)
- 43 chart types with 3D support
- Images (11 formats: PNG, JPEG, GIF, BMP, ICO, TIFF, SVG, EMF, EMZ, WMF, WMZ)
- Conditional formatting (17 rule types)
- Data validation, comments, auto-filter
- Formula evaluation (110+ functions)
- Streaming writer for large datasets
- Merge cells, hyperlinks, freeze/split panes
- Page layout and print settings
- Document properties, workbook/sheet protection
- Pivot tables
- Defined names (named ranges)

## Quick Start

**Rust:**

```rust
use sheetkit::{CellValue, Workbook};

fn main() -> sheetkit::Result<()> {
    let mut wb = Workbook::new();
    wb.set_cell_value("Sheet1", "A1", CellValue::String("Hello".into()))?;
    wb.set_cell_value("Sheet1", "B1", CellValue::Number(42.0))?;
    wb.save("output.xlsx")?;
    Ok(())
}
```

**TypeScript:**

```typescript
import { Workbook } from "@sheetkit/node";

const wb = new Workbook();
wb.setCellValue("Sheet1", "A1", "Hello");
wb.setCellValue("Sheet1", "B1", 42);
wb.save("output.xlsx");
```

## Installation

**Rust** -- use `cargo add` (recommended):

```bash
cargo add sheetkit
```

Or add to your `Cargo.toml`:

```toml
[dependencies]
sheetkit = "0.5.0"
```

[View on crates.io](https://crates.io/crates/sheetkit)

**Node.js:**

```bash
# npm
npm install @sheetkit/node

# yarn
yarn add @sheetkit/node

# pnpm
pnpm add @sheetkit/node
```

[View on npm](https://www.npmjs.com/package/@sheetkit/node)

### Deno / Bun

SheetKit's Node.js bindings use [napi-rs](https://napi.rs/), which is compatible with other JavaScript runtimes that support Node-API:

- **Deno**: Supports napi-rs native addons via the [`--allow-ffi`](https://docs.deno.com/runtime/fundamentals/security/#ffi-(foreign-function-interface)) permission flag.
- **Bun**: Supports Node-API natively. Most napi-rs modules [work out of the box](https://bun.com/docs/runtime/node-api).

## Documentation

**[Documentation Site](https://nebu1eto.github.io/sheetkit/)** | [Korean (한국어)](https://nebu1eto.github.io/sheetkit/ko/)

See the [docs/](https://github.com/Nebu1eto/sheetkit/tree/main/docs) folder for documentation source files.

## Acknowledgements

SheetKit is heavily inspired by the implementation of [Excelize](https://github.com/qax-os/excelize), the Go library for Excel files. This project was built for the Rust and TypeScript projects, and we have great respect and admiration for the work done by the Excelize team and its contributors.

## License

MIT OR Apache-2.0