Class UltraBuilder

Router builder class for ultradom

Hierarchy

UltraBuilder

Index

Properties

Methods

Properties

build

build: TBuild

Private configRouter

configRouter: IConfigRouter

router

router: Navigo

Methods

Private checkDefault

checkDefault(): void

- Defined in builder.ts:135
Returns void

Private checkNotFound

checkNotFound(): void

- Defined in builder.ts:143
Returns void

Private checkQuery

checkQuery(query: string): string

- Defined in builder.ts:92
Parameters
- query: string
Returns string

Private checkState

checkState(query: string): string | object

- Defined in builder.ts:100
Parameters
- query: string
Returns string | object

Private createRootElement

createRootElement(root?: string): any

- Defined in builder.ts:73
Parameters
- Optional root: string
Returns any

go

go(path: string, state?: any | null, absolute?: boolean): void

- Defined in builder.ts:51
go to another path of the router

Parameters
- path: string
  
  path to go
- Optional state: any | null
  
  pass the current state to the new path
- Optional absolute: boolean
  
  if path is absolute
Returns void

resolve

resolve(currentUrl?: string): void

- Defined in builder.ts:66
Active the router

Parameters
- Optional currentUrl: string
  
  if currentURL is provided then the method tries resolving the registered routes to that URL and not window.location.href
Returns void

Private setRender

setRender(route: IUltraRoutes, params: object, query: string, rootElement?: Element, features?: IFeatures): void

- Defined in builder.ts:114
Parameters
- route: IUltraRoutes
- params: object
- query: string
- Optional rootElement: Element
- Optional features: IFeatures
Returns void

setRouter

setRouter(configRouter: IConfigRouter): this

- Defined in builder.ts:20
Set router across the config object

Parameters
- configRouter: IConfigRouter
  
  config object to set the router
Returns this

Generated using TypeDoc