Skip to content

chore(core): allow advanced scss import #4207

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Oct 8, 2019
Merged

chore(core): allow advanced scss import #4207

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ed79c07
chore(core): allow advanced scss import
madflow Oct 6, 2019
ccbc0d9
Merge branch 'dev' into scss-advanced-import
tmorehouse Oct 7, 2019
3f75022
Merge branch 'dev' into scss-advanced-import
tmorehouse Oct 8, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 33 additions & 8 deletions docs/markdown/intro/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,10 +104,10 @@ browsers and devices while providing slightly more opinionated resets to common

## Using module bundlers

If you are using module bundlers like [webpack](https://webpack.js.org/),
[rollup.js](https://rollupjs.org/), etc, you may prefer to directly include the package into your
project. To get started, use `yarn` or `npm` to get the latest version of Vue.js, BootstrapVue and
Bootstrap v4:
If you are using module bundlers like [Webpack](https://webpack.js.org/),
[Parcel](https://parceljs.org/) or [rollup.js](https://rollupjs.org/), you may prefer to directly
include the package into your project. To get started, use `yarn` or `npm` to get the latest version
of Vue.js, BootstrapVue and Bootstrap v4:

```bash
# With npm
Expand All @@ -117,7 +117,7 @@ npm install vue bootstrap-vue bootstrap
yarn add vue bootstrap-vue bootstrap
```

Then, register BootstrapVue plugin in your app entry point:
Then, register BootstrapVue in your app entry point:

```js
// app.js
Expand All @@ -143,9 +143,11 @@ Or import Bootstrap and BootstrapVue `scss` files via a single custom SCSS file:
@import 'node_modules/bootstrap-vue/src/index.scss';
```

Finally import the `custom.scss` file in your app entry point:

```js
// app.js
import 'custom.scss'
import './custom.scss'
```

Be sure to `@import` or define your custom variable values _before_ including Bootstrap SCSS
Expand All @@ -156,8 +158,31 @@ Place all of the SCSS `@import`s into a **single SCSS file**, and import that si
project. Importing individual SCSS files into your project will **not** share variable values and
functions between files by default.

**Note**: Requires webpack configuration to load CSS/SCSS files
([official guide](https://webpack.js.org/guides/asset-management/#loading-css)).
Webpack and Parcel support prepending the `scss` modules with tilde paths (`~`) when importing from
a `scss` file:

```scss
// Webpack example
@import '~bootstrap';
@import '~bootstrap-vue';
```

```scss
// Parcel example
@import '~bootstrap/scss/bootstrap';
@import '~bootstrap-vue/src/index.scss';
```

For more details how to configure asset loading and how modules are resolved, please consult the
module bundlers documentation.

**Notes**:

- Webpack configuration to load CSS files
([official guide](https://webpack.js.org/guides/asset-management/#loading-css)).
- Webpack Loader for SASS/SCSS files ([official guide](https://webpack.js.org/loaders/sass-loader/))
- Parcel CSS ([official guide](https://parceljs.org/css.html))
- Parcel SCSS ([official guide](https://parceljs.org/scss.html))

For information on theming Bootstrap, check out the [Theming](/docs/reference/theming) reference
section.
Expand Down
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
"module": "esm/index.js",
"jsnext:main": "esm/index.js",
"source": "src/index.js",
"sass": "src/index.scss",
"style": "dist/bootstrap-vue.css",
"license": "MIT",
"types": "src/index.d.ts",
Expand Down