Webpack and bundlers

Installing Boosted

Install boosted as a Node.js module using npm.

Importing JavaScript

Import Boosted’s JavaScript by adding this line to your app’s entry point (usually index.js or app.js):

import 'boosted';

// or get all of the named exports for further usage
import * as boosted from 'boosted';

Alternatively, if you only need just a few of our plugins, you may import plugins individually as needed:

import Alert from 'boosted/js/dist/alert';

// or, specify which plugins you need:
import { Tooltip, Toast, Popover } from 'boosted';

Boosted depends on Popper, 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.

Importing Styles

Importing Precompiled Sass

To enjoy the full potential of Boosted 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. Then, use your main Sass file to import your custom variables, followed by Boosted:

@import "custom";
@import "~boosted/scss/boosted";

For Boosted to compile, make sure you install and use the required loaders: sass-loader, postcss-loader with Autoprefixer. With minimal setup, your webpack config should include this rule or similar:

// ...
{
  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: function () {
          return [
            require('autoprefixer')
          ];
        }
      }
    }
  }, {
    // compiles Sass to CSS
    loader: 'sass-loader'
  }]
}
// ...

Importing Compiled CSS

Alternatively, you may use Boosted’s ready-to-use CSS by simply adding this line to your project’s entry point:

import 'boosted/dist/css/boosted.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 and css-loader.

// ...
module: {
  rules: [
    {
      test: /\.css$/,
      use: [
        'style-loader',
        'css-loader'
      ]
    }
  ]
}
// ...