Skip to main content

Class: PageNavigationHandler

Defined in: packages/core/src/page/handler/PageNavigationHandler.ts:7

Extends​

Constructors​

Constructor​

new PageNavigationHandler(window): PageNavigationHandler

Defined in: packages/core/src/page/handler/PageNavigationHandler.ts:18

Parameters​

window​

Window

The utility for manipulating the global context and global client-side-specific APIs.

Returns​

PageNavigationHandler

Overrides​

PageHandler.constructor

Properties​

_window​

protected _window: Window

Defined in: packages/core/src/page/handler/PageNavigationHandler.ts:8

$dependencies​

static $dependencies: Dependencies

Defined in: packages/core/src/page/handler/PageNavigationHandler.ts:12

Methods​

_saveScrollHistory()​

_saveScrollHistory(): void

Defined in: packages/core/src/page/handler/PageNavigationHandler.ts:104

Save user's scroll state to history.

Replace scroll values in current state for actual scroll values in document.

Returns​

void

_scrollTo()​

_scrollTo(__namedParameters): void

Defined in: packages/core/src/page/handler/PageNavigationHandler.ts:123

Scrolls to give coordinates on a page. Uses requestAnimationFrame to ensure React has finished rendering and the browser has completed layout/paint before scrolling.

Parameters​

__namedParameters​
x?​

number = 0

y?​

number = 0

Returns​

void

_setAddressBar()​

_setAddressBar(url, isRedirection): void

Defined in: packages/core/src/page/handler/PageNavigationHandler.ts:153

Sets the provided URL to the browser's address bar by pushing or replacing a new state to the history.

The state object pushed to or replaced in the history will be an object with the following structure: {url: string}. The url field will be set to the provided URL.

Parameters​

url​

string

The URL.

isRedirection​

boolean

If replaceState should be used instead of pushState.

Returns​

void

destroy()​

destroy(): void

Defined in: packages/core/src/page/handler/PageHandler.ts:50

Finalization callback, called when the page manager is being discarded. This usually happens when the page is hot-reloaded at the client side.

Returns​

void

Inherited from​

PageHandler.destroy

handlePostManagedState()​

handlePostManagedState(managedPage, previousManagedPage, action): void

Defined in: packages/core/src/page/handler/PageNavigationHandler.ts:84

Called after a PageManager finishes transition from previous page to a new one.

Parameters​

managedPage​

ManagedPage

The currently managed page.

previousManagedPage​

ManagedPage

The data of the page that was previously managed.

action​

PageAction

An action object describing what triggered the routing.

Returns​

void

Overrides​

PageHandler.handlePostManagedState

handlePreManagedState()​

handlePreManagedState(managedPage, nextManagedPage, action): void

Defined in: packages/core/src/page/handler/PageNavigationHandler.ts:43

Called before a PageManager starts to transition from previous page to a new one.

Parameters​

managedPage​

ManagedPage

The currently managed page - soon-to-be previously managed page.

nextManagedPage​

ManagedPage

The data of the page that's about to be managed.

action​

PageAction

An action object describing what triggered the routing.

Returns​

void

Overrides​

PageHandler.handlePreManagedState

init()​

init(): void

Defined in: packages/core/src/page/handler/PageNavigationHandler.ts:31

Initializes the page handler.

Returns​

void

Overrides​

PageHandler.init