DEV Community

Cover image for Bootstrap 5 Scrollbar
Keep Coding
Keep Coding

Posted on

Bootstrap 5 Scrollbar

What is Bootstrap Scrollbar?

Scrollbar method which allows you to create a custom scrollbar.


Installation

Manual installation (zip package)

To take advantage of our Bootstrap images component and use them in your project, 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 
Enter fullscreen mode Exit fullscreen mode
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 
Enter fullscreen mode Exit fullscreen mode
Importing CSS file

To import MDB stylesheet please use the following syntax:

@import '~mdb-ui-kit/css/mdb.min.css'; 
Enter fullscreen mode Exit fullscreen mode
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"
/>
Enter fullscreen mode Exit fullscreen mode
JS
<!-- MDB -->
<script
  type="text/javascript"
  src="https://cdnjs.cloudflare.com/ajax/libs/mdb-ui-kit/3.3.0/mdb.min.js"
></script>
Enter fullscreen mode Exit fullscreen mode

Customization

Basic example

Scrollbar is initialized automatically when you add data-mdb-perfect-scrollbar='true' attribute to your container.

HTML
<div data-mdb-perfect-scrollbar="true" style="position: relative; width: 600px; height: 400px">
  <img src="https://mdbootstrap.com/img/new/slides/041.jpg" alt="..."
    style="height: 700px; width: 1000px" />
</div>
Enter fullscreen mode Exit fullscreen mode

Options (JavaScript init)

You can easily init scrollbar with JavaScript. You have to invoke mdb.PerfectScrollbar() and include options with in that.

HTML
<div id="init-by-js" style="position: relative; width: 600px; height: 400px;">
  <img src="https://mdbootstrap.com/img/new/slides/041.jpg" alt="..."
    style="height: 700px; width: 1000px;" />
</div>
Enter fullscreen mode Exit fullscreen mode
JS
const initByJS = document.querySelector('#init-by-js');
const psInitbyJS = new mdb.PerfectScrollbar(initByJS);
Enter fullscreen mode Exit fullscreen mode

You can see more customization examples on the ๐Ÿ“„ Scrollbar documentation page


Crucial Resources

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

  1. Read ๐Ÿ“„ Scrollbar documentation page <-- start here
  2. In to get the most out of your project, you should also get acquainted with other Methods options related to Scrollbar. See the section below to find the list of them.
  3. You can use Methods 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 Methods options & features


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
GitHub Stars

Top comments (0)