Class Contents

constructor

• new Contents(
      doc: Document,
      content?: HTMLElement,
      cfiBase?: string,
      sectionIndex?: number,
  ): Contents

  Parameters

  • doc: Document
  • Optionalcontent: HTMLElement
  • OptionalcfiBase: string
  • OptionalsectionIndex: number

  Returns Contents

__listeners

_expanding

_layoutStyle

_mediaQueryHandlers

_onSelectionChange

_onVisibilityChange

_resizeCheck

_size

_triggerEvent

active

called

cfiBase

content

document

documentElement

emit

epubcfi

expanding

observer

off

on

onResize

sectionIndex

selectionEndTimeout

window

StaticlistenedEvents

• get listenedEvents(): readonly [
      "keydown",
      "keyup",
      "keypress",
      "mouseup",
      "mousedown",
      "mousemove",
      "click",
      "dblclick",
      "touchend",
      "touchstart",
      "touchmove",
  ]

  Get DOM events that are listened for and passed along

  Returns readonly [
      "keydown",
      "keyup",
      "keypress",
      "mouseup",
      "mousedown",
      "mousemove",
      "click",
      "dblclick",
      "touchend",
      "touchstart",
      "touchmove",
  ]

_getStylesheetNode

• _getStylesheetNode(key?: string): false | HTMLStyleElement

  Parameters

  • Optionalkey: string

  Returns false | HTMLStyleElement

addClass

• addClass(className: string): void

  Add a class to the contents container

  Parameters

  • className: string

  Returns void

addScript

• addScript(src: string): Promise<boolean>

  Append a script tag to the document head

  Parameters

  • src: string

    url

  Returns Promise<boolean>

  loaded

addStylesheet

• addStylesheet(src: string): Promise<boolean>

  Append a stylesheet link to the document head

  Parameters

  • src: string

    url

  Returns Promise<boolean>

addStylesheetCss

• addStylesheetCss(serializedCss: string, key?: string): boolean

  Append stylesheet css

  Parameters

  • serializedCss: string
  • Optionalkey: string

    If the key is the same, the CSS will be replaced instead of inserted

  Returns boolean

addStylesheetRules

• addStylesheetRules(
      rules:
          | Record<string, Record<string, string> | Record<string, string>[]>
          | (string | string[])[][],
      key?: string,
  ): void

  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

  Parameters

  • rules:
        | Record<string, Record<string, string> | Record<string, string>[]>
        | (string | string[])[][]
  • Optionalkey: string

    If the key is the same, the CSS will be replaced instead of inserted

  Returns void

cfiFromNode

• cfiFromNode(node: Node, ignoreClass?: string): string

  Get an EpubCFI from a Dom node

  Parameters

  • node: Node
  • OptionalignoreClass: string

  Returns string

  cfi

cfiFromRange

• cfiFromRange(range: Range, ignoreClass?: string): string

  Get an EpubCFI from a Dom Range

  Parameters

  • range: Range
  • OptionalignoreClass: string

  Returns string

  cfi

columns

• columns(
      width: number,
      height: number,
      columnWidth: number,
      gap: number,
      dir?: string,
  ): void

  Apply columns to the contents for pagination

  Parameters

  • width: number
  • height: number
  • columnWidth: number
  • gap: number
  • Optionaldir: string

  Returns void

contentHeight

• contentHeight(h?: string | number): number

  Get or Set height of the contents

  Parameters

  • Optionalh: string | number

  Returns number

  height

contentWidth

• contentWidth(w?: string | number): number

  Get or Set width of the contents

  Parameters

  • Optionalw: string | number

  Returns number

  width

css

• css(property: string, value?: string, priority?: boolean): string

  Set Css styles on the contents element (typically Body)

  Parameters

  • property: string
  • Optionalvalue: string
  • Optionalpriority: boolean

    set as "important"

  Returns string

destroy

• destroy(): void

  Returns void

direction

• direction(dir?: string): void

  Set the direction of the text

  Parameters

  • Optionaldir: string

    "rtl" | "ltr"

  Returns void

fit

• fit(width: number, height: number, section?: Section): void

  Fit contents into a fixed width and height

  Parameters

  • width: number
  • height: number
  • Optionalsection: Section

  Returns void

height

• height(h?: string | number): number

  Get or Set height

  Parameters

  • Optionalh: string | number

  Returns number

  height

locationOf

• locationOf(target: string, ignoreClass?: string): { left: number; top: number }

  Get the location offset of a EpubCFI or an #id

  Parameters

  • target: string
  • OptionalignoreClass: string

    for the cfi

  Returns { left: number; top: number }

mapPage

• mapPage(
      cfiBase: string,
      layout: LayoutProps,
      start: number,
      end: number,
      dev?: boolean,
  ): EpubCFIPair | undefined

  Parameters

  • cfiBase: string
  • layout: LayoutProps
  • start: number
  • end: number
  • Optionaldev: boolean

  Returns EpubCFIPair | undefined

overflow

• overflow(overflow?: string): string

  Set overflow css style of the contents

  Parameters

  • Optionaloverflow: string

  Returns string

overflowX

• overflowX(overflow?: string): string

  Set overflowX css style of the documentElement

  Parameters

  • Optionaloverflow: string

  Returns string

overflowY

• overflowY(overflow?: string): string

  Set overflowY css style of the documentElement

  Parameters

  • Optionaloverflow: string

  Returns string

range

• range(_cfi: string, ignoreClass?: string): Range

  Get a Dom Range from EpubCFI

  Parameters

  • _cfi: string
  • OptionalignoreClass: string

  Returns Range

  range

removeClass

• removeClass(className: string): void

  Remove a class from the contents container

  Parameters

  • className: string

    class name to remove

  Returns void

root

• root(): HTMLElement | null

  Get the documentElement

  Returns HTMLElement | null

  documentElement

scaler

• scaler(scale: number, offsetX?: number, offsetY?: number): void

  Scale contents from center

  Parameters

  • scale: number
  • OptionaloffsetX: number
  • OptionaloffsetY: number

  Returns void

scrollHeight

• scrollHeight(): number

  Get documentElement scrollHeight

  Returns number

  height

scrollWidth

• scrollWidth(): number

  Get documentElement scrollWidth

  Returns number

  width

size

• size(width?: number, height?: number): void

  Size the contents to a given width and height

  Parameters

  • Optionalwidth: number
  • Optionalheight: number

  Returns void

textHeight

• textHeight(): number

  Get the height of the text using Range

  Returns number

  height

textWidth

• textWidth(): number

  Get the width of the text using Range

  Returns number

  width

viewport

• viewport(
      options?: Partial<Record<keyof ViewportSettings, string | number>>,
  ): ViewportSettings

  Get or Set the viewport element

  Parameters

  • Optionaloptions: Partial<Record<keyof ViewportSettings, string | number>>

    • width

    • height

    • scale

    • minimum

    • maximum

    • scalable

  Returns ViewportSettings

width

• width(w?: string | number): number

  Get or Set width

  Parameters

  • Optionalw: string | number

  Returns number

  width

writingMode

• writingMode(mode?: string): string

  Set the writingMode of the text

  Parameters

  • Optionalmode: string

    "horizontal-tb" | "vertical-rl" | "vertical-lr"

  Returns string