https://github.com/remix-run/history

Manage session history with JavaScript
https://github.com/remix-run/history

Last synced: 3 days ago
JSON representation

Manage session history with JavaScript

• Host: GitHub
• URL: https://github.com/remix-run/history
• Owner: remix-run
• License: mit
• Created: 2015-07-18T23:31:47.000Z (over 9 years ago)
• Default Branch: dev
• Last Pushed: 2024-07-07T03:25:42.000Z (5 months ago)
• Last Synced: 2024-10-29T22:31:05.302Z (about 1 month ago)
• Language: JavaScript
• Homepage:
• Size: 2.94 MB
• Stars: 8,292
• Watchers: 95
• Forks: 960
• Open Issues: 124
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome - remix-run/history - Manage session history with JavaScript (JavaScript)
• awesome-github-star - history - run | 8197 | (JavaScript)
• awesome-list - history - run | 7109 | (JavaScript)

README

        
# history · [![npm package][npm-badge]][npm]

[npm-badge]: https://img.shields.io/npm/v/history.svg?style=flat-square

[npm]: https://www.npmjs.org/package/history

The history library lets you easily manage session history anywhere JavaScript runs. A `history` object abstracts away the differences in various environments and provides a minimal API that lets you manage the history stack, navigate, and persist state between sessions.

## Documentation

Documentation for version 5 can be found in the [docs](docs) directory. This is the current stable release. Version 5 is used in React Router version 6.

Documentation for version 4 can be found [on the v4 branch](https://github.com/remix-run/history/tree/v4/docs). Version 4 is used in React Router versions 4 and 5.

## Changes

To see the changes that were made in a given release, please lookup the tag on [the releases page](https://github.com/remix-run/history/releases).

For changes released in version 4.6.3 and earlier, please see [the `CHANGES.md` file](https://github.com/remix-run/history/blob/845d690c5576c7f55ecbe14babe0092e8e5bc2bb/CHANGES.md).

## Development

Development of the current stable release, version 5, happens on [the `main` branch](https://github.com/remix-run/history/tree/main). Please keep in mind that this branch may include some work that has not yet been published as part of an official release. However, since `main` is always stable, you should feel free to build your own working release straight from `main` at any time.

If you're interested in helping out, please read [our contributing guidelines](CONTRIBUTING.md).

## About

`history` is developed and maintained by [Remix](https://remix.run). If you're interested in learning more about what React can do for your company, please [get in touch](mailto:[email protected])!

## Thanks

A big thank-you to [BrowserStack](https://www.browserstack.com/) for providing the infrastructure that allows us to run our build in real browsers.

Also, thanks to [Dan Shaw](https://www.npmjs.com/~dshaw) for letting us use the `history` npm package name. Thanks, Dan!