SheetKit User Guide

SheetKit is a high-performance SpreadsheetML library for Rust and TypeScript. The Rust core handles all Excel (.xlsx) processing, and napi-rs bindings bring the same performance to TypeScript with minimal overhead.

---

Table of Contents

• Basic Operations
  • Installation
  • Quick Start
  • Workbook I/O
  • Cell Operations
  • Workbook Format and VBA Preservation
• Styling
  • Styles
• Data Features
  • Sheet Management
  • Row and Column Operations
  • Row/Column Iterators
  • Row/Column Outline Levels and Styles
  • Charts
  • Images
  • Merge Cells
  • Hyperlinks
  • Conditional Formatting
  • Tables
  • Data Conversion Utilities
• Advanced
  • Freeze/Split Panes
  • Page Layout
  • Data Validation
  • Comments
  • Auto-Filter
  • Formula Evaluation
  • Pivot Tables
  • StreamWriter
  • Document Properties
  • Workbook Protection
  • Sparklines
  • Defined Names
  • Sheet Protection
  • Sheet View Options
  • Sheet Visibility
  • Examples
  • Utility Functions
  • Theme Colors
  • Rich Text
  • File Encryption

---

Getting Started

Start with Basic Operations to learn how to create and manipulate workbooks, then explore Styling and Data Features for more advanced capabilities.

For a comprehensive reference of every API method, see the API Reference.

---

Installation

Rust

Add sheetkit to your Cargo.toml:

[dependencies]
sheetkit = "0.4"

Node.js

npm install @sheetkit/node

The Node.js package is a native addon built with napi-rs. A Rust build toolchain (rustc, cargo) is required to compile the native module during installation.

---

Quick Example

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.save("output.xlsx")?;
    Ok(())
}

TypeScript / Node.js

import { Workbook } from '@sheetkit/node';

const wb = new Workbook();
wb.setCellValue('Sheet1', 'A1', 'Hello');
await wb.save('output.xlsx');

---

Next Steps

• Learn Basic Operations with detailed examples
• Apply Styling to make your spreadsheets look professional
• Add Data Features like charts, validation, and comments
• Explore Advanced features for complex workbooks
• Check out complete example projects in examples/rust/ and examples/node/ in the repository