Have ideas to improve npm?Join in the discussion! »

    page-accelerator

    0.1.1 • Public • Published

    pageAccelerator

    BuildStatus Gitter

    A very light solution to load web pages faster.

    Browser Support

    Chrome Firefox IE Opera Safari
    5.0+ ✔ 4.0+ ✔ 10+ ✔ 11.5 ✔ 5.0+ ✔

    How does it work?

    It's an agnostic library that uses ajax and pushState to deliver a faster navigation experience. pageAccelerator is a very light version of turbolinks and pjax (our minfied file is just 2.2KB!). Basically what it does is follow every link in your application and each click it loads the page in background and replaces the content correctly, keeping the real datas from body and head, updating the title.

    Installation

    To install pageAccelerator, execute:

      npm install page-accelerator --save

    or

      bower install page-accelerator --save

    Or simply use the minified file from the dist/ directory.

    How to use?

    pageAccelerator doesn't depend on jQuery, Zepto or any other library to work. You need just to include it at the end of your HTML code:

      <script src="page-accelerator.min.js"></script> 

    Then you need to call the pageAccelerator function, such as the example bellow:

      pageAccelerator();

    Just call it and pageAccelerator was already following the web application links.

    For links that you don't want to be followed, you need simply add data-pageAccelerator="false".

    Parameters

    pageAccelerator can also receive an object as a parameter with the following options:

    • beforeLoading function: Will be called whenever a new page was requested by a click or the browser back
    • afterLoading function: Will be called whenever a new page has been loaded

    Team

    pageAccelerator was made with love by a bunch of awesome contributors.

    Author
    @evandrolg
    @evandrolg

    Install

    npm i page-accelerator

    DownloadsWeekly Downloads

    15

    Version

    0.1.1

    License

    MIT

    Last publish

    Collaborators

    • avatar