CreateEditorOptions

CreateEditorOptions:

{
  document?: DocAuthDocument;
  canPerformTrackedChange?: (operation: "create" | "accept" | "reject", revisionId?: string) => boolean;
  ui?: UIOptions;
}

Options for creating an editor instance.

Examples

// Create editor with empty document
const editor = await system.createEditor(targetElement);

// Create editor with existing document
const doc = await system.loadDocument(docJSON);
const editor = await system.createEditor(targetElement, { document: doc });

// Create editor with custom UI settings
const editor = await system.createEditor(targetElement, {
  ui: {
    locale: 'de',
    unit: 'cm',
    ruler: { enabled: false },
  },
});

import { defaultToolbarConfig } from '@nutrient-sdk/document-authoring';

// Create editor with custom actions and toolbar
const editor = await system.createEditor(targetElement, {
  ui: {
    actions: [
      ...defaultActions,
      {
        id: 'custom.save',
        label: 'Save',
        shortcuts: ['Mod+S'],
        handler: async () => {
          const doc = await editor.currentDocument().saveDocument();
          await fetch('/api/save', { method: 'POST', body: JSON.stringify(doc) });
        },
      },
    ],
    toolbar: {
      ...defaultToolbarConfig,
      items: [
        { type: 'built-in', id: 'undo', builtInType: 'undo' },
        { type: 'built-in', id: 'redo', builtInType: 'redo' },
        { type: 'separator', id: 'sep-1' },
        { type: 'action', id: 'save-btn', actionId: 'custom.save' },
      ],
    },
  },
});

See

• DocAuthSystem.createEditor for creating editors.
• UIOptions for available UI configuration options.

Properties

document?

optional document: DocAuthDocument

The document to attach to this editor. If no document is provided, an empty document will be created.

See

DocAuthEditor.setCurrentDocument for setting the document after the editor is created.

---

canPerformTrackedChange()?

optional canPerformTrackedChange: (operation, revisionId?) => boolean

Decides whether this editor may create, accept, or reject a tracked change.

Return false, or throw, to deny the operation. revisionId is provided for accept and reject operations. This callback applies only to editor-originated operations; document transactions remain under host control.

Parameters

operation

"create" | "accept" | "reject"

revisionId?

string

Returns

boolean

---

ui?

>= v1.5.0

optional ui: UIOptions