# RichDocument

Source: /tuil/docs/reference/packages/editor/api/rich-document
Locale: en

interface exported by @mwillbanks/tuil-editor.



{/* Generated by tooling/docs/generate-reference.ts. */}

## interface [#interface]

Public interface exported by `@mwillbanks/tuil-editor`.

```ts
export interface RichDocument {
  readonly version: number;
  readonly root: RichNode;
}
```

## Members [#members]

| Member    | Type       | Required | Description                                      | Related types                                               |
| --------- | ---------- | -------- | ------------------------------------------------ | ----------------------------------------------------------- |
| `version` | `number`   | Yes      | The `version` member uses the `number` contract. | —                                                           |
| `root`    | `RichNode` | Yes      | The `root` member uses the `RichNode` contract.  | [`RichNode`](/tuil/docs/reference/packages/editor/api/rich-node) |

## Parameters [#parameters]

This declaration has no public members.

## Returns [#returns]

This declaration does not return a value.

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

* [`RichNode`](/tuil/docs/reference/packages/editor/api/rich-node)

## Source [#source]

[View the secondary source reference](https://github.com/mwillbanks/tuil/blob/main/packages/editor/src/rich.ts)

## Package [#package]

[@mwillbanks/tuil-editor](/tuil/docs/reference/packages/editor)
