Using Bootstrap CSS & JS

Version: 3.3
Edit this page

Warning: You are browsing the documentation for version 3.3 which is not maintained anymore.

If some of your projects are still using this version, consider upgrading.

Using Bootstrap CSS & JS

Want to use Bootstrap (or something similar) in your project? No problem! First, install it. To be able to customize things further, we'll install bootstrap-sass:

1
$ yarn add bootstrap-sass --dev

Importing Bootstrap Sass

Now that bootstrap-sass lives in your node_modules directory, you can import it from any Sass or JavaScript file. For example, if you already have a global.scss file, import it from there:

1
2
3
4
5
6
7
// assets/css/global.scss

// customize some Bootstrap variables
$brand-primary: darken(#428bca, 20%);

// the ~ allows you to reference things in node_modules
@import '~bootstrap-sass/assets/stylesheets/bootstrap';

That's it! This imports the node_modules/bootstrap-sass/assets/stylesheets/_bootstrap.scss file into global.scss. You can even customize the Bootstrap variables first!

Tip

If you don't need all of Bootstrap's features, you can include specific files in the bootstrap directory instead - e.g. ~bootstrap-sass/assets/stylesheets/bootstrap/alerts.

After including bootstrap-sass, your Webpack builds might become slow. To fix this, you can use the resolveUrlLoader option:

1
2
3
4
5
6
// webpack.config.js
Encore
+     .enableSassLoader(function(sassOptions) {}, {
+         resolveUrlLoader: false
+     })
;

This disables the resolve-url-loader in Webpack, which means that any url() paths in your Sass files must now be relative to the original source entry file instead of whatever file you're inside of (see Problems with url()). To load Bootstrap, you'll need to override the path to its icons:

1
2
3
4
5
6
7
8
// assets/css/global.scss

+ $icon-font-path: "~bootstrap-sass/assets/fonts/bootstrap/";

+ // set if you're also including font-awesome
+ // $fa-font-path: "~font-awesome/fonts";

@import '~bootstrap-sass/assets/stylesheets/bootstrap';

Importing Bootstrap JavaScript

Bootstrap JavaScript requires jQuery, so make sure you have this installed:

1
$ yarn add jquery --dev

Next, make sure to call .autoProvidejQuery() in your webpack.config.js file:

1
2
3
4
5
// webpack.config.js
Encore
    // ...
+     .autoProvidejQuery()
;

This is needed because Bootstrap expects jQuery to be available as a global variable. Now, require bootstrap from any of your JavaScript files:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
// main.js

var $ = require('jquery');
// JS is equivalent to the normal "bootstrap" package
// no need to set this to a variable, just require it
require('bootstrap-sass');

// or you can include specific pieces
// require('bootstrap-sass/javascripts/bootstrap/tooltip');
// require('bootstrap-sass/javascripts/bootstrap/popover');

$(document).ready(function() {
    $('[data-toggle="popover"]').popover();
});

Thanks to autoProvidejQuery(), you can require any other jQuery plugins in a similar way:

1
2
3
4
5
6
7
// ...

// require the JavaScript
require('bootstrap-star-rating');
// require 2 CSS files needed
require('bootstrap-star-rating/css/star-rating.css');
require('bootstrap-star-rating/themes/krajee-svg/theme.css');
This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.