2017-05-26 06:01:07 +02:00
---
layout: docs
2019-04-11 16:50:06 +02:00
title: Webpack and bundlers
description: Learn how to include Bootstrap in your project using Webpack or other bundlers.
2017-05-26 06:01:07 +02:00
group: getting-started
2017-05-28 07:03:48 +02:00
toc: true
2017-05-26 06:01:07 +02:00
---
## Installing Bootstrap
2019-02-04 11:22:02 +01:00
[Install bootstrap ]({{< docsref "/getting-started/download#npm" >}} ) as a Node.js module using npm.
2017-05-26 06:01:07 +02:00
## Importing JavaScript
2019-02-04 11:22:02 +01:00
Import [Bootstrap's JavaScript ]({{< docsref "/getting-started/javascript" >}} ) by adding this line to your app's entry point (usually `index.js` or `app.js` ):
2017-05-26 06:01:07 +02:00
2022-04-26 18:38:41 +02:00
<!-- eslint - skip -->
2020-10-19 11:56:49 +02:00
```js
2021-08-30 14:36:53 +02:00
import 'bootstrap';
// or get all of the named exports for further usage
import * as bootstrap from 'bootstrap';
2020-10-19 11:56:49 +02:00
```
2017-05-26 06:01:07 +02:00
2019-04-11 16:50:06 +02:00
Alternatively, if you only need just a few of our plugins, you may **import plugins individually** as needed:
2017-05-26 06:01:07 +02:00
2022-04-26 18:38:41 +02:00
<!-- eslint - skip -->
2020-10-19 11:56:49 +02:00
```js
2019-04-11 16:50:06 +02:00
import Alert from 'bootstrap/js/dist/alert';
2021-08-30 14:36:53 +02:00
// or, specify which plugins you need:
import { Tooltip, Toast, Popover } from 'bootstrap';
2020-10-19 11:56:49 +02:00
```
2017-05-26 06:01:07 +02:00
2019-07-20 11:53:02 +02:00
Bootstrap depends on [Popper ](https://popper.js.org/ ), which is specified in the `peerDependencies` property.
2020-06-19 10:17:01 +02:00
This means that you will have to make sure to add it to your `package.json` using `npm install @popperjs/core` .
2017-05-26 06:01:07 +02:00
## Importing Styles
2017-08-11 17:50:03 +02:00
### Importing Precompiled Sass
2017-05-26 06:01:07 +02:00
2017-05-28 07:03:48 +02:00
To enjoy the full potential of Bootstrap and customize it to your needs, use the source files as a part of your project's bundling process.
2017-05-26 06:01:07 +02:00
2020-04-14 02:55:33 +02:00
First, create your own `_custom.scss` and use it to override the [built-in custom variables ]({{< docsref "/customize/sass" >}} ). Then, use your main Sass file to import your custom variables, followed by Bootstrap:
2017-10-30 22:53:57 +01:00
2020-10-19 11:56:49 +02:00
```scss
2017-05-26 06:01:07 +02:00
@import "custom";
@import "~bootstrap/scss/bootstrap";
2020-10-19 11:56:49 +02:00
```
2017-05-26 06:01:07 +02:00
2020-09-17 19:01:04 +02:00
For Bootstrap to compile, make sure you install and use the required loaders: [sass-loader ](https://github.com/webpack-contrib/sass-loader ), [postcss-loader ](https://github.com/webpack-contrib/postcss-loader ) with [Autoprefixer ](https://github.com/postcss/autoprefixer#webpack ). With minimal setup, your webpack config should include this rule or similar:
2017-05-28 07:03:48 +02:00
2022-04-26 18:38:41 +02:00
<!-- eslint - skip -->
2020-10-19 11:56:49 +02:00
```js
2020-09-18 13:53:44 +02:00
// ...
2018-10-20 21:59:27 +02:00
{
test: /\.(scss)$/,
use: [{
2020-09-18 13:53:44 +02:00
// inject CSS to page
loader: 'style-loader'
2018-10-20 21:59:27 +02:00
}, {
2020-09-18 13:53:44 +02:00
// translates CSS into CommonJS modules
loader: 'css-loader'
2018-10-20 21:59:27 +02:00
}, {
2020-09-18 13:53:44 +02:00
// Run postcss actions
loader: 'postcss-loader',
2018-10-20 21:59:27 +02:00
options: {
2020-09-18 13:53:44 +02:00
// `postcssOptions` is needed for postcss 8.x;
// if you use postcss 7.x skip the key
2020-09-16 12:01:31 +02:00
postcssOptions: {
2020-09-18 13:53:44 +02:00
// postcss plugins, can be exported to postcss.config.js
2022-04-26 18:38:41 +02:00
plugins: () => {
[
2020-09-16 12:01:31 +02:00
require('autoprefixer')
];
}
2017-05-26 06:01:07 +02:00
}
2018-10-20 21:59:27 +02:00
}
}, {
2020-09-18 13:53:44 +02:00
// compiles Sass to CSS
loader: 'sass-loader'
2018-10-20 21:59:27 +02:00
}]
2020-09-18 13:53:44 +02:00
}
// ...
2020-10-19 11:56:49 +02:00
```
2017-05-26 06:01:07 +02:00
### Importing Compiled CSS
2018-03-07 22:53:39 +01:00
Alternatively, you may use Bootstrap's ready-to-use CSS by simply adding this line to your project's entry point:
2017-05-26 06:01:07 +02:00
2022-04-26 18:38:41 +02:00
<!-- eslint - skip -->
2020-10-19 11:56:49 +02:00
```js
2017-05-26 06:01:07 +02:00
import 'bootstrap/dist/css/bootstrap.min.css';
2020-10-19 11:56:49 +02:00
```
2017-05-26 06:01:07 +02:00
2018-03-07 22:53:39 +01:00
In this case you may use your existing rule for `css` without any special modifications to webpack config, except you don't need `sass-loader` just [style-loader ](https://github.com/webpack-contrib/style-loader ) and [css-loader ](https://github.com/webpack-contrib/css-loader ).
2017-11-03 12:53:24 +01:00
2020-10-19 11:56:49 +02:00
```js
2020-09-18 13:53:44 +02:00
// ...
2018-10-20 21:59:27 +02:00
module: {
rules: [
{
test: /\.css$/,
2020-09-18 13:53:44 +02:00
use: [
'style-loader',
'css-loader'
]
2018-10-20 21:59:27 +02:00
}
]
}
2020-09-18 13:53:44 +02:00
// ...
2020-10-19 11:56:49 +02:00
```