Interface: Router

Implemented by

• BaseRouter

Properties

hash

• Readonly hash: undefined | null | ParsedQuery<string>

Defined in

onekijs/packages/onekijs-framework/src/types/router.ts:68

---

history

• history: Location[]

Defined in

onekijs/packages/onekijs-framework/src/types/router.ts:75

---

href

• Readonly href: undefined | null | string

Defined in

onekijs/packages/onekijs-framework/src/types/router.ts:70

---

i18n

• i18n: I18n

Defined in

onekijs/packages/onekijs-framework/src/types/router.ts:74

---

location

• Readonly location: Location

Defined in

onekijs/packages/onekijs-framework/src/types/router.ts:66

---

params

• params: AnonymousObject<any>

Defined in

onekijs/packages/onekijs-framework/src/types/router.ts:76

---

pathname

• Readonly pathname: null | string

Defined in

onekijs/packages/onekijs-framework/src/types/router.ts:71

---

previousLocation

• Readonly previousLocation: Location

Defined in

onekijs/packages/onekijs-framework/src/types/router.ts:67

---

query

• Readonly query: undefined | null | ParsedQuery<string>

Defined in

onekijs/packages/onekijs-framework/src/types/router.ts:69

---

route

• Optional route: string

Defined in

onekijs/packages/onekijs-framework/src/types/router.ts:77

---

settings

• settings: AppSettings

Defined in

onekijs/packages/onekijs-framework/src/types/router.ts:73

---

state

• Readonly state: undefined | null | AnonymousObject<any>

Defined in

onekijs/packages/onekijs-framework/src/types/router.ts:72

Methods

back

▸ back(delta?): void

Parameters

Name	Type
delta?	number

Returns

void

Defined in

onekijs/packages/onekijs-framework/src/types/router.ts:78

---

deleteOrigin

▸ deleteOrigin(): void

Returns

void

Defined in

onekijs/packages/onekijs-framework/src/types/router.ts:79

---

forward

▸ forward(delta?): void

Parameters

Name	Type
delta?	number

Returns

void

Defined in

onekijs/packages/onekijs-framework/src/types/router.ts:80

---

getLinkComponent

▸ getLinkComponent(props, ref): Element

Parameters

Name	Type
props	LinkProps
ref	null | MutableRefObject<null | HTMLAnchorElement> | (instance: null | HTMLAnchorElement) => void

Returns

Element

Defined in

onekijs/packages/onekijs-framework/src/types/router.ts:82

---

getOrigin

▸ getOrigin(): Object

Returns

Object

Name	Type
from	string

Defined in

onekijs/packages/onekijs-framework/src/types/router.ts:86

---

getReactContext

▸ getReactContext(): Context<any>

Returns

Context<any>

Defined in

onekijs/packages/onekijs-framework/src/types/router.ts:81

---

init

▸ init(settings): void

Parameters

Name	Type
settings	AppSettings

Returns

void

Defined in

onekijs/packages/onekijs-framework/src/types/router.ts:87

---

listen

▸ listen(callback): UnregisterCallback

Parameters

Name	Type
callback	LocationChangeCallback

Returns

UnregisterCallback

Defined in

onekijs/packages/onekijs-framework/src/types/router.ts:88

---

push

▸ push(urlOrLocation, options?): void

Parameters

Name	Type
urlOrLocation	string | Location
options?	RouterPushOptions

Returns

void

Defined in

onekijs/packages/onekijs-framework/src/types/router.ts:89

---

replace

▸ replace(urlOrLocation, options?): void

Parameters

Name	Type
urlOrLocation	string | Location
options?	RouterPushOptions

Returns

void

Defined in

onekijs/packages/onekijs-framework/src/types/router.ts:90

---

saveOrigin

▸ saveOrigin(force?): void

Parameters

Name	Type
force?	boolean

Returns

void

Defined in

onekijs/packages/onekijs-framework/src/types/router.ts:91