@christophervr/xlsx-react-viewer

A browser Excel spreadsheet editor for React, using one shared editor and the canonical OOXML document engine.

Live demo | npm | Full docs | Source

Install

npm install @christophervr/xlsx-react-viewer

Use the framework peers declared by this package: react (>=18). Existing framework apps normally already provide them.

The package bundles its editor UI and adapter. The core model and shared controls are installed as regular registry dependencies and the model API is re-exported. One viewer package is enough; no separate core install is required.

Quick start

import { useState } from 'react';
import { createWorkbook, SpreadsheetEditor } from '@christophervr/xlsx-react-viewer';

export function Editor() {
	const [workbook, setWorkbook] = useState(() => createWorkbook());
	return <SpreadsheetEditor workbook={workbook} onWorkbookChange={setWorkbook} />;
}

Mount in the browser and give the host a height. Use one editor package per application: each registers the same editor custom element.

Features

| Feature | Description | | ---------- | ----------------------------------------------------------------------------------- | | Editing | Shared grid, ribbon, formula bar, sheet tabs and workbook change events. | | Files | XLSX, XLSM, XLTX, legacy XLS and CSV loading through core. | | Model | createWorkbook, loadWorkbook, saveXlsx and core types from the package entry. | | Frameworks | The same <xlsx-editor> UI behind six thin adapters. |

API

Shared option types, loadWorkbook and detectWorkbookFormat helpers are exported from the package. Framework handles expose load, save and download. The vanilla package supplies mountEditor(container, options) for framework-free lifecycle management. ooxml-core and ooxml-ui are regular dependencies. Parsing, formulas, editing and grid calculations live in core.

Limitations

This is an early editor, without Microsoft Excel parity or guaranteed lossless saving for unsupported features. Legacy XLS input saves as XLSX. Pivot tables, slicers and sparklines are not editable; macros never execute. Review core diagnostics and the feature guide before relying on preservation.

Documentation

Framework guide | Bindings

License

Apache-2.0.