router.md

State

The state service manages the application state registration and routing logic.

API

• add(path, view)
• change(url, replace)
• reload()
• match(location)
• getCurrent()
• getPrevious()

Attributes

• params

add()

Add a new state to the app states list. When a the app init or when a URL changes the match method will check all states to find a state that matches the current URL.

Param	Type	Description
path	string	State URL path
view	object	State view object

Return Value

Returns state object instance.

Example

state.add('/contact-us', {
    'template': '/templates/contact-us.html',
    'repeat': false,
});

change()

Change app current state. Use the replace param to control whether the new state should replace current state in History API or added as a new state. This mainly affects the behaviour of the browser back button.

Param	Type	Description
url	string	New state URL
replace	boolean	Add new state or replace current one

Return Value

Returns state object instance.

Example

state.change('/new-view', false);

reload()

The reload method reload current app state and re-render the ls-scope view component

Return Value

Returns state object instance.

Example

state.reload();

match()

The match method iterate over all the states that has been registered to the state service with the add method and find the current state against the location object received in the method call.

Param	Type	Description
location	object	location object

Return Value

Returns matching state or null if no state was found.

Example

state.change('/new-view', false);

getCurrent()

Get current app state object.

Return Value

Returns current app state object.

Example

state.getCurrent();

getPrevious()

Get previous app state object.

Return Value

Returns previous app state object.

Example

state.getPrevious();