ooxml-ui 0.27.2 → 0.28.0

package/dist/docx/table-properties.d.ts

@@ -0,0 +1,28 @@
+import type { Table, TableCell, TableCellMargins } from 'ooxml-core/docx';
+import type { EditorState } from 'prosemirror-state';
+import type { EditorView } from 'prosemirror-view';
+export type TableRowProperties = NonNullable<Table['rowProperties']>[number];
+export type RowPatch = {
+    [K in keyof TableRowProperties]?: TableRowProperties[K] | undefined;
+};
+/** Only rectangular tables currently expose formatting controls. */
+export declare function tablePropertiesContext(state: EditorState): {
+    pos: number;
+    table: import("prosemirror-model").Node;
+    rows: {
+        pos: number;
+        properties: TableRowProperties;
+    }[];
+    cells: {
+        pos: number;
+        margins: TableCellMargins;
+        verticalAlign: TableCell['verticalAlign'];
+    }[];
+    margins: TableCellMargins;
+} | null;
+/** Patches only fields changed in the dialog; all edits form one history step. */
+export declare function applyTableProperties(view: EditorView, rowPatch: RowPatch, marginPatch: TableCellMargins, 
+/** Null removes all direct cell overrides; omitted leaves them untouched. */
+cellMarginPatch?: TableCellMargins | null, 
+/** Null removes the direct alignment override; omitted leaves it untouched. */
+cellAlignment?: TableCell['verticalAlign'] | null): boolean;

package/dist/docx/table-shading.d.ts

@@ -0,0 +1,6 @@
+import type { EditorState, Transaction } from 'prosemirror-state';
+import type { TableBorderContext } from './table-border-commands';
+/** Undefined means mixed fills; null means no visible fill. */
+export declare function readCellFill(ctx: TableBorderContext, state: EditorState, scope: 'cell' | 'table'): string | null | undefined;
+/** Adds shading to the border transaction, so applying the dialog is one undo step. */
+export declare function applyCellFill(tr: Transaction, ctx: TableBorderContext, scope: 'cell' | 'table', fill: string | null): void;

package/dist/docx/test-support.d.ts

@@ -0,0 +1,24 @@
+import type { Block, Paragraph, Table } from 'ooxml-core/docx';
+/** The element at `index`, failing the test with a clear message when the list is too short. */
+export declare function at<T>(list: ArrayLike<T>, index: number): T;
+/** Asserts a value is present (not undefined/null) and returns it with a narrowed type. */
+export declare function must<T>(value: T | null | undefined, what?: string): T;
+/** The paragraph block at `index`, failing the test when it is missing or is a table. */
+export declare function paragraphAt(blocks: readonly Block[], index: number): Paragraph;
+/** The table block at `index`, failing the test when it is missing or is a paragraph. */
+export declare function tableAt(blocks: readonly Block[], index: number): Table;
+/**
+ * A button of the title bar's Quick Access strip ("Save", "Undo", "Redo"). The strip is drawn by
+ * the shared `office-ui-title-bar`, inside its own shadow root, once that element has rendered.
+ */
+export declare function quickAccessButton(editor: {
+    shadowRoot: ShadowRoot | null;
+}, label: string): Promise<HTMLButtonElement>;
+/** The shadow root of the shared ribbon in `scope`, after it has rendered its tabs. */
+export declare function ribbonShadow(scope: ParentNode): Promise<ShadowRoot>;
+/** The rendered button of ribbon tab `key` ("home", "insert", "table"...). */
+export declare function ribbonTab(scope: ParentNode, key: string): Promise<HTMLButtonElement>;
+/** The tab buttons, in order. */
+export declare function ribbonTabs(scope: ParentNode): Promise<HTMLButtonElement[]>;
+/** The File button of the shared ribbon. */
+export declare function ribbonFile(scope: ParentNode): Promise<HTMLButtonElement>;

package/dist/docx/text-box-commands.d.ts

@@ -0,0 +1,17 @@
+import { type EditorState } from 'prosemirror-state';
+import type { EditorView } from 'prosemirror-view';
+export interface TextBoxSettings {
+    lines: string[];
+    widthPx: number;
+    heightPx: number;
+    border: boolean;
+}
+/** The selected text box when it is the simple, editable form (inserted here or written the same way). */
+export declare function selectedTextBox(state: EditorState): {
+    pos: number;
+    settings: TextBoxSettings;
+} | null;
+/** Insert > Text Box: an inline text box at the selection, as one undo step. */
+export declare function insertTextBox(view: EditorView, settings: TextBoxSettings): boolean;
+/** Applies new text, size and outline to the selected text box, as one undo step. */
+export declare function updateTextBox(view: EditorView, pos: number, settings: TextBoxSettings): boolean;

package/dist/docx/text-box-dialog.d.ts

@@ -0,0 +1,4 @@
+import type { EditorView } from 'prosemirror-view';
+import type { FormatDialog } from './font-dialog';
+/** Insert > Text Box: inserts an inline box at the selection, or edits the selected simple box. */
+export declare function createTextBoxDialog(getView: () => EditorView | undefined): FormatDialog;

package/dist/docx/title-bar.d.ts

@@ -0,0 +1,25 @@
+import type { FileCommand } from './file-commands';
+export type SaveState = 'saved' | 'dirty' | 'saving' | 'saved-local';
+export interface TitleBarHandlers {
+    fileCommand(command: FileCommand): void;
+    history(key: 'undo' | 'redo'): void;
+    toggleComments(): void;
+    setReadOnly(readOnly: boolean): void;
+    /** The ribbon root, searched by the "Tell me" box for runnable commands. */
+    ribbon(): HTMLElement | undefined;
+}
+export interface TitleBar {
+    element: HTMLElement;
+    setFileName(name: string): void;
+    setSaveState(state: SaveState): void;
+    setReadOnly(readOnly: boolean): void;
+    setCommentsOpen(open: boolean): void;
+    /** Redraws every label after the editor locale changed. */
+    relocalize(): void;
+}
+/**
+ * Word-style title bar: quick access toolbar, document name/state and "Tell me". The shared
+ * `office-ui-title-bar` draws it from translated state; the comments toggle and view mode stay
+ * docx controls placed in its `account` slot.
+ */
+export declare function createTitleBar(handlers: TitleBarHandlers): TitleBar;

package/dist/docx/toc-commands.d.ts

@@ -0,0 +1,17 @@
+import { type DocumentModel } from 'ooxml-core/docx';
+import { type TextMeasurer } from 'ooxml-core/docx/layout';
+import type { EditorView } from 'prosemirror-view';
+/** Word page number text of the page where each top-level block starts, from Print Layout pagination. */
+export declare function blockPageNumbers(model: DocumentModel, measurer?: TextMeasurer): Map<string, string>;
+/** Inserts a TOC before the block holding the caret, replacing it when it is an empty paragraph. */
+export declare function insertTableOfContents(view: EditorView, model: DocumentModel, measurer?: TextMeasurer, levels?: number, captionLabel?: string): void;
+/**
+ * Rebuilds the document's TOC with current headings and page numbers (or, with `captionLabel`,
+ * its table of figures from the current captions); false when there is none.
+ */
+export declare function updateTableOfContents(view: EditorView, model: DocumentModel, measurer?: TextMeasurer, captionLabel?: string): boolean;
+/**
+ * Removes the document's table of contents (Word's Remove Table of Contents). Text that shared a
+ * paragraph with the field is kept. Returns false when there is no TOC to remove.
+ */
+export declare function removeTableOfContents(view: EditorView, model: DocumentModel, captionLabel?: string): boolean;

package/dist/docx/toggle-commands.d.ts

@@ -0,0 +1,8 @@
+import type { Command } from 'prosemirror-state';
+export type ToggleKey = 'bold' | 'italic' | 'underline' | 'strike';
+/**
+ * Word's Bold/Italic/Underline/Strikethrough: toggles what the text shows, including formatting
+ * inherited from its styles. Turning off text that is on only through a style (a bold heading)
+ * writes an explicit off, as Word does; turning it on clears that off again.
+ */
+export declare function toggleFormat(key: ToggleKey): Command;

package/dist/docx/track-changes-mode.d.ts

@@ -0,0 +1,20 @@
+import { Plugin, PluginKey } from 'prosemirror-state';
+/** Text removed by the latest tracked cut, so pasting it back records a move. */
+interface TrackState {
+    lastCut?: {
+        text: string;
+        deletionIds: string[];
+    };
+}
+export declare const trackChangesPluginKey: PluginKey<TrackState>;
+/** Transactions carrying this meta (remote collaboration steps) are never re-tracked. */
+export declare const REMOTE_TRANSACTION_META = "dve-remote";
+/**
+ * When enabled, rewrites local editing transactions so insertions/deletions become tracked-change
+ * marks (see applyTrackedReplace) instead of directly changing the visible text. Handles the common
+ * case of a transaction made of `ReplaceStep`s only (typing, IME, backspace/delete, cut, paste);
+ * anything else (structural table edits, attribute changes, remote collaboration steps) passes
+ * through untouched.
+ */
+export declare function trackChangesPlugin(getAuthor: () => string, isEnabled: () => boolean): Plugin;
+export {};

package/dist/docx/view-options.d.ts

@@ -0,0 +1,10 @@
+import type { EditorCore } from './editor-core';
+import type { RibbonActionId } from 'ooxml-core/docx/ui';
+/** Host-controlled UI customisation; each value maps to one element property and attribute. */
+export declare class ViewOptions {
+    showThumbnails: boolean;
+    showToolbar: boolean;
+    hiddenActions: readonly RibbonActionId[];
+}
+/** Pushes the current options into the built shell; a no-op until the element connects. */
+export declare function applyViewOptions(core: EditorCore): void;

package/dist/docx/watermark-commands.d.ts

@@ -0,0 +1,9 @@
+import type { DocumentModel, WatermarkSpec } from 'ooxml-core/docx';
+/** The first watermark in any header, or undefined. */
+export declare function currentWatermark(model: DocumentModel): WatermarkSpec | undefined;
+/**
+ * Layout > Watermark: sets (or, with undefined, removes) the text watermark in the document's
+ * headers. The first section gets a default header if it has none; every other header story the
+ * document already has is updated too, and a part shared by several sections changes once for all.
+ */
+export declare function withWatermark(model: DocumentModel, spec: WatermarkSpec | undefined, newId: () => string): DocumentModel;

package/dist/docx/watermark-dialog.d.ts

@@ -0,0 +1,11 @@
+import type { WatermarkSpec } from 'ooxml-core/docx';
+import type { FormatDialog } from './font-dialog';
+export interface WatermarkHost {
+    current(): WatermarkSpec | undefined;
+    canEdit(): boolean;
+    /** Sets the watermark in every header; undefined removes it. */
+    apply(spec: WatermarkSpec | undefined): void;
+    restoreFocus(): void;
+}
+/** Word's Printed Watermark for text: the words, font, colour, layout and transparency. */
+export declare function createWatermarkDialog(host: WatermarkHost): FormatDialog;

package/dist/docx/word-count-panel.d.ts

@@ -0,0 +1,12 @@
+import type { EditorView } from 'prosemirror-view';
+import { type EditorLocale } from './localization';
+export interface DocumentCounts {
+    words: number;
+    charactersWithSpaces: number;
+    charactersWithoutSpaces: number;
+    paragraphs: number;
+}
+/** Counts the selection when there is one, else the whole document, as Word's Word Count does. */
+export declare function documentCounts(view: EditorView, language?: string): DocumentCounts;
+/** Shows the counts in a small dismissible panel under `anchor`. */
+export declare function showWordCount(anchor: HTMLElement, view: EditorView, locale?: EditorLocale, language?: string): void;

package/dist/docx/zoom-dialog.d.ts

@@ -0,0 +1,16 @@
+import type { FormatDialog } from './font-dialog';
+import type { ZoomFit } from 'ooxml-core/docx/ui';
+export interface ZoomHost {
+    /** The current zoom, in percent. */
+    percent(): number;
+    setPercent(percent: number): void;
+    fit(mode: ZoomFit): void;
+    restoreFocus(): void;
+}
+/** The zoom the field holds, clamped to the 10 to 500 percent Word allows; null when it is not a number. */
+export declare function parseZoomPercent(text: string): number | null;
+/**
+ * Word's Zoom dialog: 200%, 100%, 75%, page width, whole page or a percentage, with a preview of
+ * the text at that size. Text width, Wrap to window and page counts beyond two are not offered.
+ */
+export declare function createZoomDialog(host: ZoomHost): FormatDialog;