Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add polyfill for navigation API. #1217

Merged
merged 1 commit into from
Apr 5, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions src/core/polyfills.js
Original file line number Diff line number Diff line change
Expand Up @@ -38,3 +38,44 @@
true
);
})();

// Navigation polyfill for Firefox and Safari, as of 2024-01-04
// NOTE: this is a very basic polyfill, it only supports firing a `navigate`
// event on location change and even that without interception support, etc.
!(function () {
if (window.navigation == undefined) {

class NavigateEvent extends CustomEvent {
constructor() {
super("navigate");
this.destination = { url: undefined };
}
}

// Create a navigation object on the window
// We create a DOM element for the navigation object so that we can
// attach events on it.
window.navigation = document.createElement("div");

const create_event = (args) => {
const event = new NavigateEvent();
event.destination.url = args[2];
return event;
};

// Patch pushState to trigger an `navigate` event on the navigation
// object when the URL changes.
const pushState = window.history.pushState;
window.history.pushState = function () {
pushState.apply(window.history, arguments);
window.navigation.dispatchEvent(create_event(arguments));
};

// Same with replaceState
const replaceState = window.history.replaceState;
window.history.replaceState = function () {
replaceState.apply(window.history, arguments);
window.navigation.dispatchEvent(create_event(arguments));
};
}
})();
34 changes: 34 additions & 0 deletions src/core/polyfills.test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
import "./polyfills";

describe("NavigateEvent tests", () => {
afterEach(() => {
document.body.innerHTML = "";
});

it("should fire an event when history.pushState is called.", () => {
let destination_url;

window.navigation.addEventListener("navigate", (event) => {
destination_url = event.destination.url;
});

const path = "foo/bar/baz.html";
history.pushState(null, "", path);

expect(destination_url).toBe(path);
});


it("should fire an event when history.replaceState is called.", () => {
let destination_url;

window.navigation.addEventListener("navigate", (event) => {
destination_url = event.destination.url;
});

const path = "foo/bar/baz.html";
history.replaceState(null, "", path);

expect(destination_url).toBe(path);
});
});