history

Because the prior 5.0.2 release removed the State type parameter from Location, this was technically a breaking change. To correct for this, I'm bumping this as a minor release. It won't affect runtime code, but it may affect your development experience and tests if you were using that parameter.

The State type export is also restored, so you shouldn't have issues with installing React Router v6.

Oh, by the way, did you hear we released React Router v6?

Full Changelog: https://github.com/remix-run/history/compare/v5.0.3...v5.1.0

Fixed parsePath adding incorrectly adding search

Just a couple fixes:

• Fixed search params persisting on redirects
• Changed the location.state type to any and removed the generic on Location

Full Changelog: https://github.com/remix-run/history/compare/v5.0.1...v5.0.2

This patch release contains a tiny TypeScript update to use the built-in Partial utility for PartialPath and PartialLocation. We always love it when we can ship just a little less code!

🙏 Credits

Thanks to @liuhanqu, @hanquliu, @chaance and @mjackson for your contributions!

Today we are very pleased to announce the stable release of history version 5!

Overview

This version includes many enhancements and fixes a few important issues with the library.

New Features

• Hash history now has support for location.state
• Better history.block API, with support for retrying transitions
• Full TypeScript declarations and IntelliSense docs
• Adds development and production builds for <script type=module> users
• Both browser and hash history have support for iframes (custom window objects)
• About 50% smaller than v4 (and no dependencies)

Bugfixes

• Fixed some long-standing encoding issues with location.pathname
• Removed unfixable warnings about pushing the same path in hash history
• Renamed browser global to HistoryLibrary so it doesn't conflict with window.History

Breaking Changes

• Removed support for browsers that do not support the HTML5 history API (no pushState)
• Removed relative pathname support in hash history and memory history
• Removed getUserConfirmation, keyLength, and hashType APIs

Usage

Please refer to our installation guide for instructions about how to install the library.

There is also a getting started guide as well as a complete API reference in the docs folder.

We are very excited about this release, especially because it will serve as the foundation for the upcoming release of React Router version 6.

Thank you for your support. Enjoy! 😀

You can track v5 beta progress in #751

You can install the v5 beta using the next tag: npm add history@next

Changes

In this release the core library was converted to TypeScript, and the type declaration files that are published with the npm package are derived from the source instead of being written by hand. This should make them both more accurate and more useful.

A migration guide will be available soon. For now, you can either browse around the docs on the dev branch or the tests.

Enjoy!

You can track v5 beta progress in #751

You can install the v5 beta using the next tag: npm add history@next

Changes from 5.0.0-beta.4:

The main feature of this release is we've added some official TypeScript types, so you don't have to use @types/history anymore in v5! Instead, just use our built-in types.

The only other thing in this release is a small change to some of the environment-specific bundles. We've removed the history/memory bundle and also removed the createHistory methods from the history/browser and history/hash bundles. history/browser and history/hash still export singletons. Instead of history/memory, just use the createMemoryHistory function from the main bundle.

A migration guide will be available soon. For now, you can either browse around the docs on the dev branch or the tests.

Enjoy!

You can track v5 beta progress in #751

You can install the v5 beta using the next tag: npm add history@next

Improvements from v5.0.0-beta.3:

• Export parsePath and createPath helper functions for dealing with paths
• Allow passing a string value to history.createHref
• Warn (instead of throw) in dev

A migration guide will be available soon. For now, you can either browse around the docs on the dev branch or the tests.

Enjoy!

You can track v5 beta progress in #751

You can install the v5 beta using the next tag: npm add history@next

Improvements from v5.0.0-beta.2:

• Added dev and prod builds for <script type=module> users

Now you can:

<script type="module">
import { createBrowserHistory } from 'https://unpkg.com/history@next/history.production.min.js';

let history = createBrowserHistory();

// And away you go!
</script>

A migration guide will be available soon. For now, you can either browse around the docs on the dev branch or the tests.

Enjoy!

You can track v5 beta progress in #751

You can install the v5 beta using the next tag: npm add history@next

Improvements from v5.0.0-beta.1:

• Individual bundles for each type of history: history/browser, history/hash, and history/memory
• Added singletons for browser and hash history
• Fixed some accidentally munged variable names in the production build

The singleton instances for browser and hash history are very convenient:

import history from 'history/browser';

// And away you go!

Unless we find any major bugs in this release, it will probably be the last beta before v5 final.

A migration guide will be available soon. For now, you can either browse around the docs on the dev branch or the tests.

Enjoy!

You can track v5 beta progress in #751

You can install the v5 beta using the next tag: npm add history@next

Improvements on v5.0.0-beta.0:

• Now using Closure Compiler which results in slightly smaller and faster builds
• New global UMD name window.HistoryLibrary does not conflict with window.History
• Adds sourcemaps

A migration guide will be available soon. For now, you can either browse around the docs on the dev branch or the tests.

Enjoy!

You can track v5 beta progress in #751

You can install the v5 beta using the next tag: npm add history@next

Lots of updates in this release! Here's a quick summary:

New features:

• Remove legacy browser support (pre pushState)
• Add state to hash history
• Use custom window when creating history objects
• Better history.block API w/ tx.retry for retrying transitions
• Fix location.pathname encoding issues
• About 50% smaller
• No dependencies

Removed features:

• Removes basename support
• Removes relative pathname support in hash + memory histories
• Removes getUserConfirmation
• Removes keyLength
• Removes hashType

A migration guide will be available soon. For now, you can either browse around the docs on the dev branch or the tests.

Enjoy!

• Fixes some issues with using hash history on a page with a <base> tag (#577, #578)

• Allows basename URL prefixes with special regex characters (#566, #544)

The main change in this release is pre-bundled single-file builds for both development and production environments. This is not a breaking change, since we still support old-style require('history/createBrowserHistory') statements for now. However, these are deprecated in favor of importing/requireing from the main module.

Please see the release notes for 4.98.0-beta.0 for more info.

In 4.8.0 we will ship a single bundle for each module format (CJS, ESM, and UMD) using Rollup.

In this release we are deprecating support for

import createHistory from "history/createMemoryHistory";
// and
var createHistory = require('history/createMemoryHistory');

Instead, use:

import { createMemoryHistory as createHistory } from "history";
// and
var createHistory = require("history").createMemoryHistory;

together with a bundler that supports tree-shaking (Rollup or webpack 4 in production mode) to get your bundle sizes down.

Fixes

• Smaller builds, thanks to @TrySound (see #632 and #634)