@aseity/idocs-preview 0.3.0 → 0.5.0

package/dist/view/editor.d.ts

@@ -0,0 +1,78 @@
+import type { Anchor, BlockStyle, Commit, EditorSession, ImageAlign, InsertBlock, Mark, PreviewDocument, Rect, Selection, TableAction, TextAlign } from '../core/index.js';
+import { type ReadOnlyTarget } from './edit-selection.js';
+import { type FindBar } from './find-bar.js';
+export interface SelectedImageTarget {
+    readonly page: number;
+    readonly path: string;
+    readonly box: Rect;
+}
+export interface EditorViewOptions {
+    zoom?: number;
+    readOnly?: boolean;
+    bottomInset?: number;
+    onPageChange?: (index: number, doc: PreviewDocument) => void;
+    onZoomChange?: (zoom: number) => void;
+    onSelectionChange?: (selection: EditorViewSelection | null) => void;
+    onReadOnlyTarget?: (target: ReadOnlyTarget | null) => void;
+    onImageSelect?: (target: SelectedImageTarget | null) => void;
+    maxCanvasPixels?: number;
+}
+export interface EditorViewSelection {
+    readonly selection: Selection;
+    readonly text: string;
+    readonly excerpt?: string;
+    readonly path: string;
+    readonly page: number;
+    readonly pageBounds: {
+        left: number;
+        right: number;
+        top: number;
+        bottom: number;
+    };
+    readonly clientRect: {
+        left: number;
+        top: number;
+        right: number;
+        bottom: number;
+        width: number;
+        height: number;
+    } | null;
+}
+export interface EditorView {
+    readonly canvases: readonly HTMLCanvasElement[];
+    readonly zoom: number;
+    readonly currentPage: number;
+    readonly fitWidthZoom: number;
+    readonly find: FindBar;
+    readonly focused: boolean;
+    readonly readOnly: boolean;
+    readonly dragging: boolean;
+    selection(): EditorViewSelection | null;
+    readOnlyTarget(): ReadOnlyTarget | null;
+    clearReadOnlyTarget(): void;
+    selectedImage(): SelectedImageTarget | null;
+    clearSelectedImage(): void;
+    composingText(): string | null;
+    focus(): void;
+    setReadOnly(readOnly: boolean): void;
+    setZoom(zoom: number): void;
+    goToPage(index: number, options?: ScrollOptions): void;
+    selectAnchors(start: Anchor, end?: Anchor, reversed?: boolean): Promise<void>;
+    insertText(text: string): Promise<Commit | null>;
+    toggleMark(mark: Mark, enabled?: boolean): Promise<Commit | null>;
+    splitBlock(): Promise<Commit | null>;
+    setBlockStyle(style: BlockStyle): Promise<Commit | null>;
+    setAlignment(align: TextAlign): Promise<Commit | null>;
+    insertBlock(block: InsertBlock, after?: Anchor): Promise<Commit | null>;
+    editTable(action: TableAction, at?: Anchor): Promise<Commit | null>;
+    editImage(path: string, patch: {
+        widthRatio?: number;
+        align?: ImageAlign;
+        src?: string;
+        alt?: string;
+    }): Promise<Commit | null>;
+    undo(): Promise<Commit | null>;
+    redo(): Promise<Commit | null>;
+    destroy(): void;
+}
+export declare function mountEditor(container: HTMLElement, session: EditorSession, options?: EditorViewOptions): EditorView;