@eigenpal/docx-editor-vue

provideLocalefunctionSource ↗

Provide locale strings to descendant components. Call in a parent's setup():

provideLocale(myTranslations);

export declare function provideLocale(i18n?: MaybeRef<Translations | undefined>): void;

renderAsyncfunctionSource ↗

Render a DOCX editor into a container element using Vue.

export declare function renderAsync(input: DocxInput, container: HTMLElement, options?: RenderAsyncOptions): Promise<DocxEditorHandle>;

useTranslationfunctionSource ↗

useTranslation composable — returns t(key, vars?). Inject-based, so a provideLocale(...) call must sit above it in the component tree.

export declare function useTranslation(): {
    t: TFunction;
};

DocxEditorHandleinterfaceSource ↗

Imperative handle returned by Vue renderAsync().

export interface DocxEditorHandle extends EditorHandle

DocxEditorPropsinterfaceSource ↗

Public props for the Vue editor component.

export interface DocxEditorProps

DocxEditorReftypeSource ↗

Public ref shape for <DocxEditor>. Exposes the full editor-scope EditorRefLike contract so the agent bridge can attach to either React or Vue without an adapter shim.

export type DocxEditorRef = EditorRefLike & {
    getAgent(): null;
    save(): Promise<ArrayBuffer | null>;
    setZoom(zoom: number): void;
    getZoom(): number;
    focus(): void;
    scrollToParaId(paraId: string, options?: ScrollToParaIdOptions): boolean;
    scrollToPage(pageNumber: number): void;
    scrollToPosition(pmPos: number): void;
    scrollToCommentId(commentId: number): boolean;
    scrollToChangeId(revisionId: number): boolean;
    highlightRange(from: number, to: number): void;
    openPrintPreview(): void;
    print(): void;
    loadDocument(doc: Document): void;
    loadDocumentBuffer(buffer: DocxInput): Promise<void>;
    destroy(): void;
    getContentControls(filter?: ContentControlFilter): PMContentControl[];
    scrollToContentControl(filter: ContentControlFilter): boolean;
    setContentControlContent(filter: ContentControlFilter, text: string, options?: {
        force?: boolean;
    }): boolean;
    removeContentControl(filter: ContentControlFilter, options?: {
        force?: boolean;
        keepContent?: boolean;
    }): boolean;
    setContentControlValue(filter: ContentControlFilter, value: ContentControlValue, options?: {
        force?: boolean;
    }): boolean;
};

EditorModetypeSource ↗

export type EditorMode = 'editing' | 'suggesting' | 'viewing';

RenderAsyncOptionstypeSource ↗

Options for renderAsync.

export type RenderAsyncOptions = Omit<DocxEditorProps, 'documentBuffer' | 'document'> & {
    onReady?: () => void;
    onError?: (error: Error) => void;
    onChange?: (document: Document) => void;
    onRename?: (name: string) => void;
    onMenuAction?: (action: string) => void;
    onModeChange?: (mode: EditorMode) => void;
};

i18nPluginconstSource ↗

Vue plugin for i18n. Install via app.use(i18nPlugin, translations).

i18nPlugin: {
    install(app: App, i18n?: Translations): void;
}

VERSIONconstSource ↗

eigenpal/docx-editor-vue

Curated root entry for the documented Vue 3 editor API. Advanced surfaces stay public through explicit subpaths: - @eigenpal/docx-editor-vue/ui - @eigenpal/docx-editor-vue/dialogs - @eigenpal/docx-editor-vue/composables - @eigenpal/docx-editor-vue/plugin-api

Framework-agnostic document utilities live in @eigenpal/docx-editor-core. Agent/MCP surfaces live in @eigenpal/docx-editor-agents.

VERSION = "0.0.2"