Global

Members

(constant) Action :string

Information about what type of call triggered the screen change

Properties:
Name Type Description
Replace string

Manager#replace
Set string

Manager#set
Back string

Manager#back
Push string

Manager#push
State string

Manager#setState
Source:

(constant) ScreenTransition :string

List of possible transitions to a new screen. Screens exit with the inverse of the transition that they entered with.

Properties:
Name Type Description
None string

No transition
SlideLeft string

New screen slides in from right edge moving left
SlideRight string

New screen slides in from left edge moving right
SlideUp string

New screen slides in from bottom edge moving up
SlideDown string

New screen slides in from top edge moving down
Zoom string

Screen grows from the center of the previous screen until it covers the entire viewport
Fade string

Screen fades in over top of the previous screen
PushLeft string

Both screens move left togethor. Screen enters from the right
PushRight string

Both screens move right togethor. Screen enters from the left
PushDown string

Both screens move down togethor. Screen enters from the top
PushUp string

Both screens move up togethor. Screen enters from the bottom
FadeLeft string

Fades in at the same time as sliding partially from the left
FadeRight string

Fades in at the same time as sliding partially from the right
FadeUp string

Fades in at the same time as sliding partially from the top
FadeDown string

Fades in at the same time as sliding partially from the bottom
Source:

Type Definitions

disconnectFunction(container)

Parameters:
Name Type Description
container HTMLElement

Same container that was passed to the screenFactoryFunction
Source:

getStateFunction() → {object}

Called to ask a screen for what its current state is. Typically right before it is removed from the DOM.

Source:

ItemState

Properties:
Name Type Description
state object

momento object from caller
id string
transition ScreenTransition
viewportScroll ScrollValues
Source:
Properties:
Name Type Description
transition ScreenTransition
stack Array.<ItemState>
Source:

Options

Properties:
Name Type Attributes Description
transition ScreenTransition <optional>
viewportScroll ScrollValues <optional>
isOverlay boolean <optional>
Source:

Screen

Properties:
Name Type Attributes Description
getState getStateFunction

function to return a momento object representing the current state of the screen
disconnect disconnectFunction <optional>

function to call when the screen elements are no longer needed in the DOM
Source:

ScreenChange

Properties:
Name Type Description
from NavigationItem

The screen that was previously shown
to NavigationItem

The screen that will become visible
controller Manager
action Action

type of call that triggered this transition
Source:

screenFactoryFunction(id, state, container) → {Screen}

Parameters:
Name Type Description
id string
state object

Memento object representing the state of the screen. Provided by the call to Manager#push, Manager#set, Manager#replace, or Screen#getState
container HTMLElement

Element to populate with contests of screen represented by id in state
Source: