Link copied!

Top Hash

The addEventListener method helps to navigate in Suite from iframes by letting an app in an iframe be notified of hashchange events on top window. With its pair, the removeEventListener, the subscription can be cancelled.
A sample workflow is that the app gets the current top url with e.utils.v2.navigation.getTopUrl() and uses the hash/fragment for it's initial routing, then on any top hash change it updates it's current state. All links should use target="_top" attribute (or a <base> tag should be used for the same result). By that, the app can be opened in current tab or in a new tab or page, and won't lose it's current route on refresh.

Usage

Name Description
window.e.utils.v2.navigation.topHash.addEventListener(callback) Registers a callback function that will be called on each hashchange event on top window.
window.e.utils.v2.navigation.topHash.removeEventListener(callback) The given callback won't be called anymore on hash changes.
window.e.utils.v2.navigation.topHash.update(hash) Update top window url hash. It is useful for seting the same hash from your application to manage

Parameters addEventListener

Name Description Type Required Default value
callback Callback function yes

Parameters removeEventListener

Name Description Type Required Default value
callback Callback function yes

Parameters update

Name Description Type Required Default value
hash new hash for the top window URL yes

Examples

window.e.utils.v2.navigation.topHash.addEventListener(({ oldURL, newURL }) => console.log({ oldURL, newURL }));