App - Documentation

Constructor

new App()

Source:

App/App.js, line 17

Extends

View

Members

appInsights :Object

A reference to the Azure App Insights SDK (production only).

Source:

App/App.js, line 25

Type:

Object

db :Database

A reference to the local database module.

Source:

App/App.js, line 31

Type:

Database

el

A reference to the app <body> tag.

Source:

App/App.js, line 36

helpMenu :HelpMenu

A reference to the helpmenu controller.

Source:

App/App.js, line 42

Type:

HelpMenu

nav :MainNav

A reference to the Main Nav controller.

Source:

App/App.js, line 48

Type:

MainNav

nodes :Object

A table of references to DOM nodes used by the App controller.

Properties:

Name	Type	Description
`info`	`HTMLElement`
`wrapper`	`HTMLElement`

Source:

App/App.js, line 56

Type:

Object

pages :Map

A Map of page Views, loaded dynamically when the page is requested.

Source:

App/App.js, line 65

Type:

Map

production :Boolean

A boolean indicating whether the app is currently running on production.

Source:

App/App.js, line 71

Type:

Boolean

settings :Settings

An object for persisting app/user settings. Saves to Local Storage.

Source:

App/App.js, line 77

Type:

Settings

shortcuts

An object for registering/unregistering keyboard shortcuts. See https://craig.is/killing/mice for complete documentation. The shortcuts property is a Mousetrap instance.

Source:

App/App.js, line 82

Methods

addEventListeners()

Attach event listeners to app shell components.

Source:

App/App.js, line 89

(async) addLanguage() → {Promise}

Add a new language and rerender the Languages page.

Source:

App/App.js, line 98

Returns:

Type:: Promise

announce(text)

Announce text to screen readers by updating an ARIA live region.

Source:

App/App.js, line 120

Parameters:

Name	Type	Description
`text`	`String`	the text to announce to screen readers

changeLanguage(languageCID)

Change the current language.

Source:

App/App.js, line 128

Parameters:

Name	Type	Description
`languageCID`	`String`	The CID of the language to switch to.

(async) displayPage(page)

Display a page, rendering it if necessary.

Source:

App/App.js, line 170

Parameters:

Name	Type	Description
`page`	`String`	The page to display (in lowercase).

(async) initialize()

Initialize the App.

Source:

App/App.js, line 199

(async) renderPage(page)

Render a specific page. This is the only method that should call page-rendering methods.

Source:

App/App.js, line 221

Parameters:

Name	Type	Description
`page`	`String`	the page to render (`home`, `languages`, etc.)