Wondering what’s next for npm?Check out our public roadmap! »

    historyv3

    3.3.0 • Public • Published

    history Travis npm package

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

    Docs & Help

    Installation

    Using npm:

    $ npm install --save history
    

    Then with a module bundler like webpack, use as you would anything else:

    // using an ES6 transpiler, like babel
    import { createHistory } from 'history'
    
    // not using an ES6 transpiler
    var createHistory = require('history').createHistory

    The UMD build is also available on unpkg:

    <script src="https://unpkg.com/history/umd/history.min.js"></script>

    You can find the library on window.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'
    
    const history = createHistory()
    
    // Get the current location
    const location = history.getCurrentLocation()
    
    // Listen for changes to the current location
    const unlisten = history.listen(location => {
      console.log(location.pathname)
    })
    
    // Push a new entry onto the history stack
    history.push({
      pathname: '/the/path',
      search: '?a=query',
    
      // Extra location-specific state may be kept in session
      // storage instead of in the URL query string!
      state: { the: 'state' }
    })
    
    // When you're finished, stop the listener
    unlisten()

    You can find many more examples 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.

    Install

    npm i historyv3

    DownloadsWeekly Downloads

    1

    Version

    3.3.0

    License

    MIT

    Unpacked Size

    158 kB

    Total Files

    25

    Last publish

    Collaborators

    • avatar