mirror of
https://github.com/twbs/bootstrap.git
synced 2024-11-28 10:24:19 +01:00
Rewrite Parcel guide (#36411)
* Rewrite Parcel guide * update to match latest webpack guide, add images * eslint-skip * Apply suggestions from code review Co-authored-by: Julien Déramond <julien.deramond@orange.com> * match parcel to webpack, share footer, consistent use of no ; * Update site/content/docs/5.2/getting-started/parcel.md Co-authored-by: Julien Déramond <julien.deramond@orange.com> * edits from code review * Add custom images * add image compression action from blog Co-authored-by: Julien Déramond <julien.deramond@orange.com>
This commit is contained in:
Mark Otto
GitHub
parent
7ed1a5f821
commit
d17fe26dcf
24
.github/workflows/calibreapp-image-actions.yml
vendored
Normal file
24
.github/workflows/calibreapp-image-actions.yml
vendored
Normal file
@ -0,0 +1,24 @@
|
||||
name: Compress Images
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
paths:
|
||||
- '**.jpg'
|
||||
- '**.jpeg'
|
||||
- '**.png'
|
||||
- '**.webp'
|
||||
|
||||
jobs:
|
||||
build:
|
||||
# Only run on Pull Requests within the same repository, and not from forks.
|
||||
if: github.event.pull_request.head.repo.full_name == github.repository
|
||||
name: calibreapp/image-actions
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout Repo
|
||||
uses: actions/checkout@v3
|
||||
|
||||
- name: Compress Images
|
||||
uses: calibreapp/image-actions@1.1.0
|
||||
with:
|
||||
githubToken: ${{ secrets.GITHUB_TOKEN }}
|
||||
@ -22,7 +22,7 @@ your-project/
|
||||
└── scss
|
||||
```
|
||||
|
||||
If you've downloaded our source files and aren't using a package manager, you'll want to manually setup something similar to that structure, keeping Bootstrap's source files separate from your own.
|
||||
If you've downloaded our source files and aren't using a package manager, you'll want to manually create something similar to that structure, keeping Bootstrap's source files separate from your own.
|
||||
|
||||
```text
|
||||
your-project/
|
||||
|
||||
@ -1,101 +1,158 @@
|
||||
---
|
||||
layout: docs
|
||||
title: Parcel
|
||||
description: Learn how to include Bootstrap in your project using Parcel.
|
||||
title: "Bootstrap & Parcel"
|
||||
description: The official guide for how to include and bundle Bootstrap's CSS and JavaScript in your project using Parcel.
|
||||
group: getting-started
|
||||
toc: true
|
||||
---
|
||||
|
||||
## Install Parcel
|
||||
<img class="mb-4 img-fluid rounded-3" srcset="/docs/{{< param docs_version >}}/assets/img/guides/bootstrap-parcel.png, /docs/{{< param docs_version >}}/assets/img/guides/bootstrap-parcel@2x.png 2x" src="/docs/{{< param docs_version >}}/assets/img/guides/bootstrap-parcel.png" width="2000" height="1000" alt="">
|
||||
|
||||
Install [Parcel Bundler](https://parceljs.org/getting-started/webapp/).
|
||||
{{< callout >}}
|
||||
**Want to skip to the end?** Download the source code and working demo for this guide from the [twbs/examples repository](https://github.com/twbs/examples/tree/main/parcel). You can also [open the example in StackBlitz](https://stackblitz.com/github/twbs/examples/tree/main/parcel?file=index.html) but not run it because Parcel isn't currently supported there.
|
||||
{{< /callout >}}
|
||||
|
||||
## Install Bootstrap
|
||||
## Setup
|
||||
|
||||
[Install bootstrap]({{< docsref "/getting-started/download#npm" >}}) as a Node.js module using npm.
|
||||
We're building a Parcel 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.
|
||||
|
||||
Bootstrap depends on [Popper](https://popper.js.org/), which is specified in the `peerDependencies` property. This means that you will have to make sure to add both of them to your `package.json` using `npm install @popperjs/core`.
|
||||
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.
|
||||
|
||||
When all will be completed, your project will be structured like this:
|
||||
```sh
|
||||
mkdir my-project && cd my-project
|
||||
npm init -y
|
||||
```
|
||||
|
||||
2. **Install Parcel.** Unlike our Webpack guide, there's only a single build tool dependency here. Parcel will automatically install language transformers (like Sass) as it detects them. We use `--save-dev` to signal that this dependency is only for development use and not for production.
|
||||
|
||||
```sh
|
||||
npm i --save-dev parcel
|
||||
```
|
||||
|
||||
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.
|
||||
|
||||
```sh
|
||||
npm i --save bootstrap @popperjs/core
|
||||
```
|
||||
|
||||
Now that we have all the necessary dependencies installed, 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` folder, stylesheet, and JavaScript file to round out the project structure. Run the following from `my-project`, or manually create the folder and file structure shown below.
|
||||
|
||||
```sh
|
||||
mkdir {src,src/js,src/scss}
|
||||
touch src/index.html src/js/main.js src/scss/styles.scss
|
||||
```
|
||||
|
||||
When you're done, your complete project should look like this:
|
||||
|
||||
```text
|
||||
project-name/
|
||||
├── build/
|
||||
├── node_modules/
|
||||
│ ├── @popperjs/
|
||||
| | └── core/
|
||||
│ └── bootstrap/
|
||||
├── scss/
|
||||
│ └── custom.scss
|
||||
my-project/
|
||||
├── src/
|
||||
│ ├── index.html
|
||||
│ └── index.js
|
||||
│ ├── js/
|
||||
│ │ └── main.js
|
||||
│ ├── scss/
|
||||
│ │ └── styles.scss
|
||||
│ └── index.html
|
||||
├── package-lock.json
|
||||
└── package.json
|
||||
```
|
||||
|
||||
## Importing JavaScript
|
||||
At this point, everything is in the right place, but Parcel needs an HTML page and npm script to start our server.
|
||||
|
||||
Import [Bootstrap's JavaScript]({{< docsref "/getting-started/javascript" >}}) in your app's entry point (usually `src/index.js`). You can import all our plugins in one file or separately if you require only a subset of them.
|
||||
## Configure Parcel
|
||||
|
||||
<!-- eslint-skip -->
|
||||
```js
|
||||
// Import all plugins
|
||||
import * as bootstrap from 'bootstrap';
|
||||
With dependencies installed and our project folder ready for us to start coding, we can now configure Parcel and run our project locally. Parcel itself requires no configuration file by design, but we do need an npm script and an HTML file to start our server.
|
||||
|
||||
// Or import only needed plugins
|
||||
import { Tooltip as Tooltip, Toast as Toast, Popover as Popover } from 'bootstrap';
|
||||
1. **Fill in the `src/index.html` file.** Parcel needs a page to render, so we use our `index.html` page to setup some basic HTML, including our CSS and JavaScript files.
|
||||
|
||||
// Or import just one
|
||||
import Alert as Alert from '../node_modules/bootstrap/js/dist/alert';
|
||||
```
|
||||
```html
|
||||
<!doctype html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<title>Bootstrap w/ Parcel</title>
|
||||
<link rel="stylesheet" href="scss/styles.scss">
|
||||
<script type="module" src="js/main.js"></script>
|
||||
</head>
|
||||
<body>
|
||||
<div class="container py-4 px-3 mx-auto">
|
||||
<h1>Hello, Bootstrap and Parcel!</h1>
|
||||
<button class="btn btn-primary">Primary button</button>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
```
|
||||
|
||||
## Importing CSS
|
||||
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.
|
||||
|
||||
To utilize the full potential of Bootstrap and customize it to your needs, use the source files as a part of your project's bundling process.
|
||||
Parcel will automatically detect we're using Sass and install the [Sass Parcel plugin](https://parceljs.org/languages/sass/) to support it. However, if you wish, you can also manually run `npm i --save-dev @parcel/transformer-sass`.
|
||||
|
||||
Create your own `scss/custom.scss` to [import Bootstrap's Sass files]({{< docsref "/customize/sass#importing" >}}) and then override the [built-in custom variables]({{< docsref "/customize/sass#variable-defaults" >}}).
|
||||
2. **Add the Parcel npm scripts.** Open the `package.json` and add the following `start` script to the `scripts` object. We'll use this script to start our Parcel development server and render the HTML file we created after it's compiled into the `dist` directory.
|
||||
|
||||
## Build app
|
||||
```json
|
||||
{
|
||||
// ...
|
||||
"scripts": {
|
||||
"start": "parcel serve src/index.html --public-url / --dist-dir dist",
|
||||
"test": "echo \"Error: no test specified\" && exit 1"
|
||||
},
|
||||
// ...
|
||||
}
|
||||
```
|
||||
|
||||
Include `src/index.js` before the closing `</body>` tag.
|
||||
3. **And finally, we can start Parcel.** From the `my-project` folder in your terminal, run that newly added npm script:
|
||||
|
||||
```html
|
||||
<!doctype html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
</head>
|
||||
<body>
|
||||
<script type="module" src="./index.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
```
|
||||
```sh
|
||||
npm start
|
||||
```
|
||||
|
||||
### Edit `package.json`
|
||||
<img class="img-fluid" src="/docs/{{< param docs_version >}}/assets/img/guides/parcel-dev-server.png" alt="Parcel dev server running">
|
||||
|
||||
Add `dev` and `build` scripts in your `package.json` file.
|
||||
In the next and final section to this guide, we'll import all of Bootstrap's CSS and JavaScript.
|
||||
|
||||
```json
|
||||
"scripts": {
|
||||
"dev": "parcel ./src/index.html",
|
||||
"prebuild": "npx rimraf build",
|
||||
"build": "parcel build --public-url ./ ./src/index.html --dist-dir build"
|
||||
}
|
||||
```
|
||||
## Import Bootstrap
|
||||
|
||||
### Run dev script
|
||||
Importing Bootstrap into Parcel requires two imports, one into our `styles.scss` and one into our `main.js`.
|
||||
|
||||
Your app will be accessible at `http://127.0.0.1:1234`.
|
||||
1. **Import Bootstrap's CSS.** Add the following to `src/scss/styles.scss` to import all of Bootstrap's source Sass.
|
||||
|
||||
```sh
|
||||
npm run dev
|
||||
```
|
||||
```scss
|
||||
// Import all of Bootstrap's CSS
|
||||
@import "~bootstrap/scss/bootstrap";
|
||||
```
|
||||
|
||||
### Build app files
|
||||
*You can also import our stylesheets individually if you want. [Read our Sass import docs]({{< docsref "/customize/sass#importing" >}}) for details.*
|
||||
|
||||
Built files are in the `build/` folder.
|
||||
2. **Import Bootstrap's JS.** Add the following to `src/js/main.js` to import all of Bootstrap's JS. Popper will be imported automatically through Bootstrap.
|
||||
|
||||
```sh
|
||||
npm run build
|
||||
```
|
||||
<!-- eslint-skip -->
|
||||
```js
|
||||
// Import all of Bootstrap's JS
|
||||
import * as bootstrap from 'bootstrap'
|
||||
```
|
||||
|
||||
You can also import JavaScript plugins individually as needed to keep bundle sizes down:
|
||||
|
||||
<!-- eslint-skip -->
|
||||
```js
|
||||
import Alert from 'bootstrap/js/dist/alert'
|
||||
|
||||
// or, specify which plugins you need:
|
||||
import { Tooltip, Toast, Popover } from 'bootstrap'
|
||||
```
|
||||
|
||||
*[Read our JavaScript docs]({{< docsref "/getting-started/javascript/" >}}) for more information on how to use Bootstrap's plugins.*
|
||||
|
||||
3. **And you're done! 🎉** With Bootstrap's source Sass and JS fully loaded, your local development server should now look like this.
|
||||
|
||||
<img class="img-fluid" src="/docs/{{< param docs_version >}}/assets/img/guides/parcel-dev-server-bootstrap.png" alt="Parcel dev server running with Bootstrap">
|
||||
|
||||
Now you can start adding any Bootstrap components you want to use. Be sure to [checkout the complete Parcel example project](https://github.com/twbs/examples/tree/main/parcel) 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.
|
||||
|
||||
{{< markdown >}}
|
||||
{{< partial "guide-footer.md" >}}
|
||||
{{< /markdown >}}
|
||||
|
||||
@ -6,6 +6,8 @@ group: getting-started
|
||||
toc: true
|
||||
---
|
||||
|
||||
<img class="mb-4 img-fluid rounded-3" srcset="/docs/{{< param docs_version >}}/assets/img/guides/bootstrap-webpack.png, /docs/{{< param docs_version >}}/assets/img/guides/bootstrap-webpack@2x.png 2x" src="/docs/{{< param docs_version >}}/assets/img/guides/bootstrap-webpack.png" width="2000" height="1000" alt="">
|
||||
|
||||
{{< callout >}}
|
||||
**Want to skip to the end?** Download the source code and working demo for this guide from the [twbs/examples repository](https://github.com/twbs/examples/tree/main/webpack). You can also [open the example in StackBlitz](https://stackblitz.com/github/twbs/examples/tree/main/webpack?file=index.html) for live editing.
|
||||
{{< /callout >}}
|
||||
@ -14,8 +16,6 @@ toc: true
|
||||
|
||||
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.
|
||||
|
||||
<br>
|
||||
|
||||
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.
|
||||
|
||||
```sh
|
||||
@ -41,7 +41,7 @@ We're building a Webpack project with Bootstrap from scratch, so there are some
|
||||
npm i --save-dev autoprefixer css-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.
|
||||
Now that we have all the necessary dependencies installed, we can get to work creating the project files and importing Bootstrap.
|
||||
|
||||
## Project structure
|
||||
|
||||
@ -49,7 +49,7 @@ We've already created the `my-project` folder and initialized npm. Now we'll als
|
||||
|
||||
```sh
|
||||
mkdir {dist,src,src/js,src/scss}
|
||||
touch dist/index.html src/js/main.js src/scss/styles.scss src/scss/_custom.scss webpack.config.js
|
||||
touch dist/index.html src/js/main.js src/scss/styles.scss webpack.config.js
|
||||
```
|
||||
|
||||
When you're done, your complete project should look like this:
|
||||
@ -62,7 +62,6 @@ my-project/
|
||||
│ ├── js/
|
||||
│ │ └── main.js
|
||||
│ └── scss/
|
||||
│ ├── _custom.scss
|
||||
│ └── styles.scss
|
||||
├── package-lock.json
|
||||
├── package.json
|
||||
@ -216,10 +215,10 @@ Importing Bootstrap into Webpack requires the loaders we installed in the first
|
||||
|
||||
<!-- eslint-skip -->
|
||||
```js
|
||||
import Alert from 'bootstrap/js/dist/alert';
|
||||
import Alert from 'bootstrap/js/dist/alert'
|
||||
|
||||
// or, specify which plugins you need:
|
||||
import { Tooltip, Toast, Popover } from 'bootstrap';
|
||||
import { Tooltip, Toast, Popover } from 'bootstrap'
|
||||
```
|
||||
|
||||
*[Read our JavaScript docs]({{< docsref "/getting-started/javascript/" >}}) for more information on how to use Bootstrap's plugins.*
|
||||
@ -230,6 +229,6 @@ Importing Bootstrap into Webpack requires the loaders we installed in the first
|
||||
|
||||
Now you can start adding any Bootstrap components you want to use. Be sure to [checkout the complete Webpack example project](https://github.com/twbs/examples/tree/main/webpack) 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.
|
||||
|
||||
<hr class="my-5">
|
||||
|
||||
_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._
|
||||
{{< markdown >}}
|
||||
{{< partial "guide-footer.md" >}}
|
||||
{{< /markdown >}}
|
||||
|
||||
3
site/layouts/partials/guide-footer.md
Normal file
3
site/layouts/partials/guide-footer.md
Normal file
@ -0,0 +1,3 @@
|
||||
<hr class="my-5">
|
||||
|
||||
_See something wrong or out of date here? Please [open an issue on GitHub]({{ .Site.Params.repo }}/issues/new/choose). Need help troubleshooting? [Search or start a discussion]({{ .Site.Params.repo }}/discussions) on GitHub._
|
||||
BIN
site/static/docs/5.2/assets/img/guides/bootstrap-parcel.png
Normal file
BIN
site/static/docs/5.2/assets/img/guides/bootstrap-parcel.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 158 KiB |
BIN
site/static/docs/5.2/assets/img/guides/bootstrap-parcel@2x.png
Normal file
BIN
site/static/docs/5.2/assets/img/guides/bootstrap-parcel@2x.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 553 KiB |
BIN
site/static/docs/5.2/assets/img/guides/bootstrap-webpack.png
Normal file
BIN
site/static/docs/5.2/assets/img/guides/bootstrap-webpack.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 166 KiB |
BIN
site/static/docs/5.2/assets/img/guides/bootstrap-webpack@2x.png
Normal file
BIN
site/static/docs/5.2/assets/img/guides/bootstrap-webpack@2x.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 560 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 162 KiB |
BIN
site/static/docs/5.2/assets/img/guides/parcel-dev-server.png
Normal file
BIN
site/static/docs/5.2/assets/img/guides/parcel-dev-server.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 126 KiB |
Loading…
Reference in New Issue
Block a user