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

    verlauf
    TypeScript icon, indicating that this package has built-in type declarations

    0.9.1 • Public • Published

    CI Build npm bundle size npm bundle size

    Verlauf

    Is a reimplementation of history version 4, aiming to keep compatibility while still offering new features and bugfixes that can't be added to history@4 without breaking semantic versioning.

    Major differences:

    • Modular. You can implement your own middleware to interface with the browser history.
    • Removed URL encoding and decoding, though you can work around that, if you need to.
    • You can implement your own transition blocking logic.
    • Single file bundling. Meaning you can't import verlauf/createBrowserHistory.

    A complete overview of the differences can be found here, including all quirks.

    Complete documentation here

    Roadmap:

    1.0:

    • [ ] Backport bugfixes that were made in history@5, as compatability allows
      • [ ] Correctly parse and utilize <base/> tag in hashHistoryAdapter
    • [ ] Final pass over names and calling conventions of Verlauf specific APIs
    • [ ] Ensure compatibility:
      • [x] pass react-router test suite
      • [ ] Test behavior in demos and test applications.

    Future:

    • [ ] Replace the code borrowed for unit tests.
    • [ ] Make preserveSearch = true the default.

    Name

    "Verlauf" is the german term for browser history.

    License

    Verlauf is licensed under the MIT license.

    The unit tests for createLocation were taken from the history v4 branch and amended. Original copyright: History contributors.

    A helper function in basenameUtils (escapeRegex) was taken from the MDN and is licensed under the CC0.

    Install

    npm i verlauf

    DownloadsWeekly Downloads

    0

    Version

    0.9.1

    License

    MIT

    Unpacked Size

    49.2 kB

    Total Files

    9

    Last publish

    Collaborators

    • avatar