barba.js is a small (4kb minified and gzipped), flexible and dependency free library that helps you creating fluid and smooth transitions between your website's pages.
It helps reducing the delay between your pages, minimizing browser HTTP requests and enhancing your user's web experience.
This is a fork from luruke's Barba.js. I added 2 missing features :
- Set HTML Classes automatically when the transition end
- Ability to set up dynamic container (to replace only portions of your page)
- Ability to define a custom class to prefetch specfics links
HTML classes will be updated automatically to reflect current namespace after the transition end. By default, the classes added by Barba.js are prefixed with 'page-'. This way you can easily set styles on navigation elements that are not removed/added after a transition ended.
<html dir="ltr" lang="en-US" class="page-work">You can now use Barba.js to only replace portions of your page inside your main container. See a practical example below :
<div data-pjax-wrapper="pjax">
<div data-pjax-container="pjax" data-namespace="work">
<button type="button" data-url="/work/filter/chronological">Chronological</button>
<button type="button" data-url="/work/filter/abc">Alphabetical</button>
<div data-pjax-wrapper="pjaxFilter">
<div data-pjax-container="pjaxFilter" data-namespace="work">
Content filtered goes here
</div>
</div>
</div>
</div>// DOM settings
Barba.Pjax.Dom.wrapperId = "pjax";
Barba.Pjax.Dom.wrapperDefaultId = Barba.Pjax.Dom.wrapperId;
Barba.Pjax.Dom.wrapperAttr = "data-pjax-wrapper";
Barba.Pjax.Dom.containerAttr = "data-pjax-container";button.addEventListener('click', function() {
Barba.Pjax.goTo(button.getAttribute("data-url"), {
type: "pjaxFilter"
});
}, false);Clicking the buttons will only update the #pjaxFilter container : pjaxFilter__container.
Please note that if #pjaxFilter is not found it will fallback on wrapperDefaultId (#pjax).
Because Barba.js need a wrapper and a container (so you can do a transition), when setting the type parameter, the script assume that the container is set up this way : ${containerAttr}='${wrapperId}'.
You can now define a class to prefetch only specific links. By default, Barba.js prefetch all links without ignoreClassLink.
Barba.Prefetch.prefetchClass = 'pjax-prefetch';
Barba.Prefetch.init();
Barba.js uses PJAX (aka push state ajax) to enhance the user's experience.
This technique consist in preventing the normal link behavior, changing manually the browser url, and injecting manually the new content in the page. In this way there will be no browser "hard refresh".
Here is a walkthrough of what happens when the user clicks a link:
- Check if the link is valid and eligible for PJAX, if yes, prevent the normal browser behavior.
- Change the URL using Push State API.
- Start fetching the new page via
XMLHttpRequest. - Create a new transition instance.
- As soon the new page is loaded, barba.js parses the new HTML (taking
.barba-container) and puts the new content on the DOM inside#barba-wrapper. - The transition instance will take care to hide the old container and show the new one.
- As soon the transition is finished, the old container is removed from the DOM.
Please note, on server side, your pages will need to be served normally.
Barba.js works as ehnancement for your website, everything should work normally without Javascript.
In order to have a better understanding on how Barba.js works I suggest you to read this article I wrote for Smashing Magazine.
Using this technique will bring numerous benefits:
- Possibility to create nice transition between pages enhancing the user's experience.
- Reduce HTTP requests. (why reload the css/js at each page change?)
- Possibility to speed up the navigation using prefetch and cache.
barba.js supports AMD, CommonJS and Browser global (using UMD).
You can install it using npm:
npm install barba.js --save-dev
or just including the script in your page:
<script src="barba.min.js" type="text/javascript"></script>or you can use cdnjs:
<script src="https://cdnjs.cloudflare.com/ajax/libs/barba.js/1.0.0/barba.min.js" type="text/javascript"></script>barba.js needs to know a little bit about your DOM structure. By default uses this markup structure in your pages:
<div id="barba-wrapper">
<div class="barba-container">
...Put here the content you wish to change between pages...
</div>
</div>Please note, all the selector (#barba-wrapper, .barba-container) are easily editable, see the API section.
After you've included barba.js in your project it's time to initialize it
// Please note, the DOM should be ready
Barba.Pjax.start();Barba.js is created in the spare time by Luigi De Rosa and released under MIT licence.
Any help on the project is more than welcomed.
For any problem/question do not hesitate to open an issue.
For any other information, please visit the website