Router

Router class.

new Router($0: Object, options: Object)

License: {@link https://opensource.org/licenses/MIT|MIT}

Author: Patrick Heng & Fabien Motte <hengpatrick.pro@gmail.com / contact@fabienmotte.com>

Parameters

$0 (Object = {})

Name	Description
$0.routes any (default [])
$0.components any (default {})
$0.basePath any (default '/')
$0.mode any (default Router.BROWSER_MODE)
$0.locale any (default '')
$0.preRendered any (default false)
$0.restoreScroll any (default false)
$0.debugMode any (default false)

options (Object = {}) Options.

Example

const routes = [{
  name: 'home',
  callback: route => { },
  path: '/'
}]
const router = new Router({ routes })

Static Members

▸ BROWSER_MODE

Browser mode.

BROWSER_MODE

Type: String

▸ HASH_MODE

Hash mode.

HASH_MODE

Type: String

▸ MEMORY_MODE

Memory mode.

MEMORY_MODE

Type: String

▸ PUSH_ACTION

Push action.

PUSH_ACTION

Type: String

▸ REPLACE_ACTION

Replace action.

REPLACE_ACTION

Type: String

▸ POP_ACTION

Pop action.

POP_ACTION

Type: String

Instance Members

▸ mount(el)

Mount.

mount(el: (String | HTMLElement))

Parameters

el ((String | HTMLElement)) DOM element to mount the router on.

▸ navigate(options)

Navigate.

navigate(options: (String | Object))

Parameters

options ((String | Object) = {}) Path or options.

Name	Description
options.query String?	Route query.
options.hash String?	Route hash.
options.name String?	Route name.
options.silent Boolean?	Silent (replace instead of push).
options.params Object?	Route parameters.

▸ go(n)

Go to the given history entry.

go(n: Number)

Parameters

n (Number) Index history entry.

▸ back()

Go to the previous history entry.

back()

▸ forward()

Go to the next history entry.

forward()

▸ replace(options)

Replace the current history entry.

replace(options: Object)

Parameters

options (Object = {}) Options.

▸ beforeEach(from, to, next)

Before each hook.

beforeEach(from: Object, to: Object, next: Function)

Parameters

from (Object) From route.

to (Object) To route.

next (Function) Next callback.

▸ afterEach(from, to, next)

After each hook.

afterEach(from: Object, to: Object, next: Function)

Parameters

from (Object) From route.

to (Object) To route.

next (Function) Next callback.

startsWith

Starts with.

startsWith

Parameters

str (String) String.

prefix (String) Prefix.

Returns

Boolean: True if given string starts with given prefix, else otherwise.

endsWith

Ends with.

endsWith

Parameters

str (String) String.

suffix (String) Suffix.

Returns

Boolean: True if given string ends with given suffix, else otherwise.

addLeadingSlash

Add leading slash.

addLeadingSlash

Parameters

str (String) String.

Returns

String: String with a leading slash.

stripLeadingSlash

Strip leading slash.

stripLeadingSlash

Parameters

str (String) String.

Returns

String: String without leading slash.

stripTrailingSlash

Strip trailing slash.

stripTrailingSlash

Parameters

str (String) String.

Returns

String: String without trailing slash.

stripSlashes

Strip slashes.

stripSlashes

Parameters

str (String) String.

Returns

String: String without slashes.

isString

Is string.

isString

Parameters

val (any) String.

Returns

Boolean: True if it is a string, false otherwise.

getHashPath

Get hash from a path.

getHashPath

Parameters

href (String = window.location.href) Href.

Returns

String: Hash extracted.

generateSpaces

Generate spaces.

generateSpaces

Parameters

str (String) String.

Returns

String: Spaces corresponding to given string length.

supportsBrowserHistory

Check browser history support.

supportsBrowserHistory

Returns

Boolean: True if browser history is supported, false otherwise.

supportsScrollRestoration

Check scroll restoration support.

supportsScrollRestoration

Returns

Boolean: True if scroll restoration is supported, false otherwise.