barba README

The project's README from github.com/barbajs/barba. As one markdown file: README.md.

barba.js – Stability CircleCI Coverage Status Commitizen friendly Conventional Commits lerna License All Contributors Slack workspace

Create badass, fluid and smooth transitions between your website’s pages.

barbajs

Intro

Barba.js — aka Barba — is a small (7kb minified and compressed) and easy-to-use library that helps you create fluid and smooth transitions between your website's pages. It makes your website run like a SPA (Single Page Application) and help reduce the delay between your pages, minimize browser HTTP requests and enhance your user's web experience.

Features

Barba is user friendly, smart, extensible and futureproof. The library provides a bunch of useful features that will make your website shine like any other website, ever!

Documentation

Here you will find the documentation describing how to use the library.

  1. Website - official Barba website
  2. User guide - how to install and use the plugin
  3. Lessons, courses and videos - for in-depth learning
  4. Showcase - selected works made with Barba
  5. Developer API - by developers, for developers

[!NOTE] This guide assumes intermediate knowledge of HTML, CSS, and JavaScript. It is worth mentioning that all code examples use ES6+ syntax. If you are not comfortable with this syntax, we would encourage you to grasp the basics then come back.

In case of emergency, check the "legacy" code example.

Sponsor

If you like this library and want to give some recognition, it is now possible to become a Github sponsor and support this project by sponsoring BarbaJS maintainer on Github. Even if it's a small contribution, you participate in the effort of making open source projects maintained for anyone, and developers to be rewarded for their work/time.

Contribute

If you want to report a bug or request a new feature/improvement, please read the project contributors guidelines before.

Thanks for taking time to contribute to Barba :tada: :+1:

Contributors

Luigi De Rosa
Luigi De Rosa

🤔 💻 📖 💬 🐛 ⚠️ 👀 🚇
Thierry Michel
Thierry Michel

🤔 💻 📖 💬 🐛 ⚠️ 👀 🚇
Xavier Foucrier
Xavier Foucrier

🤔 💻 📖 💬 ⚠️ 👀 🐛 🚇
Marco Grimaldi
Marco Grimaldi

🎨
Petr TIchy
Petr TIchy

📝 ✅ 📹
Cody Marcoux
Cody Marcoux

💬
Phil.
Phil.

💬
Giorgio Finulli
Giorgio Finulli

💬
Wouter
Wouter

🐛 💬
Mike Wagz
Mike Wagz

🤔 💬 ⚠️
Red Stapler
Red Stapler

✅ 📹
Jérémy Levron
Jérémy Levron

💬
Nguyen Van Anh
Nguyen Van Anh

💻
Daniel Weber
Daniel Weber

💻
Jean-Marie Porchet
Jean-Marie Porchet

💻
James
James

💻
Nicholas
Nicholas

💻
Patrick Arminio
Patrick Arminio

💻
A (from Sicily)
A (from Sicily)

💻
Pavel Mazhuga
Pavel Mazhuga

💬
Daniele De Matteo
Daniele De Matteo

💬
aswinkumar863
aswinkumar863

💬
BounceIncHQ
BounceIncHQ

💬
gordonwes
gordonwes

💬
Evan Fleet
Evan Fleet

💬 🐛
Jörg
Jörg

💡
ZAAK
ZAAK

💡 💬
Masahiro Tonomura
Masahiro Tonomura

💡
CassiusHR
CassiusHR

💬
Shane Murphy
Shane Murphy

💬
Dylan Reeves
Dylan Reeves

💬 💡
Quentin Neyraud
Quentin Neyraud

💬
tortilaman
tortilaman

💬
psntr
psntr

💬
Kevin Clark
Kevin Clark

💬
Tadeas Kosek
Tadeas Kosek

💬
Gustavo de Andrade
Gustavo de Andrade

💬
Clinton
Clinton

💬

barba (barbajs/barba)

single-page-app
Searching Database…

13K ·GitHub
What is this?Barba.js is a small JavaScript library that creates fluid, SPA-like page transitions between the pages of a regular website, reducing load delay and HTTP requests.
Is it a framework or just a small helper library?It's a lightweight library (7kb minified), not a full framework — you add it to an existing site to intercept navigation and animate page changes.
How do I add it to a website?Install it via your usual JS tooling and follow the official User guide, which covers installation and usage of the plugin.
Do I need anything beyond basic HTML/CSS/JS knowledge?You just need intermediate HTML, CSS, and JavaScript knowledge, including ES6+ syntax used throughout the examples.
Will it work in older browsers?Barba targets modern browsers with progressive enhancement; if you need ES6-incompatible support there's a separate legacy code example to fall back on.
Does it work on any website or just specific setups?It's framework-agnostic client-side JS meant to be dropped into any website's pages, giving custom markup, namespaces, and data-attribute schema flexibility.
Can I extend Barba with plugins?Yes, it ships with a plugin system and built-in utilities, letting you add functionality like prefetching pages for extra speed.
How does Barba decide which transition to play?It has a transition resolution system with rules that let Barba automatically pick the right transition for a given page change.
What is 'Sync mode'?Sync mode controls whether the leave and enter hooks of a transition should play together rather than sequentially.
Is Barba written in TypeScript?Yes, it has a simplified API written in TypeScript and works with Promises for handling transition lifecycles.
Creator
barbajs
Size
30.5 MB
Stars
13K
Age
10y
Commits · 90 Days