ooxml-ui 1.6.2 → 1.7.0

package/dist/visio/viewer-element.d.ts

@@ -3,6 +3,7 @@ import type { VsdxSource, VisioShapeSelection } from 'ooxml-core/visio/ui';
 import { ViewerController } from './controller.js';
 import { type BackstagePage } from './backstage.js';
 import type { CreateVsdxOptions } from 'ooxml-core/visio';
+import { type StatusBarTheme } from './viewer-options.js';
 import { type SvgExportOptions, type SvgExportResult } from './export-svg.js';
 import { type CurrentPagePrintSnapshotOptions, type PrintSnapshot } from './print-snapshot.js';
 declare const BaseElement: typeof HTMLElement;
@@ -16,6 +17,13 @@ export declare class VisioViewerElement extends BaseElement {
     set pageIndex(value: number);
     get zoom(): number;
     set zoom(value: number);
+    /**
+     * The status bar's look: `'neutral'` (the suite's bar, the default) or `'colorful'` (Visio's
+     * product colour). Reflects the `status-bar` attribute; `--vv-status-background` and
+     * `--vv-status-ink` recolour either.
+     */
+    get statusBar(): StatusBarTheme;
+    set statusBar(value: StatusBarTheme);
     get showToolbar(): boolean;
     set showToolbar(value: boolean);
     get renderWarnings(): readonly string[];

package/dist/visio/viewer-guides.d.ts

@@ -19,8 +19,11 @@ export declare class ViewerGuides {
     get shown(): boolean;
     toggleGuides(): void;
     toggleDynamicGrid(): void;
-    /** Snap a shape drag; draws alignment hints. Unchanged when no snapping is active. */
-    snap(page: VisioPage, ids: readonly string[], delta: VisioPagePoint): VisioPagePoint;
+    /**
+     * Snap a shape drag; draws alignment hints. `grid` is the Snap to Grid step in page inches (0
+     * while the grid is hidden). Unchanged when no snapping is active.
+     */
+    snap(page: VisioPage, ids: readonly string[], delta: VisioPagePoint, grid?: number): VisioPagePoint;
     clearHints(): void;
     wire(): () => void;
     render(state: ViewerState): void;

package/dist/visio/viewer-inline-text.d.ts

@@ -0,0 +1,31 @@
+import type { ViewerController, ViewerState } from './controller.js';
+/**
+ * Visio's in-place text editing: double-click a shape, press F2 or start typing with one shape
+ * selected, and its text becomes editable where it is drawn. Esc, clicking elsewhere on the canvas
+ * or selecting something else saves the change as one undoable edit (as in Visio, Esc keeps what
+ * you typed); Enter starts a new line. Ribbon commands leave the editor open, and the draft
+ * survives other edits to the same drawing. The editor is a plain textarea (`#edit-text`), so
+ * Insert Symbol, Field and Spelling work on it.
+ */
+export declare class ViewerInlineText {
+    #private;
+    private readonly viewport;
+    private readonly controller;
+    private readonly announce;
+    readonly input: HTMLTextAreaElement;
+    constructor(viewport: HTMLElement, controller: ViewerController, announce: (message: string) => void);
+    get editing(): boolean;
+    wire(): () => void;
+    /**
+     * Start editing the one selected shape's text. `typed` replaces the text with a typed character,
+     * as typing on a selected shape does in Visio. False when the selection has no editable text.
+     */
+    start(typed?: string): boolean;
+    /** Save the draft as one edit; `focusCanvas` returns keyboard focus to the drawing. */
+    commit(focusCanvas: boolean): Promise<void>;
+    /**
+     * Selecting something else or changing page saves; another edit to the same drawing (formatting,
+     * a move, undo) keeps the draft on the redrawn shape; a different file discards it.
+     */
+    render(state: ViewerState): void;
+}

package/dist/visio/viewer-input.d.ts

@@ -5,6 +5,10 @@ interface Controls {
         value: number;
     };
 }
+/** Page inches an arrow key nudges the selection: the editor's 1/16-inch drawing snap. */
+export declare const NUDGE_STEP: number;
 /** Own every DOM listener and abort them together when the surface is disposed. */
-export declare function wireViewerInputs(controls: Controls, controller: ViewerController, fit: (mode: 'page' | 'width') => void): () => void;
+export declare function wireViewerInputs(controls: Controls, controller: ViewerController, fit: (mode: 'page' | 'width') => void, announce?: (message: string) => void, 
+/** Typing a character with one shape selected starts editing its text; true when it did. */
+typeText?: (character: string) => boolean): () => void;
 export {};

package/dist/visio/viewer-layer-properties.d.ts

@@ -0,0 +1,18 @@
+import type { ViewerController, ViewerState } from './controller.js';
+import { ViewerDialog } from './viewer-dialog.js';
+/**
+ * Home > Editing > Layers > Layer Properties, as Visio's dialog: one row per layer of the page
+ * (and of its background pages) with its shape count, Visible, Print and Lock boxes and colour.
+ * OK saves the changed flags as one `set-layer-properties` edit. A read-only drawing can still
+ * show or hide layers here, for this view only.
+ */
+export declare class ViewerLayerProperties {
+    #private;
+    private readonly root;
+    private readonly controller;
+    private readonly announce;
+    readonly dialog: ViewerDialog;
+    constructor(root: ShadowRoot, controller: ViewerController, announce: (message: string) => void);
+    open(): void;
+    render(state: ViewerState): void;
+}

package/dist/visio/viewer-layout-commands.d.ts

@@ -3,6 +3,7 @@ import type { VisioLayoutAction } from './ribbon-action.js';
 import { ViewerExplorer } from './viewer-explorer.js';
 import { ViewerGuides } from './viewer-guides.js';
 import { ViewerLayerAssign } from './viewer-layer-assign.js';
+import { ViewerLayerProperties } from './viewer-layer-properties.js';
 import { ViewerLayout } from './viewer-layout.js';
 import { ViewerPasteSpecial } from './viewer-paste-special.js';
 import { ViewerSelectType } from './viewer-select-type.js';
@@ -22,13 +23,14 @@ export interface LayoutCommandHost {
 }
 /**
  * Arrangement, layout, layers, selection, view aids and help commands: Auto Align & Space,
- * Re-Layout Page and its Layout dialog, Assign to Layer, Select by Type, Paste Special, Guides,
+ * Re-Layout Page and its Layout dialog, Assign to Layer, Layer Properties, Select by Type, Paste Special, Guides,
  * Dynamic Grid, Drawing Explorer, Help and Show Training.
  */
 export declare class ViewerLayoutCommands {
     private readonly host;
     readonly layout: ViewerLayout;
     readonly layers: ViewerLayerAssign;
+    readonly layerProperties: ViewerLayerProperties;
     readonly select: ViewerSelectType;
     readonly paste: ViewerPasteSpecial;
     readonly guides: ViewerGuides;

package/dist/visio/viewer-options.d.ts

@@ -1,10 +1,17 @@
 import { type OfficeOptionCategory, type OfficeProfile } from '../controls.js';
 /**
- * Visio's File > Options categories, in Visio's order. Only User name and Initials are honoured
- * today (they are the local profile, also used as the identity in a shared session); every other
- * setting is shown disabled with the capability it is waiting for.
+ * Visio's File > Options categories, in Visio's order. User name and Initials (the local profile,
+ * also the identity in a shared session) and Office Theme (the status bar's look) are honoured;
+ * every other setting is shown disabled with the capability it is waiting for.
  */
 export declare const VISIO_OPTION_CATEGORIES: readonly OfficeOptionCategory[];
+/** The status bar's look: Visio's product colour ("Colorful") or the neutral suite bar. */
+export type StatusBarTheme = 'colorful' | 'neutral';
+export declare const isStatusBarTheme: (value: unknown) => value is StatusBarTheme;
+/** The Office Theme remembered on this device, if any (storage may be unavailable). */
+export declare function readStatusBarTheme(): StatusBarTheme | undefined;
+/** Office Theme as Options offers it: the two light looks, or the dark theme. */
+export type OfficeThemeChoice = StatusBarTheme | 'dark';
 /** The Options dialog element. Built once and appended to the viewer's shadow root. */
 export declare function createOptionsDialog(doc: Document): HTMLElement;
 /**
@@ -14,7 +21,14 @@ export declare function createOptionsDialog(doc: Document): HTMLElement;
 export declare class ViewerProfile {
     #private;
     private readonly onProfile;
-    constructor(root: ShadowRoot, onProfile?: (profile: OfficeProfile) => void);
+    /** Reads and applies the Office Theme on the viewer element. */
+    private readonly theme;
+    constructor(root: ShadowRoot, onProfile?: (profile: OfficeProfile) => void, 
+    /** Reads and applies the Office Theme on the viewer element. */
+    theme?: {
+        get(): OfficeThemeChoice;
+        set(theme: OfficeThemeChoice): void;
+    });
     get profile(): OfficeProfile;
     /** Open Visio Options, on General as Visio does. */
     showOptions(category?: string): void;