@likecoin/epub-ts 0.3.93

package/dist/contents.d.ts

@@ -0,0 +1,351 @@
+import { default as EpubCFI } from './epubcfi';
+import { ViewportSettings, LayoutProps, EpubCFIPair, IEventEmitter } from './types';
+import { default as Section } from './section';
+/**
+    * Handles DOM manipulation, queries and events for View contents
+    * @class
+    * @param {document} doc Document
+    * @param {element} content Parent Element (typically Body)
+    * @param {string} cfiBase Section component of CFIs
+    * @param {number} sectionIndex Index in Spine of Conntent's Section
+    */
+declare class Contents implements IEventEmitter {
+    on: (type: string, fn: (...args: any[]) => void) => this;
+    off: (type: string, fn?: (...args: any[]) => void) => this;
+    emit: (type: string, ...args: any[]) => void;
+    epubcfi: EpubCFI;
+    document: Document;
+    documentElement: HTMLElement;
+    content: HTMLElement;
+    window: Window;
+    _size: {
+        width: number;
+        height: number;
+    };
+    sectionIndex: number;
+    cfiBase: string;
+    called: number;
+    active: boolean;
+    observer: ResizeObserver | MutationObserver | undefined;
+    expanding: ReturnType<typeof setTimeout> | undefined;
+    onResize: ((size: {
+        width: number;
+        height: number;
+    }) => void) | undefined;
+    _expanding: boolean;
+    _resizeCheck: (() => void) | undefined;
+    _triggerEvent: ((e: Event) => void) | undefined;
+    _onSelectionChange: ((e: Event) => void) | undefined;
+    selectionEndTimeout: ReturnType<typeof setTimeout> | undefined;
+    _layoutStyle: string;
+    constructor(doc: Document, content?: HTMLElement, cfiBase?: string, sectionIndex?: number);
+    /**
+        * Get DOM events that are listened for and passed along
+        */
+    static get listenedEvents(): readonly ["keydown", "keyup", "keypressed", "mouseup", "mousedown", "mousemove", "click", "touchend", "touchstart", "touchmove"];
+    /**
+        * Get or Set width
+        * @param {number} [w]
+        * @returns {number} width
+        */
+    width(w?: number | string): number;
+    /**
+        * Get or Set height
+        * @param {number} [h]
+        * @returns {number} height
+        */
+    height(h?: number | string): number;
+    /**
+        * Get or Set width of the contents
+        * @param {number} [w]
+        * @returns {number} width
+        */
+    contentWidth(w?: number | string): number;
+    /**
+        * Get or Set height of the contents
+        * @param {number} [h]
+        * @returns {number} height
+        */
+    contentHeight(h?: number | string): number;
+    /**
+        * Get the width of the text using Range
+        * @returns {number} width
+        */
+    textWidth(): number;
+    /**
+        * Get the height of the text using Range
+        * @returns {number} height
+        */
+    textHeight(): number;
+    /**
+        * Get documentElement scrollWidth
+        * @returns {number} width
+        */
+    scrollWidth(): number;
+    /**
+        * Get documentElement scrollHeight
+        * @returns {number} height
+        */
+    scrollHeight(): number;
+    /**
+        * Set overflow css style of the contents
+        * @param {string} [overflow]
+        */
+    overflow(overflow?: string): string;
+    /**
+        * Set overflowX css style of the documentElement
+        * @param {string} [overflow]
+        */
+    overflowX(overflow?: string): string;
+    /**
+        * Set overflowY css style of the documentElement
+        * @param {string} [overflow]
+        */
+    overflowY(overflow?: string): string;
+    /**
+        * Set Css styles on the contents element (typically Body)
+        * @param {string} property
+        * @param {string} value
+        * @param {boolean} [priority] set as "important"
+        */
+    css(property: string, value?: string, priority?: boolean): string;
+    /**
+        * Get or Set the viewport element
+        * @param {object} [options]
+        * @param {string} [options.width]
+        * @param {string} [options.height]
+        * @param {string} [options.scale]
+        * @param {string} [options.minimum]
+        * @param {string} [options.maximum]
+        * @param {string} [options.scalable]
+        */
+    viewport(options?: Partial<Record<keyof ViewportSettings, string | number>>): ViewportSettings;
+    /**
+     * Event emitter for when the contents has expanded
+     * @private
+     */
+    expand(): void;
+    /**
+     * Add DOM listeners
+     * @private
+     */
+    listeners(): void;
+    /**
+     * Remove DOM listeners
+     * @private
+     */
+    removeListeners(): void;
+    /**
+     * Check if size of contents has changed and
+     * emit 'resize' event if it has.
+     * @private
+     */
+    resizeCheck(): void;
+    /**
+     * Poll for resize detection
+     * @private
+     */
+    resizeListeners(): void;
+    /**
+     * Listen for visibility of tab to change
+     * @private
+     */
+    visibilityListeners(): void;
+    /**
+     * Use css transitions to detect resize
+     * @private
+     */
+    transitionListeners(): void;
+    /**
+     * Listen for media query changes and emit 'expand' event
+     * Adapted from: https://github.com/tylergaw/media-query-events/blob/master/js/mq-events.js
+     * @private
+     */
+    mediaQueryListeners(): void;
+    /**
+     * Use ResizeObserver to listen for changes in the DOM and check for resize
+     * @private
+     */
+    resizeObservers(): void;
+    /**
+     * Use MutationObserver to listen for changes in the DOM and check for resize
+     * @private
+     */
+    mutationObservers(): void;
+    /**
+     * Test if images are loaded or add listener for when they load
+     * @private
+     */
+    imageLoadListeners(): void;
+    /**
+     * Listen for font load and check for resize when loaded
+     * @private
+     */
+    fontLoadListeners(): void;
+    /**
+     * Get the documentElement
+     * @returns {element} documentElement
+     */
+    root(): HTMLElement | null;
+    /**
+     * Get the location offset of a EpubCFI or an #id
+     * @param {string | EpubCFI} target
+     * @param {string} [ignoreClass] for the cfi
+     * @returns { {left: Number, top: Number }
+     */
+    locationOf(target: string, ignoreClass?: string): {
+        left: number;
+        top: number;
+    };
+    /**
+     * Append a stylesheet link to the document head
+     * @param {string} src url
+     */
+    addStylesheet(src: string): Promise<boolean>;
+    _getStylesheetNode(key?: string): HTMLStyleElement | false;
+    /**
+     * Append stylesheet css
+     * @param {string} serializedCss
+     * @param {string} key If the key is the same, the CSS will be replaced instead of inserted
+     */
+    addStylesheetCss(serializedCss: string, key?: string): boolean;
+    /**
+     * Append stylesheet rules to a generate stylesheet
+     * Array: https://developer.mozilla.org/en-US/docs/Web/API/CSSStyleSheet/insertRule
+     * Object: https://github.com/desirable-objects/json-to-css
+     * @param {array | object} rules
+     * @param {string} key If the key is the same, the CSS will be replaced instead of inserted
+     */
+    addStylesheetRules(rules: any, key?: string): void;
+    /**
+     * Append a script tag to the document head
+     * @param {string} src url
+     * @returns {Promise} loaded
+     */
+    addScript(src: string): Promise<boolean>;
+    /**
+     * Add a class to the contents container
+     * @param {string} className
+     */
+    addClass(className: string): void;
+    /**
+     * Remove a class from the contents container
+     * @param {string} removeClass
+     */
+    removeClass(className: string): void;
+    /**
+     * Add DOM event listeners
+     * @private
+     */
+    addEventListeners(): void;
+    /**
+     * Remove DOM event listeners
+     * @private
+     */
+    removeEventListeners(): void;
+    /**
+     * Emit passed browser events
+     * @private
+     */
+    triggerEvent(e: Event): void;
+    /**
+     * Add listener for text selection
+     * @private
+     */
+    addSelectionListeners(): void;
+    /**
+     * Remove listener for text selection
+     * @private
+     */
+    removeSelectionListeners(): void;
+    /**
+     * Handle getting text on selection
+     * @private
+     */
+    onSelectionChange(_e: Event): void;
+    /**
+     * Emit event on text selection
+     * @private
+     */
+    triggerSelectedEvent(selection: Selection): void;
+    /**
+     * Get a Dom Range from EpubCFI
+     * @param {EpubCFI} _cfi
+     * @param {string} [ignoreClass]
+     * @returns {Range} range
+     */
+    range(_cfi: string, ignoreClass?: string): Range;
+    /**
+     * Get an EpubCFI from a Dom Range
+     * @param {Range} range
+     * @param {string} [ignoreClass]
+     * @returns {EpubCFI} cfi
+     */
+    cfiFromRange(range: Range, ignoreClass?: string): string;
+    /**
+     * Get an EpubCFI from a Dom node
+     * @param {node} node
+     * @param {string} [ignoreClass]
+     * @returns {EpubCFI} cfi
+     */
+    cfiFromNode(node: Node, ignoreClass?: string): string;
+    map(layout: LayoutProps): EpubCFIPair[];
+    /**
+     * Size the contents to a given width and height
+     * @param {number} [width]
+     * @param {number} [height]
+     */
+    size(width?: number, height?: number): void;
+    /**
+     * Apply columns to the contents for pagination
+     * @param {number} width
+     * @param {number} height
+     * @param {number} columnWidth
+     * @param {number} gap
+     */
+    columns(width: number, height: number, columnWidth: number, gap: number, dir?: string): void;
+    /**
+     * Scale contents from center
+     * @param {number} scale
+     * @param {number} offsetX
+     * @param {number} offsetY
+     */
+    scaler(scale: number, offsetX?: number, offsetY?: number): void;
+    /**
+     * Fit contents into a fixed width and height
+     * @param {number} width
+     * @param {number} height
+     */
+    fit(width: number, height: number, section?: Section): void;
+    /**
+     * Set the direction of the text
+     * @param {string} [dir="ltr"] "rtl" | "ltr"
+     */
+    direction(dir: string): void;
+    mapPage(cfiBase: string, layout: LayoutProps, start: number, end: number, dev?: boolean): EpubCFIPair | undefined;
+    /**
+     * Emit event when link in content is clicked
+     * @private
+     */
+    linksHandler(): void;
+    /**
+     * Set the writingMode of the text
+     * @param {string} [mode="horizontal-tb"] "horizontal-tb" | "vertical-rl" | "vertical-lr"
+     */
+    writingMode(mode?: string): string;
+    /**
+     * Set the layoutStyle of the content
+     * @param {string} [style="paginated"] "scrolling" | "paginated"
+     * @private
+     */
+    layoutStyle(style?: string): string;
+    /**
+     * Add the epubReadingSystem object to the navigator
+     * @param {string} name
+     * @param {string} version
+     * @private
+     */
+    epubReadingSystem(name: string, version: string): void;
+    destroy(): void;
+}
+export default Contents;

package/dist/displayoptions.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Open DisplayOptions Format Parser
+ * @class
+ * @param {document} displayOptionsDocument XML
+ */
+declare class DisplayOptions {
+    interactive: string;
+    fixedLayout: string;
+    openToSpread: string;
+    orientationLock: string;
+    constructor(displayOptionsDocument?: Document);
+    /**
+     * Parse XML
+     * @param  {document} displayOptionsDocument XML
+     * @return {DisplayOptions} self
+     */
+    parse(displayOptionsDocument: Document): this;
+    destroy(): void;
+}
+export default DisplayOptions;