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.

The SuperDoc instance is your main interface for controlling the DOCX editor. It handles document loading, editor management, and all interactions.

ā€‹
Creating an instance

import { SuperDoc } from 'superdoc';

const superdoc = new SuperDoc({
  selector: '#editor',
  document: 'contract.docx'
});

ā€‹
Instance lifecycle

// 1. Creation
const superdoc = new SuperDoc(config);

// 2. Ready event
superdoc.on('ready', () => {
  // Now safe to use methods
});

// 3. Runtime operations
superdoc.setDocumentMode('suggesting');
superdoc.export();

// 4. Cleanup
superdoc.destroy();

ā€‹
API structure

  • Configuration - Settings passed at creation
  • Methods - Control the editor, access properties and types
  • Events - Lifecycle and change notifications