Skip to content

Latest commit

 

History

History
219 lines (170 loc) · 8.46 KB

webpack.md

File metadata and controls

219 lines (170 loc) · 8.46 KB
Raw
layout title description group toc
docs
Bootstrap & Webpack
The official guide for how to include and bundle Bootstrap's CSS and JavaScript in your project using Webpack.
getting-started
true

{{< callout >}} Want to skip to the end? Download the source code and working demo for this guide from the twbs/examples repository. You can also open the example in StackBlitz for live editing. {{< /callout >}}

Setup

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.


  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.

    mkdir my-project && cd my-project
npm init -y

  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.

    npm i --save-dev webpack webpack-cli webpack-dev-server

  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.

    npm i --save bootstrap @popperjs/core

  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.

    npm i --save-dev autoprefixer css-loader export-loader postcss-loader sass sass-loader style-loader

Now that we have all the necessary dependencies installed and setup, we can get to work creating the project files and importing Bootstrap.

Project structure

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.

mkdir {dist,src,src/js,src/scss}
touch dist/index.html src/js/main.js src/scss/styles.scss src/scss/_custom.scss

When you're done, your complete project should look like this:

my-project/
├── dist/
│   └── index.html
├── src/
│   ├── js/
│   │   └── main.js
│   └── scss/
│       ├── _custom.scss
│       └── styles.scss
├── package-lock.json
├── package.json
└── webpack.config.js

At this point, everything is in the right place, but Webpack won't work because we haven't created our webpack.config.js file 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).

    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 build 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.

    <!doctype html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>Bootstrap w/ Webpack</title>
  </head>
  <body>
    <div class="container py-4 px-3 mx-auto">
      <h1>Hello, Bootstrap and Webpack!</h1>
      <button class="btn btn-primary">Primary button</button>
    </div>
    <script src="./main.js"></script>
  </body>
</html>

    We're including a little bit of Bootstrap styling here with the div class="container" and <button> so that we see when Bootstrap's CSS is loaded by Webpack.

  3. Now we need an npm script to run Webpack. Open package.json and add the following scripts section. This should be in addition to the project name, description, version, and dependencies we installed earlier.

    {
// ...
  "scripts": {
    "start": "webpack serve --mode development"
  },
  // ...
}

  4. And finally, we can start Webpack. From the my-project folder in your terminal, run that newly added npm script:

    npm start
    Webpack dev server running

In the next and final section to this guide, we'll setup the Webpack loaders and import Bootstrap's CSS and JavaScript.

Import Bootstrap

Importing Bootstrap into Webpack requires the loaders we installed in the first section. We've installed them with npm, but now Webpack needs to be configured to use them.

  1. Setup the loaders in webpack.config.js. Your configuration file is now complete and should match the snippet below. The only new part is the module section.

    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
  },
  module: {
    rules: [
      {
        test: /\.(scss)$/,
        use: [
          {
            loader: 'style-loader'
          },
          {
            loader: 'css-loader'
          },
          {
            loader: 'postcss-loader',
            options: {
              postcssOptions: {
                plugins: () => [
                  require('autoprefixer')
                ]
              }
            }
          },
          {
            loader: 'sass-loader'
          }
        ]
      }
    ]
  }
}

    Here's a recap of why we need all these loaders. style-loader injects the CSS into a <style> element in the <head> of the HTML page, css-loader helps with using @import and url(), postcss-loader is required for Autoprefixer, and sass-loader allows us to use Sass.

  2. Now, let's import Bootstrap's CSS and JS. Add the following to src/scss/styles.scss to import all of Bootstrap's source Sass.

    @import "~bootstrap/scss/bootstrap";

    And then add the following to src/js/main.js to load the CSS and import all of Bootstrap's JS. Popper will be imported automatically through Bootstrap.

    // Import our custom CSS
import '../scss/styles.scss'

// Import all of Bootstrap's JS
import * as bootstrap from 'bootstrap'

  3. And you're done! 🎉 With Bootstrap's source Sass and JS fully loaded, your local development server should now look like this.

    Webpack dev server running with Bootstrap

    Now you can start adding any Bootstrap components you want to use. Be sure to checkout the complete Webpack example project for how to include additional custom Sass and optimize your build by importing only the parts of Bootstrap's CSS and JS that you need.

See something wrong or out of date here? Please [open an issue on GitHub]({{< param repo >}}/issues/new/choose). Need help troubleshooting? [Search or start a discussion]({{< param repo >}}/discussions) on GitHub.