Namespace: navigation

qui.navigation

Source:

Classes

PageLoadError
PageNotFoundError
SectionLoadError

Members

(static, constant) BACK_MODE_CLOSE

Source:

(static, constant) BACK_MODE_HISTORY

Source:

(static) whenInitialNavigationReady :qui.base.ConditionVariable

A condition that is fulfilled as soon as the initial navigation is completed.

Type:
Source:

Methods

(static) addHistoryEntry(stateopt)

Add a history entry corresponding to the current path, or optionally to a given state.

Parameters:
Name Type Attributes Description
state Object <optional>

the history entry state to add (will use qui.navigation.getCurrentHistoryEntryState by default)
Source:
See:

(static) getBackMode() → {String}

Return the function of the back button.

Source:
Returns:

one of:

Type
String

(static) getCurrentHistoryEntryState() → {Object}

Capture a snapshot of the state of the current history entry.

Source:
Returns:
Type
Object

(static) getCurrentPath() → {Array.<String>}

Return the current path as an array of path ids.

Source:
Returns:
Type
Array.<String>

(static) getCurrentQuery() → {Object.<String, String>}

Return the current URL query as a dictionary.

Source:
Returns:
Type
Object.<String, String>

(static) makeInternalAnchor(path, content) → {jQuery}

Create an anchor element that represents a link to an internal path.

Parameters:
Name Type Description
path String | Array.<String>
content String | jQuery
Source:
Returns:
Type
jQuery

(static) navigate(path, handleErrorsopt, pageStateopt, historyEntryopt) → {Promise}

Navigate the given path.

Parameters:
Name Type Attributes Description
path String | Array.<String>

the path to navigate
handleErrors Boolean <optional>

set to false to pass errors to the caller instead of handling them internally (defaults to true)
pageState * <optional>

optional history state to pass to qui.navigation.PageMixin#restoreHistoryState
historyEntry Boolean <optional>

whether to create a new history entry for current page before navigating (defaults to true)
Source:
Returns:

a promise that settles as soon as the navigation ends, being rejected in case of any error

Type
Promise

(static) pathToURL(path) → {String}

Transform a QUI path into a fully qualified URL.

Parameters:
Name Type Description
path String | Array.<String>
Source:
Returns:
Type
String

(static) setBackMode(mode)

Set the function of the back button:

Parameters:
Name Type Description
mode String
Source:

(static) updateHistoryEntry(stateopt)

Update the current history entry from the current path, or optionally from a given state.

Parameters:
Name Type Attributes Description
state Object <optional>

the history entry state to add (will use qui.navigation.getCurrentHistoryEntryState by default)
Source:
See: