maloon-nav

Navigator functions for maloon 🧭

NOTE: This package is intended for use with maloon. For guides and install look here

Import

import { navigate, navigateFresh, open, Page, state } from 'maloon-nav'

Exports

navigate(page, queryString) ⇒ Promise.<void>

Navigates to a different page / route

navigateFresh(page, queryString) ⇒ Promise.<void>

Navigates to a different page / route and enforces a fresh component load. This can be useful when javascript is rendered on the server

open(page, queryString) ⇒ PageInfo

Opens a new tab with the specified page / route

Page() ⇒ PageInfo

Returns info and methods giving useful information about the current page

state.save()

Saves current state so that it can be recovered on reload. NOTE: This is done automatically when using open() or navigating to an external page. NOTE2: State will only be saved until next page load

state.load()

Loads stored state. NOTE: This will be done automatically when using definePages()

state.set(key, value)

Stores a value in the state

state.get(key) ⇒ StateCompatible

Retrieves some data from the state

navigate(page, queryString) ⇒ Promise.<void>

Navigates to a different page / route

Kind: global function

Param	Description
page	A page name, a page path or an absolute url to an external website
queryString	Here you can optionally provide a queryString

navigateFresh(page, queryString) ⇒ Promise.<void>

Navigates to a different page / route and enforces a fresh component load. This can be useful when javascript is rendered on the server

Kind: global function

Param	Description
page	A page name, a page path or an absolute url to an external website
queryString	Here you can optionally provide a queryString

open(page, queryString) ⇒ PageInfo

Opens a new tab with the specified page / route

Kind: global function
Returns: PageInfo - Will look like this:

{
    name: string,
    path: string,
    query: ParsedQueryString => Object,
    close(): void,
    isControlledByOtherPage(): boolean,
    refresh(): void,
    back(): void
    forward(): void
}

Param	Description
page	A page name, a page path or an absolute url to an external website
queryString	Here you can optionally provide a queryString

Page() ⇒ PageInfo

Returns info and methods giving useful information about the current page

Kind: global function
Returns: PageInfo - Will look like this:

{
    name: string,
    path: string,
    query: ParsedQueryString => Object,
    close(): void,
    isControlledByOtherPage(): boolean,
    refresh(): void,
    back(): void
    forward(): void
}

state.save()

Saves current state so that it can be recovered on reload. NOTE: This is done automatically when using open() or navigating to an external page. NOTE2: State will only be saved until next page load

Kind: global function

state.load()

Loads stored state. NOTE: This will be done automatically when using definePages()

Kind: global function

state.set(key, value)

Stores a value in the state

Kind: global function

Param	Description
key	Key for the data
value	Whatever you want to save. Just make sure it's JSON serializable

Example

state.set('key', 'value')

state.get(key) ⇒ StateCompatible

Retrieves some data from the state

Kind: global function
Returns: StateCompatible - Anything that is JSON serializable

Param	Description
key	Key for the data

Example

state.get('key')