@rebodocs/viewer 0.0.0-stage → 0.12.0

package/types/viewer/src/viewer.d.ts

@@ -0,0 +1,52 @@
+import { type Doc } from '@rebodocs/core/internal';
+import { Editor } from '@rebodocs/editor';
+/** A document: the bytes of a .docx, or one already read with `importDocx` of `@rebodocs/core`. */
+export type ViewerSource = Uint8Array | ArrayBuffer | Doc;
+/** How the pages are set out: one under another, each whole on the screen, or all of them at once. */
+export type ViewerLayout = 'pages' | 'all';
+export interface ViewerOptions {
+    /** How the pages are set out at first: one under another ('pages', as it comes), or all at once ('all'). */
+    layout?: ViewerLayout;
+    /** False to leave out the bar floating over the pages; the layout and the zoom are then the application's. */
+    bar?: boolean;
+}
+export interface Viewer {
+    /** The editor that draws the pages, read only. */
+    readonly editor: Editor;
+    /** How many pages the document has. */
+    readonly pages: number;
+    readonly layout: ViewerLayout;
+    setLayout(mode: ViewerLayout): void;
+    /** The browser's print dialog, with the pages as they are laid out: to paper, or to a PDF. */
+    print(): void;
+    destroy(): void;
+}
+/**
+ * The width each page is shown at so that `pages` pages, each `ratio` times as tall as it is wide, all fit in
+ * `width` × `height`, as many across as that takes: the largest that does. When none is as wide as a page is
+ * still made out at, pages of a set width, and the rest is scrolled to.
+ */
+export declare function pageWidthToFit(pages: number, ratio: number, width: number, height: number): number;
+/**
+ * A document to read in `container`, which must have a size: the editor, read only, and the status bar floating
+ * over its pages. The words are those of the language set with `setLocale`.
+ */
+export declare function createViewer(container: HTMLElement, source: ViewerSource, options?: ViewerOptions): Viewer;
+/**
+ * The first page of a document as the editor draws it, for a thumbnail: drawn once out of sight, and given as a copy
+ * of that page at its real size, its pictures in it, inside an element of the editor's class so its rules still hold
+ * (`data-width` and `data-height` say the size, in pixels), to be shown made smaller.
+ */
+export declare function pageThumbnail(source: ViewerSource): Promise<HTMLElement>;
+export interface PagePictureOptions {
+    /** 'image/jpeg', as it comes, or 'image/png'. */
+    type?: string;
+    /** Of a JPEG, from 0 to 1. */
+    quality?: number;
+}
+/**
+ * The first page of a document as a picture, its longest side `size` pixels: what the editor draws, put in an SVG
+ * with the editor's stylesheet and drawn on a canvas, its pictures in it. A font the document carries is drawn in
+ * the one of the system nearest it.
+ */
+export declare function pagePicture(source: ViewerSource, size: number, options?: PagePictureOptions): Promise<Blob>;