Bootstrap 5 Animations

What are Bootstrap Animations?

Bootstrap subtle and smooth MDB animations provide the user with a unique experience when interacting with UI. There are several dozen animations at your disposal along with many customization and implementation options

---

Installation

Manual installation (zip package)

To use this component, you first need to install the MDB 5 Free package

---

MDB CLI

Watch our Quick Start Tutorial to discover and use the full potential of MDB 5 and MDB CLI

---

NPM

Prerequisites

Before starting the project make sure to install Node LTS (12.x.x recommended).

Installation

To install MDB UI KIT in your project easily type the following command in the terminal:

npm i mdb-ui-kit 

Importing JS modules

You can import the entire library or just individual modules:

import * as mdb from 'mdb-ui-kit'; // lib
import { Input } from 'mdb-ui-kit'; // module 

Importing CSS file

To import MDB stylesheet please use the following syntax:

@import '~mdb-ui-kit/css/mdb.min.css'; 

Importing SCSS modules

You can also import individual SCSS modules. To do it properly, we recommend to copy them from the node_modules/mdb-ui-kit/src/scss location directly to your project and import in the same way as CSS files.

Webpack integration

You can significantly speed up the process of creating a new project based on Webpack using our Starter.

---

CDN

Installation via CDN is one of the easiest methods of integrating MDB UI KIT with your project. Just copy the latest compiled JS script tag and CSS link tag from cdnjs to the application.

Don't forget to add also Font Awesome and Roboto font if you need. Here's an example code:

CSS

<!-- Font Awesome -->
<link
  href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.1/css/all.min.css"
  rel="stylesheet"
/>
<!-- Google Fonts -->
<link
  href="https://fonts.googleapis.com/css?family=Roboto:300,400,500,700&display=swap"
  rel="stylesheet"
/>
<!-- MDB -->
<link
  href="https://cdnjs.cloudflare.com/ajax/libs/mdb-ui-kit/3.3.0/mdb.min.css"
  rel="stylesheet"
/>

JS

<!-- MDB -->
<script
  type="text/javascript"
  src="https://cdnjs.cloudflare.com/ajax/libs/mdb-ui-kit/3.3.0/mdb.min.js"
></script>

---

Getting started

The easiest way to implement the animation is to use data-mdb-attributes. In the example below, we use the icon <i class="fas fa-car-side fa-3x"></i> and add the attributes data-mdb-toggle="animation" data-mdb-animation-reset="true" data-mdb-animation="slide-out-right" to give it animation on click.

data-mdb-toggle="animation" is an obligatory attribute for each animation.

data-mdb-animation-reset="true" lets you decide if the animation can be repeated

data-mdb-animation="slide-right" lets you specify which animation apply to the element. In the demo section you can find available animations.

<i
  data-mdb-toggle="animation"
  data-mdb-animation-reset="true"
  data-mdb-animation="slide-right"
  class="fas fa-car-side fa-3x"
></i>

---

Api

Usage

Via CSS class

<i class="fas fa-car-side fa-3x animation slide-out-right"></i>

Via data attributes

<i
  data-mdb-toggle="animation"
  data-mdb-animation="tada"
  data-mdb-animation-start="onLoad"
  class="fas fa-star fa-3x"
></i>

You can see more usage examples on the 📄 Animations API page

---

Customization

On hover

Use data-mdb-animation-start="onHover" to launch the animation on mouse hover.

<i
  data-mdb-toggle="animation"
  data-mdb-animation-start="onHover"
  data-mdb-animation-reset="true"
  data-mdb-animation="slide-right"
  class="fas fa-car-side fa-3x"
></i>

Repeat animation on scroll

If you want to launch the animation every time it's reached when scrolling use data-mdb-animation-on-scroll="repeat".

<i
  data-mdb-toggle="animation"
  data-mdb-animation-start="onScroll"
  data-mdb-animation-on-scroll="repeat"
  data-mdb-animation="slide-in-left"
  class="fas fa-car-side fa-3x"
></i>

Show on load

If you use animation onScroll, by default all elements are visible when the page is loaded. They disappear and begin to animate after the first scroll. You can change this by setting data-mdb-animation-show-on-load="false". However, remember that this may have a negative impact on SEO.

<i
  data-mdb-toggle="animation"
  data-mdb-animation-start="onScroll"
  data-mdb-animation-on-scroll="repeat"
  data-mdb-animation="slide-in-left"
  class="fas fa-car-side fa-3x"
></i>

You can see more customization examples on the 📄 Animations documentation page

---

Crucial Resources

Here are the resources that we have prepared to help you work with this component:

1. Read 📄 Animations tutorial & documentation <-- start here
2. In to get the most out of your project, you should also get acquainted with other Content & style options related to animations. See the section below to find the list of them.
3. You can use predesigned Content & style elements in 📥 Starter Bootstrap 5 templates
4. Templates are a part of 📦 Free UI Kit for Bootstrap 5
5. After finishing the project you can publish it with CLI in order to receive 💽 Free hosting (beta)

---

Related Content and Styles options & features

• Theme
• Background Image
• Colors
• Figures
• Flags
• Hover effects
• Icons
• Images
• Masks
• Shadows
• Typography

---

Learn Bootstrap 5 in 1.5H

---

Additional resources

Learn web development with our learning roadmap:
🎓 Start Learning

Join our mailing list & receive exclusive resources for developers
🎁 Get gifts

Join our private FB group for inspiration & community experience
👨‍👩‍👧‍👦 Ask to join

Support creation of open-source packages with a STAR on GitHub