# Ruled

> Edit real Excel workbooks in the browser, check every cell against a schema with your own async rules, and save .xlsx back intact.

Ruled (`@ruled/sheet`) is a spreadsheet editor for web apps: a React component and a `<workbook-editor>` element. Schemas describe the workbooks an app expects, with sync and async hooks for checks and business logic. Each link is a page as Markdown; llms-full.txt has them all.

## Start here

- [Introduction](https://ruled.page/start/introduction.md): What Ruled is, what it's for, and how it fits into your app.
- [What it can do](https://ruled.page/start/capabilities.md): Every part of an Excel workbook and what the editor does with it, and what it gives your app, in one searchable table.
- [Install](https://ruled.page/start/install.md): Add the package to your app, and choose the React build or the self-contained one.
- [React](https://ruled.page/start/react.md): Show the editor in a React app with useWorkbookEditor, open a workbook and receive it when it's saved.
- [Web component and plain HTML](https://ruled.page/start/web-component.md): Use the <workbook-editor> element on any page, or mount the editor into an element you choose.
- [Angular](https://ruled.page/start/angular.md): Use the editor's element in an Angular app, loaded only when it's needed.

## Schemas and validation

- [Schemas](https://ruled.page/schemas/overview.md): Describe the workbooks you expect, and the editor checks every cell against the description as people type.
- [Fields and checks](https://ruled.page/schemas/fields.md): Each field's type, limits, patterns and checks, and how its values reach your code.
- [Tables, cells and sheets](https://ruled.page/schemas/tables.md): Where a schema's data sits, how tables grow, rules across records, and settings for the whole workbook.
- [Async checks](https://ruled.page/schemas/async-hooks.md): Checks in code that can call your own services, at every level of the workbook, with cancellation, timeouts and save-time guarantees.
- [Business logic](https://ruled.page/schemas/business-logic.md): Code that runs after each edit and fills cells in from your systems, and a last check before a workbook is saved.
- [JSON and the designer](https://ruled.page/schemas/json-and-designer.md): Schemas as plain data, generated from a workbook and edited in the editor's own designer, with your hooks kept in code.

## Guides

- [Opening and saving](https://ruled.page/guides/opening-and-saving.md): Give the editor a workbook, receive it back with its values and changes, and handle conflicts, drafts and CSV.
- [Options and features](https://ruled.page/guides/options-and-features.md): Every option the editor takes, and the parts of its interface you can turn off.
- [Theming](https://ruled.page/guides/theming.md): Restyle the editor with design tokens, from your brand colour to every grid line.
- [Languages](https://ruled.page/guides/languages.md): The editor in English, German or a language you add, with dates and numbers in the user's locale.
- [Events and the handle](https://ruled.page/guides/events-and-handle.md): Control the editor from your app, follow what it does, and hear about errors.
- [Excel fidelity](https://ruled.page/guides/excel-fidelity.md): What the editor shows and edits, what it keeps without showing, and how a saved file compares with the one opened.
- [Keyboard and accessibility](https://ruled.page/guides/keyboard-and-accessibility.md): Excel's keys, the shortcuts, screen reader support, touch, and the browser shortcuts the editor leaves alone.
- [CSV files](https://ruled.page/guides/csv-files.md): How CSV, TSV and text files open as workbooks, how sheets are written as CSV, and how formula injection is prevented both ways.

## Live examples

- [Price list: async checks and lookups](https://ruled.page/examples/price-list.md): A supplier's price list checked against a product catalogue as it's typed, with new products filled in from it.
- [Budget: a fixed grid](https://ruled.page/examples/budget.md): A half-year budget whose categories and months are fixed by the schema, with a cap in code and an async check against a budget service.
- [Forecast: records across columns](https://ruled.page/examples/forecast.md): A quarterly forecast with one record per column, and a rule that quarters follow on from each other.
- [Saving to your app](https://ruled.page/examples/saving.md): What your app receives when a workbook is saved, live.
- [Formulas, charts and pivot tables](https://ruled.page/examples/workbooks.md): Real workbooks with no schema at all: live formulas, charts and pivot tables.
- [Theming](https://ruled.page/examples/theming.md): The same workbook in several themes, set through the editor's design tokens.

## AI and agents


## Reference

- [Formula functions](https://ruled.page/reference/functions.md): Every Excel worksheet function the editor's engine calculates live, with its arguments, and the ones whose results it keeps from Excel.

## Optional

- [API reference](https://ruled.page/reference/api/readme.md): every export of @ruled/sheet, its types and their members