Bootstrap 5 API
Tags: bootstrap, javascript, webdev, html
Published: 2021-07-19 08:07:37

## What are Bootstrap API?

The utility API is a Sass-based tool to generate utility classes.

______

## 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](https://mdbootstrap.com/docs/standard/getting-started/installation/#section-manual-installation)

_______

#### MDB CLI

Watch our [**Quick Start Tutorial**](https://mdbootstrap.com/docs/standard/getting-started/quick-start/) 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)](https://nodejs.org/en/).

###### Installation

To install MDB UI KIT in your project easily type the following command in the terminal:
```terminal
npm i mdb-ui-kit 
```

###### Importing JS modules

You can import the entire library or just individual modules:
```terminal
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:
```terminal
@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](https://github.com/mdbootstrap/mdb-webpack-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](https://cdnjs.com/libraries/mdb-ui-kit) to the application.

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

###### CSS

```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

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


______
## Customization

##### Basic example

###### API explained

All utility variables are added to the `$utilities` variable within our `_utilities.scss` stylesheet. Each group of utilities looks something like this:

###### SCSS

```scss
$utilities: (
  "opacity": (
    property: opacity,
    values: (
      0: 0,
      25: .25,
      50: .5,
      75: .75,
      100: 1,
    )
  )
);
```
Which outputs the following:

###### CSS
```css
.opacity-0 { opacity: 0; }
.opacity-25 { opacity: .25; }
.opacity-50 { opacity: .50; }
.opacity-75 { opacity: .75; }
.opacity-100 { opacity: 1; }
```

________ 

###### Custom class prefix

Use the `class` option to change the class prefix used in the compiled CSS:

###### SCSS
```scss
$utilities: (
  "opacity": (
    property: opacity,
    class: o,
    values: (
      0: 0,
      25: .25,
      50: .5,
      75: .75,
      100: 1,
    )
  )
 );
```
Output:

###### CSS
```css
.o-0 { opacity: 0; }
.o-25 { opacity: .25; }
.o-50 { opacity: .50; }
.o-75 { opacity: .75; }
.o-100 { opacity: 1; }
```





#### You can see more customization examples on the [📄 API documentation page](https://mdbootstrap.com/docs/standard/utilities/api/)

______

## Crucial Resources

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

1. Read  [📄 API documentation page](https://mdbootstrap.com/docs/standard/utilities/api/) <-- start here
2. In to get the most out of your project, you should also get acquainted with other Utilities options related to API. See the section below to find the list of them.
3. You can use Utilities in [📥 Starter Bootstrap 5 templates](https://mdbootstrap.com/freebies/)
4. Templates are a part of [📦 Free UI Kit for Bootstrap 5](https://mdbootstrap.com/docs/standard/)
5. After finishing the project you can publish it with CLI in order to receive [💽 Free hosting (beta)](https://mdbootstrap.com/docs/standard/cli/)

-----

## Related Utilities options & features

- [Borders](https://mdbootstrap.com/docs/standard/utilities/borders/)
- [Clearfix](https://mdbootstrap.com/docs/standard/utilities/clearfix/)
- [Close button](https://mdbootstrap.com/docs/standard/utilities/close-button/)
- [Embeds](https://mdbootstrap.com/docs/standard/utilities/embeds/)
- [Interactions](https://mdbootstrap.com/docs/standard/utilities/interactions/)
- [Overflow](https://mdbootstrap.com/docs/standard/utilities/overflow/)
- [Position](https://mdbootstrap.com/docs/standard/utilities/position/)
- [Screen readers](https://mdbootstrap.com/docs/standard/utilities/screen-readers/)
- [Sizing](https://mdbootstrap.com/docs/standard/utilities/sizing/)
- [Spacing](https://mdbootstrap.com/docs/standard/utilities/spacing/)
- [Stretched link](https://mdbootstrap.com/docs/standard/utilities/stretched-link/)
- [Text](https://mdbootstrap.com/docs/standard/utilities/text/)
- [Text truncation](https://mdbootstrap.com/docs/standard/utilities/text-truncation/)
- [Visibility](https://mdbootstrap.com/docs/standard/utilities/visibility/)


-----

## Learn Bootstrap 5 in 1.5H

{% youtube c9B4TPnak1A %}

-----

## Additional resources

Learn web development with our **learning roadmap**:
**[:mortar_board: Start Learning](https://mdbootstrap.com/docs/standard/getting-started/)**

Join our mailing list & receive **exclusive resources** for developers
**[:gift: Get gifts](https://mdbootstrap.com/newsletter/)**

Join our private FB group for **inspiration & community experience**
**[👨‍👩‍👧‍👦 Ask to join](https://www.facebook.com/groups/682245759188413)**

**Support creation of open-source packages** with a STAR on GitHub
[![GitHub Stars](https://img.shields.io/github/stars/mdbootstrap/mdb-ui-kit?label=Star%20now&style=social)](https://github.com/mdbootstrap/mdb-ui-kit/)