Interface ICustomReaderViewContent

Interface used in methods where the client application is able to render custom content to the ReaderView. This can be used for rendering custom loading animations, localized error pages for the user, etc.

interface ICustomReaderViewContent {
    layout?: CustomReaderViewContentLayout;
    onRemoved?(element: HTMLElement): void;
    renderTo(containerElement: HTMLElement): void;
}

Properties

`Optional`layout

layout?: CustomReaderViewContentLayout

Defines how the container element will layout the custom ReaderView content.

FLEX_CENTER: The container element will centered the custom page content vertically and horizontally using: display: flex; flex-direction: column; align-items: center; justify-content: center;
BLOCK: The container element is a simple
block with a defined width and height and position 'relative'.

Defaults to FLEX_CENTER

Methods

`Optional`onRemoved

onRemoved?(element: HTMLElement): void
Called when the custom content has been removed from the specified container element. Implement this method if you need to run any cleanup code such as removing event handlers.
Parameters
- element: HTMLElement
Returns void

renderTo

renderTo(containerElement: HTMLElement): void
Called when the application should render content into the specified container element.
Parameters
- containerElement: HTMLElement
  The container element to render into.
Returns void