Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.superdoc.dev/llms.txt

Use this file to discover all available pages before exploring further.

SuperDoc ships ready-made UI for the toolbar, comments panel, tracked-change review, and a few other surfaces. Configure it through the modules option: enable only what you need, swap any piece for your own component when you want to. For new React apps that want full control over the UI, Custom UI is the recommended path. Built-in UI stays supported for apps that prefer SuperDoc’s components as-is. 
const superdoc = new SuperDoc({
  selector: '#editor',
  document: 'contract.docx',
  modules: {
    toolbar: { selector: '#toolbar' },
    comments: { allowResolve: true },
    collaboration: { ydoc, provider },
    contextMenu: { includeDefaultItems: true },
    links: { popoverResolver: (ctx) => ({ type: 'default' }) }
  }
});

​
Available built-in UI

Comments

Threaded discussions and annotations

Track Changes

Word-style revision tracking with accept/reject

Toolbar

Customizable formatting controls

Links

Customize the link click popover or bring your own UI

Context Menu

Right-click actions and custom commands
Each surface is configured via modules.<name> in the SuperDoc configuration. See individual pages for all available options.

Custom UI

Build your own toolbar, comments sidebar, and review panel with typed React hooks

Collaboration

Real-time multi-user editing with Yjs (separate top-level section)

Spell check

Provider-based spell check on the layout-engine editor surface