pucka / history

A minimal, functional history library for JavaScript

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

build status npm package react-router channel on slack

history

history is a JavaScript library that lets you easily manage session history in browsers, testing environments, and (soon, via React Native) native devices. history abstracts away the differences in these different platforms and provides a minimal API that lets you manage the history stack, navigate, confirm navigation, and persist state between sessions. history is library-agnostic and may easily be included in any JavaScript project.

Installation

$ npm install history

Basic Usage

A "history" encapsulates navigation between different screens in your app, and notifies listeners when the current screen changes.

import { createHistory } from 'history'

let history = createHistory()

// Listen for changes to the current location. The
// listener is called once immediately.
let unlisten = history.listen(function (location) {
  console.log(location.pathname)
})

history.pushState({ the: 'state' }, '/the/path?a=query')

// When you're finished, stop the listener.
unlisten()

Read more about getting started in the documentation!

Thanks

A big thank-you to Dan Shaw for letting us use the history npm package name! Thanks Dan!

Also, thanks to BrowserStack for providing the infrastructure that allows us to run our build in real browsers.

About

A minimal, functional history library for JavaScript

License:MIT License


Languages

Language:JavaScript 96.2%Language:HTML 2.0%Language:Shell 1.8%