https://github.com/Easyfood/pageAccelerator

A very light solution to load web pages faster
https://github.com/Easyfood/pageAccelerator

front-end javascript performace

Last synced: about 1 month ago
JSON representation

A very light solution to load web pages faster

• Host: GitHub
• URL: https://github.com/Easyfood/pageAccelerator
• Owner: EvandroLG
• License: mit
• Created: 2016-09-09T16:03:36.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2017-05-02T13:27:17.000Z (over 7 years ago)
• Last Synced: 2024-05-10T10:05:43.112Z (4 months ago)
• Topics: front-end, javascript, performace
• Language: JavaScript
• Homepage:
• Size: 41 KB
• Stars: 1,204
• Watchers: 39
• Forks: 54
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# pageAccelerator

[![Build

Status](https://travis-ci.org/Easyfood/pageAccelerator.svg?branch=master)](https://travis-ci.org/Easyfood/pageAccelerator)

[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/evandrolg/pageAccelerator?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

[![CDNJS](https://img.shields.io/cdnjs/v/page-accelerator.svg)](https://cdnjs.com/libraries/page-accelerator)

A very light solution to load web pages faster.

## Browser Support

- Google Chrome 5.0+

- Firefox 4.0+

- Edge 14+

- Opera 11.5+

- Safari 5.0+

** For IE10+ you need to use some [polyfill](https://cdnjs.cloudflare.com/polyfill/) to add support for Promises.

# 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](https://github.com/turbolinks/turbolinks) and [pjax](https://github.com/defunkt/jquery-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:

```shell

  npm install page-accelerator --save

```

or

```shell

  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:

```html

  

```

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

```js

  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](https://github.com/EasyFood/pageAccelerator/graphs/contributors).

## Author

|[![@evandrolg](https://avatars3.githubusercontent.com/u/444054?v=3&s=96)](https://github.com/evandrolg)|

|:---:|

|[@evandrolg](http://www.github.com/evandrolg)|