From cfc6bb65ae40a558219bf1d903647e094e0a93b4 Mon Sep 17 00:00:00 2001 From: andrepolischuk Date: Fri, 28 Jun 2024 12:12:05 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20rambler-?= =?UTF-8?q?digital-solutions/widgetly@d9e135e74ec2f5367f500538bede116e8a63?= =?UTF-8?q?5785=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- classes/BaseLayout.html | 20 +++++++++---------- classes/Container.html | 12 +++++------ classes/ContentElement.html | 4 ++-- classes/EmbedLayout.html | 24 +++++++++++----------- classes/IFrameConsumer.html | 10 +++++----- classes/IFrameProvider.html | 22 ++++++++++---------- classes/Mediator.html | 26 ++++++++++++------------ classes/OverlayLayout.html | 28 +++++++++++++------------- classes/Widget.html | 30 ++++++++++++++-------------- functions/createMediator.html | 4 ++-- functions/createViewportManager.html | 4 ++-- functions/registerIFrame.html | 4 ++-- functions/setMutationParams.html | 4 ++-- hierarchy.html | 2 +- index.html | 2 +- interfaces/Callback.html | 4 ++-- interfaces/ContainerElement.html | 4 ++-- interfaces/Debounce.html | 4 ++-- interfaces/EmbedLayoutConfig.html | 6 +++--- interfaces/EnterViewportOptions.html | 8 ++++---- interfaces/IFrameConsumerConfig.html | 10 +++++----- interfaces/MediatorAPI.html | 4 ++-- interfaces/MediatorConfig.html | 10 +++++----- interfaces/OverlayLayoutConfig.html | 12 +++++------ interfaces/ViewportManager.html | 4 ++-- interfaces/VisibleArea.html | 12 +++++------ interfaces/WidgetAPI.html | 4 ++-- interfaces/WidgetConfig.html | 16 +++++++-------- modules.html | 2 +- variables/globalViewportEvents.html | 4 ++-- variables/mutationEvents.html | 4 ++-- 31 files changed, 152 insertions(+), 152 deletions(-) diff --git a/classes/BaseLayout.html b/classes/BaseLayout.html index 6197ff9..e4c989d 100644 --- a/classes/BaseLayout.html +++ b/classes/BaseLayout.html @@ -1,6 +1,6 @@ BaseLayout | widgetly

Class BaseLayout<T>Abstract

Basic layout

destroy Destroy layout

-

Type Parameters

  • T = any

Hierarchy (view full)

Methods

addToDOM +

Type Parameters

  • T = any

Hierarchy (view full)

Methods

addToDOM destroy getElement hide @@ -9,17 +9,17 @@ show showLoading

Methods

Abstract addToDOM

Abstract destroy

getElement

Abstract hide

Abstract hideLoading

Abstract setContent

Abstract show

Abstract showLoading

Settings

Member Visibility

Theme

On This Page

addToDOMdestroygetElementhidehideLoadingsetContentshowshowLoading

Generated using TypeDoc
+

Parameters

Returns void

Abstract destroy

getElement

Abstract hide

Abstract hideLoading

Abstract setContent

Abstract show

Abstract showLoading

Settings

Member Visibility

Theme

On This Page

addToDOMdestroygetElementhidehideLoadingsetContentshowshowLoading

Generated using TypeDoc

Class Container

Container for widgets

-

Hierarchy

  • EventEmitter
    • Container

Constructors

constructor +

Hierarchy

  • EventEmitter
    • Container

Constructors

constructor

Methods

appendChild destroy whenEnterViewportFromTop

Constructors

constructor

Methods

appendChild

  • appendChild(element): void

  • Append content element

    -

    Parameters

    • element: HTMLElement

    Returns void

destroy

whenEnterViewportFromTop

  • whenEnterViewportFromTop(options): Promise<void>

  • Returns a Promise that resolves when the container enters the viewport from the top

    -

    Parameters

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

constructorappendChilddestroywhenEnterViewportFromTop

Generated using TypeDoc
+

Returns Container

Methods

appendChild

  • appendChild(element): void

  • Append content element

    +

    Parameters

    • element: HTMLElement

    Returns void

destroy

whenEnterViewportFromTop

  • whenEnterViewportFromTop(options): Promise<void>

  • Returns a Promise that resolves when the container enters the viewport from the top

    +

    Parameters

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

constructorappendChilddestroywhenEnterViewportFromTop

Generated using TypeDoc

Class ContentElementAbstract

Content element

-

Implemented by

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Implemented by

Settings

Member Visibility

Theme

Generated using TypeDoc

Class EmbedLayout

Embedded layout

destroy Destroy layout

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Methods

addToDOM destroy getElement @@ -12,22 +12,22 @@ toggleLoading

Constructors

constructor

Methods

addToDOM

  • addToDOM(container): void

  • Add current object to container

    +

Returns EmbedLayout

Methods

addToDOM

destroy

getElement

hide

hideLoading

setContent

  • setContent(content): void

  • Set content in the layout

    +

Returns void

destroy

getElement

hide

hideLoading

setContent

show

showLoading

toggleLoading

  • toggleLoading(show): void

  • Show/hide loader

    +

Returns void

show

showLoading

toggleLoading

Settings

Member Visibility

Theme

On This Page

constructoraddToDOMdestroygetElementhidehideLoadingsetContentshowshowLoadingtoggleLoading

Generated using TypeDoc
+

Returns void

Settings

Member Visibility

Theme

On This Page

constructoraddToDOMdestroygetElementhidehideLoadingsetContentshowshowLoadingtoggleLoading

Generated using TypeDoc

Class IFrameConsumer

Consumer inside an iframe

-

Constructors

constructor +

Constructors

constructor

Methods

externalize externalizeAsConsumer

Constructors

constructor

Methods

externalize

  • externalize(): Record<string, any>

  • Factory that exports a facade available externally to the widget (for the webmaster)

    -

    Returns Record<string, any>

externalizeAsConsumer

  • externalizeAsConsumer(): {
        externalizedProps: Record<string, any>;
        getSize: (() => {
            height: number;
            width: number;
        });
        initialize: ((...args) => void);
        resize: (() => undefined | void);
        watchSize: (() => void);
    }

  • Factory that exports a facade available to the widget

    -

    Returns {
        externalizedProps: Record<string, any>;
        getSize: (() => {
            height: number;
            width: number;
        });
        initialize: ((...args) => void);
        resize: (() => undefined | void);
        watchSize: (() => void);
    }

    • externalizedProps: Record<string, any>
    • getSize: (() => {
          height: number;
          width: number;
      })
        • (): {
              height: number;
              width: number;
          }

        • Returns {
              height: number;
              width: number;
          }

          • height: number
          • width: number
    • initialize: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: []

          Returns void

    • resize: (() => undefined | void)
        • (): undefined | void

        • Returns undefined | void

    • watchSize: (() => void)
        • (): void

        • Returns void

Settings

Member Visibility

Theme

On This Page

constructorexternalizeexternalizeAsConsumer

Generated using TypeDoc
+

Returns IFrameConsumer

Methods

externalize

  • externalize(): Record<string, any>

  • Factory that exports a facade available externally to the widget (for the webmaster)

    +

    Returns Record<string, any>

externalizeAsConsumer

  • externalizeAsConsumer(): {
        externalizedProps: Record<string, any>;
        getSize: (() => {
            height: number;
            width: number;
        });
        initialize: ((...args) => void);
        resize: (() => undefined | void);
        watchSize: (() => void);
    }

  • Factory that exports a facade available to the widget

    +

    Returns {
        externalizedProps: Record<string, any>;
        getSize: (() => {
            height: number;
            width: number;
        });
        initialize: ((...args) => void);
        resize: (() => undefined | void);
        watchSize: (() => void);
    }

    • externalizedProps: Record<string, any>
    • getSize: (() => {
          height: number;
          width: number;
      })
        • (): {
              height: number;
              width: number;
          }

        • Returns {
              height: number;
              width: number;
          }

          • height: number
          • width: number
    • initialize: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: []

          Returns void

    • resize: (() => undefined | void)
        • (): undefined | void

        • Returns undefined | void

    • watchSize: (() => void)
        • (): void

        • Returns void

Settings

Member Visibility

Theme

On This Page

constructorexternalizeexternalizeAsConsumer

Generated using TypeDoc

Class IFrameProvider

Wrapper over an iframe

viewportChange Event when the viewport of the element changes destroy Termination of the provider

-

Hierarchy

  • EventEmitter
    • IFrameProvider

Implements

Constructors

constructor +

Hierarchy

  • EventEmitter
    • IFrameProvider

Implements

Constructors

constructor

Methods

createElement destroy getElement @@ -15,19 +15,19 @@
  • widget: Widget

    Widget object

  • id: string

    Unique widget identifier

  • Optional reduceViewportChange: Debounce

    Method to debounce viewport change tracking

    -

    • Returns IFrameProvider

    Methods

    createElement

    destroy

    getElement

    • getElement(): HTMLIFrameElement

    • Get the current iframe element

      -

      Returns HTMLIFrameElement

    getVisibleArea

    initialize

    • initialize(): Promise<Promisify<EventEmitter<DefaultEventMap> & IFrameConsumerAPI>>

    • Initialization of the iframe provider

      -

      Returns Promise<Promisify<EventEmitter<DefaultEventMap> & IFrameConsumerAPI>>

    resize

    subscribeVisibleAreaChange

    • subscribeVisibleAreaChange(callback): (() => void)

    • Subscription to changes in the visible area of the iframe

      +

    Returns IFrameProvider

    Methods

    createElement

    destroy

    getElement

    • getElement(): HTMLIFrameElement

    • Get the current iframe element

      +

      Returns HTMLIFrameElement

    getVisibleArea

    initialize

    • initialize(): Promise<Promisify<EventEmitter<DefaultEventMap> & IFrameConsumerAPI>>

    • Initialization of the iframe provider

      +

      Returns Promise<Promisify<EventEmitter<DefaultEventMap> & IFrameConsumerAPI>>

    resize

    subscribeVisibleAreaChange

    • subscribeVisibleAreaChange(callback): (() => void)

    • Subscription to changes in the visible area of the iframe

      Parameters

      Returns (() => void)

        • (): void

        • Returns void

    updateViewport

    Settings

    Member Visibility

    Theme

    On This Page

    constructorcreateElementdestroygetElementgetVisibleAreainitializeresizesubscribeVisibleAreaChangeupdateViewport

    Generated using TypeDoc
    +

    Returns (() => void)

    updateViewport

    Settings

    Member Visibility

    Theme

    On This Page

    constructorcreateElementdestroygetElementgetVisibleAreainitializeresizesubscribeVisibleAreaChangeupdateViewport

    Generated using TypeDoc

    Class Mediator

    Mediator - a widget factory

    -

    Hierarchy

    • EventEmitter
      • Mediator

    Constructors

    constructor +

    Hierarchy

    • EventEmitter
      • Mediator

    Constructors

    constructor

    Properties

    id prefix widgetInstances @@ -31,22 +31,22 @@
  • externalize
  • externalizeAsProvider
    • -

    Returns Mediator

    Properties

    id

    id: string

    Mediator identifier

    -

    prefix

    prefix: string

    Prefix used for data-attributes

    -

    widgetInstances

    widgetInstances: Record<string, Widget> = {}

    Widget instances

    -

    widgets

    widgets: Record<string, {
        config: WidgetConfig;
        properties: Record<string, any>;
    }> = {}

    Widgets

    -

    Type declaration

    Methods

    buildWidget

    • buildWidget(name, containerElement, params?): Promise<WidgetAPI>

    • Create a widget and place it on the page

      +

    Returns Mediator

    Properties

    id

    id: string

    Mediator identifier

    +

    prefix

    prefix: string

    Prefix used for data-attributes

    +

    widgetInstances

    widgetInstances: Record<string, Widget> = {}

    Widget instances

    +

    widgets

    widgets: Record<string, {
        config: WidgetConfig;
        properties: Record<string, any>;
    }> = {}

    Widgets

    +

    Type declaration

    Methods

    buildWidget

    • buildWidget(name, containerElement, params?): Promise<WidgetAPI>

    • Create a widget and place it on the page

      Parameters

      • name: string

        Widget name

      • containerElement: string | HTMLElement

        Element/selector where the widget will be inserted

      • Optional params: Record<string, any>

        Widget initialization parameters

        -

      Returns Promise<WidgetAPI>

    • buildWidget(name, params?): Promise<WidgetAPI>

    • Create a widget and place it on the page

      +

    Returns Promise<WidgetAPI>

  • buildWidget(name, params?): Promise<WidgetAPI>

  • Create a widget and place it on the page

    Parameters

    • name: string

      Widget name

    • Optional params: Record<string, any>

      Widget initialization parameters

      -

    Returns Promise<WidgetAPI>

    • defineWidget

    • defineWidget(config, properties?): void

    • Define a widget

      +

    Returns Promise<WidgetAPI>

    defineWidget

    • defineWidget(config, properties?): void

    • Define a widget

      Parameters

      • config: WidgetConfig

        Widget configuration

      • properties: Record<string, any> = {}

        Additional widget properties, this object is copied to the widget as is and supplements it with these properties

        -

      Returns void

    destroy

    • destroy(): void

    • Destroy the mediator and stop listening to DOM events

      -

      Returns void

    externalize

    • externalize(): {
          buildWidget: {
              (name, containerElement, params?): Promise<WidgetAPI>;
              (name, params?): Promise<WidgetAPI>;
          };
          initializeDOMElements: (() => void);
      }

    • Factory that exports a facade available to the widget

      +

    Returns void

    destroy

    externalize

    externalizeAsProvider

    externalizeAsProvider

    Settings

    Member Visibility

    Theme

    On This Page

    constructoridprefixwidgetInstanceswidgetsbuildWidgetdefineWidgetdestroyexternalizeexternalizeAsProvider

    Generated using TypeDoc
    +

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    constructoridprefixwidgetInstanceswidgetsbuildWidgetdefineWidgetdestroyexternalizeexternalizeAsProvider

    Generated using TypeDoc

    Class OverlayLayout

    Layout for modal window

    destroy Destroy layout

    -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Methods

    addToDOM destroy getElement @@ -14,23 +14,23 @@ toggleLoading

    Constructors

    constructor

    Methods

    addToDOM

    destroy

    getElement

    hide

    hideLoading

    moveBehind

    moveFront

    setContent

    • setContent(content): void

    • Set content in layout

      +

    Returns OverlayLayout

    Methods

    addToDOM

    destroy

    getElement

    hide

    hideLoading

    moveBehind

    moveFront

    setContent

    show

    showLoading

    toggleLoading

    • toggleLoading(show): void

    • Toggle loader visibility

      +

    Returns void

    show

    showLoading

    toggleLoading

    Settings

    Member Visibility

    Theme

    On This Page

    constructoraddToDOMdestroygetElementhidehideLoadingmoveBehindmoveFrontsetContentshowshowLoadingtoggleLoading

    Generated using TypeDoc
    +

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    constructoraddToDOMdestroygetElementhidehideLoadingmoveBehindmoveFrontsetContentshowshowLoadingtoggleLoading

    Generated using TypeDoc

    Class Widget

    Widget

    destroy Widget deletion event

    -

    Hierarchy

    • EventEmitter
      • Widget

    Constructors

    constructor +

    Hierarchy

    • EventEmitter
      • Widget

    Constructors

    constructor

    Properties

    config id name @@ -36,18 +36,18 @@
  • whenContainerInViewport
  • reduceViewportChange
    • -

    Returns Widget

    Properties

    config

    config: WidgetConfig

    Widget configuration

    -

    id

    id: string

    Widget identifier

    -

    name

    name: string

    Widget name

    -

    params

    params: Record<string, any>

    External parameters for the widget

    -

    properties

    properties: Record<string, any>

    Widget properties

    -

    Methods

    addToContainer

    • addToContainer(container): void

    • Set a container for the widget

      -

      Parameters

      Returns void

    createIFrame

    Returns Widget

    Properties

    config

    config: WidgetConfig

    Widget configuration

    +

    id

    id: string

    Widget identifier

    +

    name

    name: string

    Widget name

    +

    params

    params: Record<string, any>

    External parameters for the widget

    +

    properties

    properties: Record<string, any>

    Widget properties

    +

    Methods

    addToContainer

    • addToContainer(container): void

    • Set a container for the widget

      +

      Parameters

      Returns void

    createIFrame

    destroy

    • destroy(): void

    • Destroy the widget and stop listening events

      -

      Returns void

    externalize

    • externalize(): {
          destroy: (() => void);
          params: Record<string, any>;
      }

    • A factory that exports the facade available to the external user

      +

    Returns IFrameProvider

    destroy

    • destroy(): void

    • Destroy the widget and stop listening events

      +

      Returns void

    externalize

    • externalize(): {
          destroy: (() => void);
          params: Record<string, any>;
      }

    • A factory that exports the facade available to the external user

      Returns {
          destroy: (() => void);
          params: Record<string, any>;
      }

      • destroy: (() => void)
          • (): void

          • Destroy the widget and stop listening events

            -

            Returns void

      • params: Record<string, any>

    externalizeAsProvider

    • externalizeAsProvider(): {
          destroy: (() => void);
          getVisibleArea: (() => VisibleArea);
          mediator: {
              buildWidget: {
                  (name, containerElement, params?): Promise<WidgetAPI>;
                  (name, params?): Promise<WidgetAPI>;
              };
              initializeDOMElements: (() => void);
          };
          params: Record<string, any>;
          resize: undefined | (() => void);
          scrollTo: ((top, duration?) => Promise<void>);
          subscribeVisibleAreaChange: ((callback) => undefined | (() => void));
          url: string;
      }

    • A factory that exports the facade available in the iframe

      +

      Returns void

  • params: Record<string, any>

    • externalizeAsProvider

    • externalizeAsProvider(): {
          destroy: (() => void);
          getVisibleArea: (() => VisibleArea);
          mediator: {
              buildWidget: {
                  (name, containerElement, params?): Promise<WidgetAPI>;
                  (name, params?): Promise<WidgetAPI>;
              };
              initializeDOMElements: (() => void);
          };
          params: Record<string, any>;
          resize: undefined | (() => void);
          scrollTo: ((top, duration?) => Promise<void>);
          subscribeVisibleAreaChange: ((callback) => undefined | (() => void));
          url: string;
      }

    • A factory that exports the facade available in the iframe

      Returns {
          destroy: (() => void);
          getVisibleArea: (() => VisibleArea);
          mediator: {
              buildWidget: {
                  (name, containerElement, params?): Promise<WidgetAPI>;
                  (name, params?): Promise<WidgetAPI>;
              };
              initializeDOMElements: (() => void);
          };
          params: Record<string, any>;
          resize: undefined | (() => void);
          scrollTo: ((top, duration?) => Promise<void>);
          subscribeVisibleAreaChange: ((callback) => undefined | (() => void));
          url: string;
      }

      • destroy: (() => void)
          • (): void

          • Destroy the widget and stop listening events

            Returns void

      • getVisibleArea: (() => VisibleArea)
      • mediator: {
            buildWidget: {
                (name, containerElement, params?): Promise<WidgetAPI>;
                (name, params?): Promise<WidgetAPI>;
            };
            initializeDOMElements: (() => void);
        }
        • buildWidget: {
              (name, containerElement, params?): Promise<WidgetAPI>;
              (name, params?): Promise<WidgetAPI>;
          }
            • (name, containerElement, params?): Promise<WidgetAPI>

            • Create a widget and place it on the page

              Parameters

              • name: string

                Widget name

                @@ -61,12 +61,12 @@

                Parameters

                • top: number

                  The coordinate relative to the top-left corner of the iframe to scroll to

                • duration: number = 200

                  Scroll animation time, default is 200

                Returns Promise<void>

          • subscribeVisibleAreaChange: ((callback) => undefined | (() => void))
              • (callback): undefined | (() => void)

              • Callback for iframe viewport change (whether the iframe is visible or not)

                -

                Parameters

                Returns undefined | (() => void)

          • url: string

    initialize

    • initialize(): Promise<{
          destroy: (() => void);
          params: Record<string, any>;
      }>

    • Widget initialization function

      -

      Returns Promise<{
          destroy: (() => void);
          params: Record<string, any>;
      }>

    whenContainerInViewport

    • whenContainerInViewport(options): Promise<void>

    • Wait when the container enters the viewport from the top

      -

      Parameters

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    On This Page

    constructorconfigidnameparamspropertiesaddToContainercreateIFramedestroyexternalizeexternalizeAsProviderinitializewhenContainerInViewport

    Generated using TypeDoc
    +

    Parameters

    Returns undefined | (() => void)

  • url: string

    • initialize

    whenContainerInViewport

    Settings

    Member Visibility

    Theme

    On This Page

    constructorconfigidnameparamspropertiesaddToContainercreateIFramedestroyexternalizeexternalizeAsProviderinitializewhenContainerInViewport

    Generated using TypeDoc

    Function createMediator

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    +

    Returns Mediator

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    Function registerIFrame

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    +

    Returns IFrameConsumer

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    Function setMutationParams

    • setMutationParams(params): void

    • Set parameters for mutationObserver

      -

      Parameters

      • params: MutationObserverInit

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    +

    Parameters

    • params: MutationObserverInit

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    widgetly

    Class Hierarchy

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    Interface Callback

    Base callback

    -
    interface Callback ((...args) => any)

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    +

    interface Callback ((...args) => any)

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    Interface ContainerElement

    Container element

    -
    interface ContainerElement {}

    Hierarchy

    • HTMLElement
      • ContainerElement

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    +

    interface ContainerElement {}

    Hierarchy

    • HTMLElement
      • ContainerElement

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    Interface Debounce

    Base debounce

    -
    interface Debounce (<T>(func) => T)

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    +

    interface Debounce (<T>(func) => T)

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    Interface EmbedLayoutConfig

    Embedded layout configuration

    -
    interface EmbedLayoutConfig {
        spinner?: string;
    }

    Properties

    spinner? +
    interface EmbedLayoutConfig {
        spinner?: string;
    }

    Properties

    spinner?

    Properties

    Optional spinner

    spinner?: string

    Spinner HTML template

    -

    Settings

    Member Visibility

    Theme

    On This Page

    spinner

    Generated using TypeDoc
    +

    Settings

    Member Visibility

    Theme

    On This Page

    spinner

    Generated using TypeDoc

    Interface EnterViewportOptions

    Options for waiting when the container enters the viewport

    -
    interface EnterViewportOptions {
        lazy?: boolean;
        offset?: number;
    }

    Properties

    lazy? +
    interface EnterViewportOptions {
        lazy?: boolean;
        offset?: number;
    }

    Properties

    lazy? offset?

    Properties

    Optional lazy

    lazy?: boolean

    Enable lazy loading, default is false

    -

    Optional offset

    offset?: number

    Offset for lazy loading, default is 300

    -

    Settings

    Member Visibility

    Theme

    On This Page

    lazyoffset

    Generated using TypeDoc
    +

    Optional offset

    offset?: number

    Offset for lazy loading, default is 300

    +

    Settings

    Member Visibility

    Theme

    On This Page

    lazyoffset

    Generated using TypeDoc

    Interface IFrameConsumerConfig

    Configuration of the consumer inside an iframe

    -
    interface IFrameConsumerConfig {
        externalize?(this): void;
        externalizeAsConsumer?(this): void;
        initialize(this): void;
    }

    Methods

    externalize? +
    interface IFrameConsumerConfig {
        externalize?(this): void;
        externalizeAsConsumer?(this): void;
        initialize(this): void;
    }

    Methods

    externalize? externalizeAsConsumer? initialize

    Methods

    Optional externalize

    Optional externalizeAsConsumer

    initialize

    Settings

    Member Visibility

    Theme

    On This Page

    externalizeexternalizeAsConsumerinitialize

    Generated using TypeDoc
    +

    Parameters

    Returns void

    Optional externalizeAsConsumer

    initialize

    Settings

    Member Visibility

    Theme

    On This Page

    externalizeexternalizeAsConsumerinitialize

    Generated using TypeDoc

    Interface MediatorAPI

    Mediator facade available to the widget and inside an iframe

    -
    interface MediatorAPI {}

    Hierarchy

    • EventEmitterAPI
    • Record<string, any>
      • MediatorAPI

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    +

    interface MediatorAPI {}

    Hierarchy

    • EventEmitterAPI
    • Record<string, any>
      • MediatorAPI

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    Interface MediatorConfig

    Mediator configuration

    -
    interface MediatorConfig {
        prefix: string;
        externalizeAsProvider?(this): Record<string, any>;
        initialize?(this): void;
    }

    Properties

    prefix +
    interface MediatorConfig {
        prefix: string;
        externalizeAsProvider?(this): Record<string, any>;
        initialize?(this): void;
    }

    Properties

    prefix

    Methods

    externalizeAsProvider? initialize?

    Properties

    prefix

    prefix: string

    Prefix for data-attributes

    -

    Methods

    Optional externalizeAsProvider

    • externalizeAsProvider(this): Record<string, any>

    • Factory that exports a facade available in an iframe

      -

      Parameters

      Returns Record<string, any>

    Optional initialize

    Settings

    Member Visibility

    Theme

    On This Page

    prefixexternalizeAsProviderinitialize

    Generated using TypeDoc
    +

    Methods

    Optional externalizeAsProvider

    • externalizeAsProvider(this): Record<string, any>

    • Factory that exports a facade available in an iframe

      +

      Parameters

      Returns Record<string, any>

    Optional initialize

    Settings

    Member Visibility

    Theme

    On This Page

    prefixexternalizeAsProviderinitialize

    Generated using TypeDoc

    Interface OverlayLayoutConfig

    Overlay layout configuration for modal window

    -
    interface OverlayLayoutConfig {
        animationDuration?: number;
        className?: string;
        hidden?: boolean;
        spinner?: string;
    }

    Properties

    animationDuration? +
    interface OverlayLayoutConfig {
        animationDuration?: number;
        className?: string;
        hidden?: boolean;
        spinner?: string;
    }

    Properties

    animationDuration? className? hidden? spinner?

    Properties

    Optional animationDuration

    animationDuration?: number

    Duration of opacity animation in ms, default 200

    -

    Optional className

    className?: string

    CSS class added to element

    -

    Optional hidden

    hidden?: boolean

    Add hidden layout to DOM

    -

    Optional spinner

    spinner?: string

    HTML template for spinner

    -

    Settings

    Member Visibility

    Theme

    On This Page

    animationDurationclassNamehiddenspinner

    Generated using TypeDoc
    +

    Optional className

    className?: string

    CSS class added to element

    +

    Optional hidden

    hidden?: boolean

    Add hidden layout to DOM

    +

    Optional spinner

    spinner?: string

    HTML template for spinner

    +

    Settings

    Member Visibility

    Theme

    On This Page

    animationDurationclassNamehiddenspinner

    Generated using TypeDoc

    Interface ViewportManager

    Base viewport manager

    -
    interface ViewportManager {}

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    +

    interface ViewportManager {}

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    Interface VisibleArea

    Visible area

    -
    interface VisibleArea {
        height: number;
        left: number;
        top: number;
        width: number;
    }

    Properties

    height +
    interface VisibleArea {
        height: number;
        left: number;
        top: number;
        width: number;
    }

    Properties

    height left top width

    Properties

    height

    height: number

    Visible height of the element

    -

    left

    left: number

    Coordinates relative to the top left corner of the element from which it is visible

    -

    top

    top: number

    Coordinates relative to the top left corner of the element from which it is visible

    -

    width

    width: number

    Visible width of the element

    -

    Settings

    Member Visibility

    Theme

    On This Page

    heightlefttopwidth

    Generated using TypeDoc
    +

    left

    left: number

    Coordinates relative to the top left corner of the element from which it is visible

    +

    top

    top: number

    Coordinates relative to the top left corner of the element from which it is visible

    +

    width

    width: number

    Visible width of the element

    +

    Settings

    Member Visibility

    Theme

    On This Page

    heightlefttopwidth

    Generated using TypeDoc

    Interface WidgetAPI

    Widget facade available to the user

    -
    interface WidgetAPI {}

    Hierarchy

    • EventEmitterAPI
    • Record<string, any>
      • WidgetAPI

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    +

    interface WidgetAPI {}

    Hierarchy

    • EventEmitterAPI
    • Record<string, any>
      • WidgetAPI

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    Interface WidgetConfig

    Widget configuration

    -
    interface WidgetConfig {
        name: string;
        reduceViewportChange?: Debounce;
        destroy?(this): void;
        externalize?(this): Record<string, any>;
        externalizeAsProvider?(this): Record<string, any>;
        initialize(this): void;
    }

    Properties

    name +
    interface WidgetConfig {
        name: string;
        reduceViewportChange?: Debounce;
        destroy?(this): void;
        externalize?(this): Record<string, any>;
        externalizeAsProvider?(this): Record<string, any>;
        initialize(this): void;
    }

    Properties

    name reduceViewportChange?

    Methods

    destroy? externalize? externalizeAsProvider? initialize

    Properties

    name

    name: string

    Unique widget name

    -

    Optional reduceViewportChange

    reduceViewportChange?: Debounce

    Function to slow down the processing of Viewport changes, if it is absent, the standard debounce is used

    -

    Methods

    Optional destroy

    • destroy(this): void

    • Widget deletion function, this function should be called by the user when deleting the widget

      -

      Parameters

      Returns void

    Optional externalize

    • externalize(this): Record<string, any>

    • A factory that exports the facade available to the user. +

    Optional reduceViewportChange

    reduceViewportChange?: Debounce

    Function to slow down the processing of Viewport changes, if it is absent, the standard debounce is used

    +

    Methods

    Optional destroy

    • destroy(this): void

    • Widget deletion function, this function should be called by the user when deleting the widget

      +

      Parameters

      Returns void

    Optional externalize

    • externalize(this): Record<string, any>

    • A factory that exports the facade available to the user. By default, exports properties passed to the widget and properties that the iframe exports

      -

      Parameters

      Returns Record<string, any>

    Optional externalizeAsProvider

    • externalizeAsProvider(this): Record<string, any>

    • A factory that exports the facade available in the iframe

      -

      Parameters

      Returns Record<string, any>

    initialize

    • initialize(this): void

    • Widget initialization function, should render the widget

      -

      Parameters

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    namereduceViewportChangedestroyexternalizeexternalizeAsProviderinitialize

    Generated using TypeDoc
    +

    Parameters

    Returns Record<string, any>

    Optional externalizeAsProvider

    • externalizeAsProvider(this): Record<string, any>

    • A factory that exports the facade available in the iframe

      +

      Parameters

      Returns Record<string, any>

    initialize

    • initialize(this): void

    • Widget initialization function, should render the widget

      +

      Parameters

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    namereduceViewportChangedestroyexternalizeexternalizeAsProviderinitialize

    Generated using TypeDoc

    Variable globalViewportEventsConst

    globalViewportEvents: EventEmitter<DefaultEventMap> = ...

    Monitor scroll window

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    Variable mutationEventsConst

    mutationEvents: EventEmitter<DefaultEventMap> = ...

    Create a MutationObserver

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc