-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
Update bootstrap.rst #9918
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update bootstrap.rst #9918
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,18 @@ | ||
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``: | ||
``bootstrap``: | ||
|
||
.. code-block:: terminal | ||
|
||
$ yarn add bootstrap-sass --dev | ||
|
||
Importing Bootstrap Sass | ||
$ yarn add bootstrap --dev | ||
Importing Bootstrap 4 | ||
------------------------ | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should be shortened. |
||
|
||
Now that ``bootstrap-sass`` lives in your ``node_modules`` directory, you can | ||
Now that ``bootstrap`` 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: | ||
|
||
|
@@ -21,49 +21,21 @@ a ``global.scss`` file, import it from there: | |
// assets/css/global.scss | ||
|
||
// customize some Bootstrap variables | ||
$brand-primary: darken(#428bca, 20%); | ||
$primary: darken(#428bca, 20%); | ||
|
||
// the ~ allows you to reference things in node_modules | ||
@import '~bootstrap-sass/assets/stylesheets/bootstrap'; | ||
@import "~bootstrap/scss/bootstrap"; | ||
|
||
That's it! This imports the ``node_modules/bootstrap-sass/assets/stylesheets/_bootstrap.scss`` | ||
That's it! This imports the ``node_modules/bootstrap/scss/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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Just asking, why did you remove this explanation about There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I delete this because now on the scss file from bootstrap, we don't need to change the path from the webfont etc, so WebPack work realy fine now... i'm doing some test but for me isn't necessary anymore. |
||
this, you can use the ``resolveUrlLoader`` option: | ||
|
||
.. code-block:: diff | ||
|
||
// 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: | ||
|
||
.. code-block:: diff | ||
|
||
// 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'; | ||
in the ``bootstrap`` directory instead - e.g. ``~bootstrap/scss/alert``. | ||
|
||
Importing Bootstrap JavaScript | ||
------------------------------ | ||
--------------------------------- | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should be reverted. |
||
|
||
Bootstrap JavaScript requires jQuery, so make sure you have this installed: | ||
|
||
|
@@ -86,16 +58,16 @@ variable. Now, require bootstrap from any of your JavaScript files: | |
|
||
.. code-block:: javascript | ||
|
||
// main.js | ||
// app.js | ||
|
||
var $ = require('jquery'); | ||
const $ = require('jquery'); | ||
// JS is equivalent to the normal "bootstrap" package | ||
// no need to set this to a variable, just require it | ||
require('bootstrap-sass'); | ||
require('bootstrap'); | ||
|
||
// or you can include specific pieces | ||
// require('bootstrap-sass/javascripts/bootstrap/tooltip'); | ||
// require('bootstrap-sass/javascripts/bootstrap/popover'); | ||
// require('bootstrap/js/dist/tooltip'); | ||
// require('bootstrap/js/dist/popover'); | ||
|
||
$(document).ready(function() { | ||
$('[data-toggle="popover"]').popover(); | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should be reverted.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done in c90f20a. The other issues were fixed in 6b732a6. Thanks for reporting.