https://github.com/frehner/apphistory
A polyfill for the AppHistory proposal
https://github.com/frehner/apphistory
apphistory javascript polyfill
Last synced: about 2 months ago
JSON representation
A polyfill for the AppHistory proposal
- Host: GitHub
- URL: https://github.com/frehner/apphistory
- Owner: frehner
- License: mit
- Created: 2021-02-12T23:14:19.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-12-20T20:13:40.000Z (over 3 years ago)
- Last Synced: 2025-03-17T22:59:40.946Z (2 months ago)
- Topics: apphistory, javascript, polyfill
- Language: JavaScript
- Homepage:
- Size: 363 KB
- Stars: 25
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# appHistory polyfill
⚠️ Not for production. Use at your own risk; there will be breaking changes because the spec is not yet finalized ⚠️
A work-in-progress polyfill for the [appHistory proposal](https://github.com/WICG/app-history).
## Usage
This polyfill must run in a browser-like environment (e.g. an env that has `window.location` and `window.history`). If there's time, and demand for it, I think it would be interesting to have a discussion about how this polyfill could work in other environments.
To setup the polyfill so that it will automatically listen for anchor tag clicks, do the following:
```js
import { useBrowerPolyfill } from "@frehner/apphistory";
userBrowserPolyfill();
// appHistory is now on the window
window.appHistory.navigate();
```
Alternatively, you can create your own instance of AppHistory:
```js
import { AppHistory } from "@frehner/apphistory";
const appHistory = new AppHistory();
// use your own instance of appHistory, without any events from things like anchor tags
appHistory.navigate();
```
You can also get a ready-to-go ESM version from
- JSDelivr https://cdn.jsdelivr.net/npm/@frehner/apphistory/build/esm/appHistory.min.js
- unpkg https://unpkg.com/@frehner/apphistory/build/esm/appHistory.min.js
## Differences
- The events for an `AppHistoryEntry` use `event.detail.target` instead of `event.target` to get access to the AppHistoryEntry that fired the event.