Miss any of our Open RFC calls?Watch the recordings here! »

history-state

2.0.0 • Public • Published

history-state

history-state allows you to monitor and make changes to a page’s history state.

Browser support

Install

$ npm install history-state

API

By default, the mechanisms used are history.pushState and window.onpopstate, with older browsers falling back to location.hash and window.onhashchange. This behaviour can be overridden by passing the constructor an options object, detailed below.

var state = require('history-state')({
  // Use only location.hash/onhashchange…
  hash: true,
  // …or use only history.pushState/onpopstate.
  pushState: true
})
 
state.change('/some-path')
 
state.on('change', function() {
  console.log(location.pathname)
  > '/some-path'
})
 
// Toggle the window listeners.
state.stop()
state.start()

License

MIT

Install

npm i history-state

DownloadsWeekly Downloads

73

Version

2.0.0

License

MIT

Last publish

Collaborators

  • avatar