mirror of
https://github.com/twbs/bootstrap.git
synced 2025-01-09 02:46:15 +01:00
b46f05a948
This commit includes all the needed workarounds and most changes from the main branch for everything to work, like: * removing empty lines in raw HTML that break output * read .browserslistrc, CSS variables from disk instead of duplicating it * using Hugo mounts * using Hugo for the docs CSS/JS * move ToC Sass code to a separate file while adapting it for Hugo Thus, this patch makes our npm scripts faster since lint runs on one step and there's no separate docs assets processing.
94 lines
2.8 KiB
Markdown
94 lines
2.8 KiB
Markdown
---
|
|
layout: docs
|
|
title: Webpack
|
|
description: Learn how to include Bootstrap in your project using Webpack.
|
|
group: getting-started
|
|
toc: true
|
|
---
|
|
|
|
## Installing Bootstrap
|
|
|
|
[Install bootstrap]({{< docsref "/getting-started/download#npm" >}}) as a Node.js module using npm.
|
|
|
|
## Importing JavaScript
|
|
|
|
Import [Bootstrap's JavaScript]({{< docsref "/getting-started/javascript" >}}) by adding this line to your app's entry point (usually `index.js` or `app.js`):
|
|
|
|
```js
|
|
import 'bootstrap';
|
|
```
|
|
|
|
Alternatively, you may **import plugins individually** as needed:
|
|
|
|
```js
|
|
import 'bootstrap/js/dist/util';
|
|
import 'bootstrap/js/dist/alert';
|
|
...
|
|
```
|
|
|
|
Bootstrap depends on [jQuery](https://jquery.com/) and [Popper](https://popper.js.org/),
|
|
which are specified in the `peerDependencies` property; this means that you will have to make sure to add both of them
|
|
to your `package.json` using `npm install --save jquery popper.js`.
|
|
|
|
## Importing Styles
|
|
|
|
### Importing Precompiled Sass
|
|
|
|
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.
|
|
|
|
First, create your own `_custom.scss` and use it to override the [built-in custom variables]({{< docsref "/getting-started/theming" >}}). Then, use your main Sass file to import your custom variables, followed by Bootstrap:
|
|
|
|
```scss
|
|
@import "custom";
|
|
@import "~bootstrap/scss/bootstrap";
|
|
```
|
|
|
|
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:
|
|
|
|
```js
|
|
...
|
|
{
|
|
test: /\.(scss)$/,
|
|
use: [{
|
|
loader: 'style-loader', // inject CSS to page
|
|
}, {
|
|
loader: 'css-loader', // translates CSS into CommonJS modules
|
|
}, {
|
|
loader: 'postcss-loader', // Run postcss actions
|
|
options: {
|
|
plugins: function () { // postcss plugins, can be exported to postcss.config.js
|
|
return [
|
|
require('autoprefixer')
|
|
];
|
|
}
|
|
}
|
|
}, {
|
|
loader: 'sass-loader' // compiles Sass to CSS
|
|
}]
|
|
},
|
|
...
|
|
```
|
|
|
|
### Importing Compiled CSS
|
|
|
|
Alternatively, you may use Bootstrap's ready-to-use CSS by simply adding this line to your project's entry point:
|
|
|
|
```js
|
|
import 'bootstrap/dist/css/bootstrap.min.css';
|
|
```
|
|
|
|
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).
|
|
|
|
```js
|
|
...
|
|
module: {
|
|
rules: [
|
|
{
|
|
test: /\.css$/,
|
|
use: ['style-loader', 'css-loader']
|
|
}
|
|
]
|
|
}
|
|
...
|
|
```
|