diff --git a/.cspell.json b/.cspell.json index f142e4a83425..efd3eb714ed2 100644 --- a/.cspell.json +++ b/.cspell.json @@ -62,6 +62,7 @@ "mediaqueries", "minifiers", "misfunction", + "mkdir", "monospace", "mouseleave", "navbars", diff --git a/site/assets/scss/_syntax.scss b/site/assets/scss/_syntax.scss index 487550bfd301..106032c0753e 100644 --- a/site/assets/scss/_syntax.scss +++ b/site/assets/scss/_syntax.scss @@ -100,7 +100,7 @@ .chroma { .language-bash, .language-sh { - &::before { + .line::before { color: #777; content: "$ "; user-select: none; diff --git a/site/content/docs/5.2/getting-started/webpack.md b/site/content/docs/5.2/getting-started/webpack.md index 3c6c8650410b..f9ccea51d5f8 100644 --- a/site/content/docs/5.2/getting-started/webpack.md +++ b/site/content/docs/5.2/getting-started/webpack.md @@ -1,112 +1,220 @@ --- layout: docs -title: Webpack and bundlers -description: Learn how to include Bootstrap in your project using Webpack or other bundlers. +title: "Bootstrap & Webpack" +description: The official guide for how to include and bundle Bootstrap's CSS and JavaScript in your project using Webpack. group: getting-started toc: true --- -## Installing Bootstrap +{{< callout >}} +**Want to skip to the end?** Download the source code and working demo for this guide from the [twbs/examples repository](https://github.com/twbs/examples/tree/main/webpack). You can also [open the example in StackBlitz](https://stackblitz.com/github/twbs/examples/tree/main/webpack?file=index.html) for live editing. +{{< /callout >}} -[Install bootstrap]({{< docsref "/getting-started/download#npm" >}}) as a Node.js module using npm. +## Setup -## Importing JavaScript +We're building a Webpack project with Bootstrap from scratch, so there are some prerequisites and up front steps before we can really get started. This guide requires you to have Node.js installed and some familiarity with the terminal. -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'; +1. **Create a project folder and setup npm.** We'll create the `my-project` folder and initialize npm with the `-y` argument to avoid it asking us all the interactive questions. -// or get all of the named exports for further usage -import * as bootstrap from 'bootstrap'; -``` + ```sh + mkdir my-project && cd my-project + npm init -y + ``` -Alternatively, if you only need just a few of our plugins, you may **import plugins individually** as needed: +2. **Install Webpack.** Next we need to install our Webpack development dependencies: `webpack` for the core of Webpack, `webpack-cli` so we can run Webpack commands from the terminal, and `webpack-dev-server` so we can run a local development server. We use `--save-dev` to signal that these dependencies are only for development use and not for production. - -```js -import Alert from 'bootstrap/js/dist/alert'; + ```sh + npm i --save-dev webpack webpack-cli webpack-dev-server + ``` -// or, specify which plugins you need: -import { Tooltip, Toast, Popover } from 'bootstrap'; -``` +3. **Install Bootstrap.** Now we can install Bootstrap. We'll also install Popper since our dropdowns, popovers, and tooltips depend on it for their positioning. If you don't plan on using those components, you can omit Popper here. -Bootstrap depends on [Popper](https://popper.js.org/), which is specified in the `peerDependencies` property. -This means that you will have to make sure to add it to your `package.json` using `npm install @popperjs/core`. + ```sh + npm i --save bootstrap @popperjs/core + ``` -## Importing Styles +4. **Install additional dependencies.** In addition to Webpack and Bootstrap, we need a few more dependencies to properly import and bundle Bootstrap's CSS and JS with Webpack. These include Sass, some loaders, and Autoprefixer. -### Importing Precompiled Sass + ```sh + npm i --save-dev autoprefixer css-loader export-loader postcss-loader sass sass-loader style-loader + ``` -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. +Now that we have all the necessary dependencies installed and setup, we can get to work creating the project files and importing Bootstrap. -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: +## Project structure -```scss -@import "custom"; -@import "~bootstrap/scss/bootstrap"; -``` +We've already created the `my-project` folder and initialized npm. Now we'll also create our `src` and `dist` folders to round out the project structure. Run the following from `my-project`, or manually create the folder and file structure shown below. -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: [{ - // inject CSS to page - loader: 'style-loader' - }, { - // translates CSS into CommonJS modules - loader: 'css-loader' - }, { - // Run postcss actions - loader: 'postcss-loader', - options: { - // `postcssOptions` is needed for postcss 8.x; - // if you use postcss 7.x skip the key - postcssOptions: { - // postcss plugins, can be exported to postcss.config.js - plugins: () => { - [ - require('autoprefixer') - ]; - } - } - } - }, { - // compiles Sass to CSS - loader: 'sass-loader' - }] -} -// ... +```sh +mkdir {dist,src,src/js,src/scss} +touch dist/index.html src/js/main.js src/scss/styles.scss src/scss/_custom.scss webpack.config.js ``` -### 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'; +When you're done, your complete project should look like this: + +```text +my-project/ +├── dist/ +│ └── index.html +├── src/ +│ ├── js/ +│ │ └── main.js +│ └── scss/ +│ ├── _custom.scss +│ └── styles.scss +├── package-lock.json +├── package.json +└── webpack.config.js ``` -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' - ] - } - ] -} -// ... -``` +At this point, everything is in the right place, but Webpack won't work because we haven't filled in our `webpack.config.js` yet. + +## Configure Webpack + +With dependencies installed and our project folder ready for us to start coding, we can now configure Webpack and run our project locally. + +1. **Open `webpack.config.js` in your editor.** Since it's blank, we'll need to add some boilerplate config to it so we can start our server. This part of the config tells Webpack were to look for our project's JavaScript, where to output the compiled code to (`dist`), and how the development server should behave (pulling from the `dist` folder with hot reload). + + ```js + const path = require('path') + + module.exports = { + entry: './src/js/main.js', + output: { + filename: 'main.js', + path: path.resolve(__dirname, 'dist') + }, + devServer: { + static: path.resolve(__dirname, 'dist'), + port: 8080, + hot: true + } + } + ``` + +2. **Next we create our `dist/index.html`.** This is the HTML page Webpack will load in the browser to utilize the bundled CSS and JS we'll add to it in later steps. Before we can do that, we have to give it something to render and include the `output` JS from the previous step. + + ```html + + + + + + Bootstrap w/ Webpack + + +
+

Hello, Bootstrap and Webpack!

+ +
+ + + + ``` + + We're including a little bit of Bootstrap styling here with the `div class="container"` and `