@eigenpal/docx-editor-core/prosemirror/extensions

clearTrackedChangesfunctionSource ↗

Create a transaction that clears the change tracker

declare function clearTrackedChanges(state: EditorState): Transaction;

createExtensionfunctionSource ↗

Create a generic extension (plugins, commands, keymaps — no schema contribution)

declare function createExtension<TOptions extends Record<string, unknown> = Record<string, unknown>>(def: ExtensionDefinition<TOptions>): (options?: Partial<TOptions>) => Extension;

createMarkExtensionfunctionSource ↗

Create a mark extension (contributes a MarkSpec to the schema)

declare function createMarkExtension<TOptions extends Record<string, unknown> = Record<string, unknown>>(def: MarkExtensionDefinition<TOptions>): (options?: Partial<TOptions>) => MarkExtension;

createNodeExtensionfunctionSource ↗

Create a node extension (contributes a NodeSpec to the schema)

declare function createNodeExtension<TOptions extends Record<string, unknown> = Record<string, unknown>>(def: NodeExtensionDefinition<TOptions>): (options?: Partial<TOptions>) => NodeExtension;

createStarterKitfunctionSource ↗

Create the full set of extensions for the DOCX editor

declare function createStarterKit(options?: StarterKitOptions): AnyExtension[];

getChangedParagraphIdsfunctionSource ↗

Get the set of changed paragraph IDs from an EditorState

declare function getChangedParagraphIds(state: EditorState): Set<string>;

hasStructuralChangesfunctionSource ↗

Check if structural changes (paragraph add/delete) occurred

declare function hasStructuralChanges(state: EditorState): boolean;

hasUntrackedChangesfunctionSource ↗

Check if any changes affected paragraphs without paraId

declare function hasUntrackedChanges(state: EditorState): boolean;

ParagraphChangeTrackerExtensionfunctionSource ↗

ParagraphChangeTrackerExtension: (options?: Partial<{}> | undefined) => Extension

TableCellExtensionfunctionSource ↗

TableCellExtension: (options?: Partial<Record<string, unknown>> | undefined) => NodeExtension

TableHeaderExtensionfunctionSource ↗

TableHeaderExtension: (options?: Partial<Record<string, unknown>> | undefined) => NodeExtension

TableNodeExtensionfunctionSource ↗

TableNodeExtension: (options?: Partial<Record<string, unknown>> | undefined) => NodeExtension

TableRowExtensionfunctionSource ↗

TableRowExtension: (options?: Partial<Record<string, unknown>> | undefined) => NodeExtension

ExtensionManagerclassSource ↗

Extension Manager

Two-phase initialization: 1. buildSchema() — collects NodeSpecs/MarkSpecs from extensions → new Schema 2. initializeRuntime() — calls onSchemaReady() on each extension, collects plugins/commands/keymaps

declare class ExtensionManager

ExtensioninterfaceSource ↗

interface Extension

ExtensionConfiginterfaceSource ↗

interface ExtensionConfig

ExtensionContextinterfaceSource ↗

interface ExtensionContext

ExtensionDefinitioninterfaceSource ↗

interface ExtensionDefinition<TOptions = Record<string, unknown>>

ExtensionRuntimeinterfaceSource ↗

interface ExtensionRuntime

MarkExtensioninterfaceSource ↗

interface MarkExtension

MarkExtensionConfiginterfaceSource ↗

interface MarkExtensionConfig extends ExtensionConfig

MarkExtensionDefinitioninterfaceSource ↗

interface MarkExtensionDefinition<TOptions = Record<string, unknown>>

NodeExtensioninterfaceSource ↗

interface NodeExtension

NodeExtensionConfiginterfaceSource ↗

interface NodeExtensionConfig extends ExtensionConfig

NodeExtensionDefinitioninterfaceSource ↗

interface NodeExtensionDefinition<TOptions = Record<string, unknown>>

StarterKitOptionsinterfaceSource ↗

StarterKit — bundles all extensions into a ready-to-use set

Usage: const extensions = createStarterKit(); const manager = new ExtensionManager(extensions); manager.buildSchema(); manager.initializeRuntime();

interface StarterKitOptions

TableContextInfointerfaceSource ↗

Table selection context + navigation helpers.

getTableContext walks the selection up from $from and reports which table / row / cell the cursor is in, plus the table's row/column counts, whether a multi-cell selection is active, and the current cell's border + fill colors (so the toolbar's color pickers can show the live values).

goToNextCell / goToPrevCell are tab-stop-style cell navigation commands registered by the plugin extension.

interface TableContextInfo

AnyExtensiontypeSource ↗

type AnyExtension = Extension | NodeExtension | MarkExtension;

CommandMaptypeSource ↗

type CommandMap = Record<string, (...args: any[]) => Command>;

ExtensionPrioritytypeSource ↗

Extension System Type Definitions

Tiptap-style extension architecture for ProseMirror. Three extension types: - Extension: plugins, commands, keymaps (no schema) - NodeExtension: adds a node spec to the schema - MarkExtension: adds a mark spec to the schema

type ExtensionPriority = number;

KeyboardShortcutMaptypeSource ↗

type KeyboardShortcutMap = Record<string, Command>;

PriorityconstSource ↗

Priority: {
    readonly Highest: 0;
    readonly High: 50;
    readonly Default: 100;
    readonly Low: 150;
    readonly Lowest: 200;
}