Show:

F2.UI Class

UI helper methods

Defined in: sdk\src\ui.js:5

Constructor

F2.UI (
  • appConfig
)

Defined in sdk\src\ui.js:5

Parameters:


Methods

Name Description
hideMask (
  • selector
)

Removes a overlay from an Element on the page

hideMask (
  • instanceId
  • selector
)
static

Removes a overlay from an Element on the page

init (
  • containerConfig
)
static
setTitle (
  • title
)

Sets the title of the app as shown in the browser. Depending on the container HTML, this method may do nothing if the container has not been configured properly or else the container provider does not allow Title's to be set.

showMask (
  • selector
  • showLoading
)

Display an ovarlay over an Element on the page

showMask (
  • instanceId
  • selector
  • showLoading
)
static

Display an ovarlay over an Element on the page

updateHeight (
  • height
)

For secure apps, this method updates the size of the iframe that contains the app. Note: It is recommended that app developers call this method anytime Elements are added or removed from the DOM

Methods

hideMask (
  • selector
)

Defined in sdk\src\ui.js:58

Removes a overlay from an Element on the page

Parameters:

  • selector String | Element

    The Element or selector to an Element that currently contains the loader


hideMask (
  • instanceId
  • selector
) static

Defined in sdk\src\ui.js:290

Removes a overlay from an Element on the page

Parameters:

  • instanceId String

    The Instance ID of the app

  • selector String | Element

    The Element or selector to an Element that currently contains the loader


init (
  • containerConfig
) static

Defined in sdk\src\ui.js:332

Parameters:


setTitle (
  • title
)

Defined in sdk\src\ui.js:163

Sets the title of the app as shown in the browser. Depending on the container HTML, this method may do nothing if the container has not been configured properly or else the container provider does not allow Title's to be set.

Parameters:

  • title String

    The title of the app


showMask (
  • selector
  • showLoading
)

Defined in sdk\src\ui.js:187

Display an ovarlay over an Element on the page

Parameters:

  • selector String | Element

    The Element or selector to an Element over which to display the loader

  • showLoading Bool

    Display a loading icon


showMask (
  • instanceId
  • selector
  • showLoading
) static

Defined in sdk\src\ui.js:345

Display an ovarlay over an Element on the page

Parameters:

  • instanceId String

    The Instance ID of the app

  • selector String | Element

    The Element or selector to an Element over which to display the loader

  • showLoading Bool

    Display a loading icon


updateHeight (
  • height
)

Defined in sdk\src\ui.js:197

For secure apps, this method updates the size of the iframe that contains the app. Note: It is recommended that app developers call this method anytime Elements are added or removed from the DOM

Parameters:

  • height Int

    The height of the app