Expand all

mobile.startup

The main library for accessing MobileFrontend's stable APIs.

Source:

Properties

Overlay :module:mobile.startup/Overlaystatic #

Internal for use inside Minerva, ExternalGuidance, GrowthExperiments and Echo only.

Type:

Source:

Internal for use inside Minerva, ExternalGuidance, GrowthExperiments and Echo only.

PageHTMLParser :module:mobile.startup/PageHTMLParserstatic #

Internal for use inside Minerva only.

Type:

Source:
Internal for use inside Minerva only.

View :module:mobile.startup/Viewstatic #

Internal for use inside Minerva, ExternalGuidance and Echo only.

Type:

Source:
Internal for use inside Minerva, ExternalGuidance and Echo only.

amcOutreach :module:mobile.startup/AmcOutreachstatic #

Internal for use inside Minerva only

Type:

Source:
Internal for use inside Minerva only

currentPage :module:mobile.startup/Pagestatic #

Internal for use inside Minerva only.

Type:

Source:
Internal for use inside Minerva only.

currentPageHTMLParser :module:mobile.startup/PageHTMLParserstatic #

Internal for use inside Minerva only.

Type:

Source:
Internal for use inside Minerva only.

languages :module:mobile.startup/languagesstatic #

Access to language overlays for usage inside Minerva only.

Type:

Source:
Access to language overlays for usage inside Minerva only.

mediaViewer :module:mobile.startup/mediaViewerstatic #

Internal for use inside Minerva only.

Type:

Source:
Internal for use inside Minerva only.

references :module:mobile.startup/referencesstatic #

Internal for use inside Minerva only.

Type:

Source:
Internal for use inside Minerva only.

search :module:mobile.startup/searchstatic #

Internal for use inside Minerva only.

Type:

Source:
Internal for use inside Minerva only.

spinner :module:mobile.startup/Iconstatic #

Internal for use inside Minerva only.

Type:

Source:
Internal for use inside Minerva only.

time :module:mobile.startup/timestatic #

Internal for use inside Minerva only.

Type:

Source:
Internal for use inside Minerva only.

Methods

CtaDrawer(options) → {module:mobile.startup/Drawer}static #

Internal for use inside Minerva only, creates the drawer at the bottom of the screen that appears when an anonymous user tries to perform an action that requires being logged in. It presents the user with options to log in or sign up for a new account.

Parameters:

Name Type Description
options module:mobile.startup.CtaOptions

Options for drawer.
Source:

Returns:

Type
module:mobile.startup/Drawer

Internal for use inside Minerva only, creates the drawer at the bottom of the screen that appears when an anonymous user tries to perform an action that requires being logged in.

getOverlayManager() → {module:mobile.startup/OverlayManager}static #

Internal for use inside Minerva, ExternalGuidance and Echo only.

Source:

Returns:

Type
module:mobile.startup/OverlayManager
Internal for use inside Minerva, ExternalGuidance and Echo only.

header(heading, headerActions, [headerCancel], [additionalClassNames]) → {Element}static #

Creates a header with a h2 heading, internal for use inside GrowthExperiments only.

Parameters:

Name Type Attributes Description
heading string

(HTML allowed)
headerActions Array.<module:mobile.startup/View>
headerCancel module:mobile.startup/View optional

defaults to cancel button
additionalClassNames string optional

(should be escaped)
Source:

Returns:

Type
Element
Creates a header with a h2 heading, internal for use inside GrowthExperiments only.

license() → {string|undefined}static #

Internal for use inside VisualEditor

Source:

Returns:

Type
string | undefined
Internal for use inside VisualEditor

loadAllImagesInPage() → {jQuery.Deferred}static #

Loads all images on the page, stable to call.

Source:

Returns:

Type
jQuery.Deferred
Loads all images on the page, stable to call.

notifyOnPageReload(msg) → {jQuery.Deferred}static #

Show a notification on page reload, internal for Minerva

Parameters:

Name Type Description
msg string
Source:

Returns:

Type
jQuery.Deferred
Show a notification on page reload, internal for Minerva

promisedView(promise) → {module:mobile.startup/View}static #

Internal for use inside Echo, GrowthExperiments only. It's a view that spins until the promise resolves! If the promise successfully resolves, the newView will be shown. if the promise rejects and rejects to a view, the errorView will be shown.

Parameters:

Name Type Description
promise jQuery.Promise
Source:

Returns:

Type
module:mobile.startup/View
Internal for use inside Echo, GrowthExperiments only.

Type Definitions

CtaOptions #

Describes a call to action drawer.

Type:

Properties:

Name Type Attributes Description
returnTo string optional
queryParams module:mobile.startup~QueryParams optional
signupQueryParams module:mobile.startup~QueryParams optional
progressiveButton Object optional

button options for Button element for signing in. If omitted will create a login URL.
actionAnchor Object optional

anchor options for Anchor element for signing up. If omitted will create a sign up URL
content string

text - what is the call to action?
Source:
Describes a call to action drawer.

QueryParams #

Describes a combination of query string parameters.

Type:

Source:
Describes a combination of query string parameters.

QueryVal #

Represents a query string value.

Type:

  • string | number | boolean | undefined | Array.<string> | Array.<boolean>
Source:
Represents a query string value.

onBeforeHide() #

Callback intended to allow the client run extra logic (e.g. show a modal) after the drawer is dismissed.

Source:
Callback intended to allow the client run extra logic (e.g.