`oro:navigation`

oro:navigation surfaces the Navigation API state that the runtime makes available to application code.

Lifecycle hooks and deep links
Windows and messaging

Examples#

Read the current navigation entry and listen for browser-style navigation events:

import navigation from 'oro:navigation'

console.log(navigation.currentEntry?.url)

navigation.addEventListener('navigate', (event) => {
  console.log(event.destination.url)
})

API reference#

Module specifiers#

oro:navigation
oro:navigation/navigation

TypeScript declarations#

These declarations are generated from the runtime's published TypeScript surface.

`oro:navigation`#

declare module "oro:navigation" {
    export const Navigation: any;
    export const NavigationHistoryEntry: any;
    export const navigation: any;
    export default navigation;
}

`oro:navigation/navigation`#

declare module "oro:navigation/navigation" {
    export function setSerializer(serializer: any): void;
}

oro:navigation

Related guides#