Class Router

Hierarchy

Router

Implements

IBarbaPlugin<IRouterOptions>

Index

Properties

Methods

Properties

barba

barba: Core

logger

logger: Logger

name

name: string = "@barba/router"

routeNames

routeNames: string[] = []

routesByName

routesByName: IRouteByName

version

version: string = version

Methods

init

init(): void

Implementation of IBarbaPlugin.init
- Defined in packages/router/src/router.ts:65
Plugin initialisation.

Returns void

install

install(barba: Core, __namedParameters?: object): void

- Defined in packages/router/src/router.ts:36
Plugin installation.

Parameters
- barba: Core
- Default value __namedParameters: object = {}
  - routes: IRoute[]
Returns void

resolveRoutes

resolveRoutes(data: ITransitionData): void

- Defined in packages/router/src/router.ts:114
Hooks: do, reset.
- Update current and next data
Parameters
- data: ITransitionData
Returns void

resolveUrl

resolveUrl(url: string): IRouteResolved | null

- Defined in packages/router/src/router.ts:82
Resolve URL to route name.

Parameters
- url: string
Returns IRouteResolved | null

Generated using TypeDoc