@univerjs/docs-toc provides table-of-contents insertion, update, deletion, and FIELD-range lookup for Univer Docs.

pnpm add @univerjs/docs-toc
# or
npm install @univerjs/docs-toc

Start with the integration setup for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.

import { UniverDocsTocPlugin } from '@univerjs/docs-toc';

univer.registerPlugin(UniverDocsTocPlugin);

Use this package with @univerjs/docs-toc-ui when users need Ribbon, context-menu, dialog, and active-range feedback.

The updater currently evaluates outline-based TOC instructions (\\o). Other Word TOC switches are retained in FIELD metadata but are not all evaluated.

• Documentation
• NPM package
• GitHub repository