Bootstrap 和 Vite

官方指南：如何使用 Vite 在项目中引入和打包 Bootstrap 的 CSS 和 JavaScript。

想直接跳到最后吗？ 从 twbs/examples 仓库下载本指南的源代码和可运行演示。你也可以在 StackBlitz 中打开示例进行实时编辑。

什么是 Vite？

🌐 What is Vite?

Vite 是一个现代前端构建工具，旨在实现速度与简洁性。它提供了高效且简化的开发体验，特别适用于现代 JavaScript 框架。

设置

🌐 Setup

我们正在从零开始构建一个使用 Bootstrap 的 Vite 项目，因此在真正开始之前有一些前提条件和初步步骤。本指南要求你已安装 Node.js 并对终端有一定的熟悉度。

🌐 We’re building a Vite project with Bootstrap from scratch, so there are some prerequisites and upfront steps before we can really get started. This guide requires you to have Node.js installed and some familiarity with the terminal.

创建一个项目文件夹并设置 npm。 我们将创建 my-project 文件夹，并使用 -y 参数初始化 npm，以避免它询问我们所有的交互式问题。
```
mkdir my-project && cd my-project
npm init -y
```
安装 Vite。 与我们的 Webpack 指南不同，这里只有一个构建工具依赖。我们使用 --save-dev 来表示此依赖仅用于开发，不用于生产环境。
```
npm i --save-dev vite
```
安装 Bootstrap。 现在我们可以安装 Bootstrap。我们还将安装 Popper，因为我们的下拉菜单、弹出框和工具提示依赖它来定位。如果你不打算使用这些组件，可以在此省略安装 Popper。
```
npm i --save bootstrap @popperjs/core
```
安装额外的依赖。 除了 Vite 和 Bootstrap，我们还需要另一个依赖（Sass）来正确地导入和打包 Bootstrap 的 CSS。
```
npm i --save-dev sass
```

现在我们已经安装并设置了所有必要的依赖，我们可以开始创建项目文件并导入 Bootstrap。

🌐 Now that we have all the necessary dependencies installed and set up, we can get to work creating the project files and importing Bootstrap.

项目结构

🌐 Project structure

我们已经创建了 my-project 文件夹并初始化了 npm。现在我们还将创建 src 文件夹、样式表和 JavaScript 文件，以完善项目结构。在 my-project 中运行以下命令，或者手动创建下面显示的文件夹和文件结构。

🌐 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.

mkdir {src,src/js,src/scss}
touch src/index.html src/js/main.js src/scss/styles.scss vite.config.js

完成后，你的完整项目应如下所示：

🌐 When you’re done, your complete project should look like this:

my-project/
├── src/
│   ├── js/
│   │   └── main.js
│   └── scss/
│   |   └── styles.scss
|   └── index.html
├── package-lock.json
├── package.json
└── vite.config.js

此时，一切都已就位，但 Vite 无法工作，因为我们还没有填写我们的 vite.config.js。

🌐 At this point, everything is in the right place, but Vite won’t work because we haven’t filled in our vite.config.js yet.

配置 Vite

🌐 Configure Vite

安装依赖并准备好项目文件夹以开始编码后，我们现在可以配置 Vite 并在本地运行我们的项目。

🌐 With dependencies installed and our project folder ready for us to start coding, we can now configure Vite and run our project locally.

在你的编辑器中打开 vite.config.js。 由于它是空的，我们需要向其中添加一些模板配置，以便可以启动我们的服务器。配置的这一部分告诉 Vite 在哪里查找我们项目的 JavaScript 以及开发服务器应该如何运行（从 src 文件夹加载并支持热重载）。

import { resolve } from 'path'

export default {
  root: resolve(__dirname, 'src'),
  build: {
    outDir: '../dist'
  },
  server: {
    port: 8080
  },
  // Optional: Silence Sass deprecation warnings. See note below.
  css: {
     preprocessorOptions: {
        scss: {
          silenceDeprecations: [
            'import',
            'mixed-decls',
            'color-functions',
            'global-builtin',
          ],
        },
     },
  },
}

注意： 当使用最新版本的 Dart Sass 编译源 Sass 文件时，会显示 Sass 弃用警告。这不会阻止 Bootstrap 的编译或使用。我们正在努力寻找长期解决方案，但在此期间这些弃用通知可以忽略。

接下来我们填写 src/index.html。 这是 Vite 将在浏览器中加载的 HTML 页面，用于使用我们在后续步骤中添加到其中的打包 CSS 和 JS。

<!doctype html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>Bootstrap w/ Vite</title>
    <script type="module" src="./js/main.js"></script>
  </head>
  <body>
    <div class="container py-4 px-3 mx-auto">
      <h1>Hello, Bootstrap and Vite!</h1>
      <button class="btn btn-primary">Primary button</button>
    </div>
  </body>
</html>

我们在这里包括了一点 Bootstrap 样式，通过 div class="container" 和 <button> 来查看 Vite 加载了 Bootstrap 的 CSS。

现在我们需要一个 npm 脚本来运行 Vite。 打开 package.json 并添加下面显示的 start 脚本（你应该已经有了 test 脚本）。我们将使用这个脚本来启动本地 Vite 开发服务器。
```
{
  // ...
  "scripts": {
    "start": "vite",
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  // ...
}
```
最后，我们可以启动 Vite。 在你的终端中，从 my-project 文件夹运行新添加的 npm 脚本：
```
npm start
```

在本指南的下一部分也是最后一部分中，我们将导入所有 Bootstrap 的 CSS 和 JavaScript。

🌐 In the next and final section to this guide, we’ll import all of Bootstrap’s CSS and JavaScript.

导入 Bootstrap

🌐 Import Bootstrap

导入 Bootstrap 的 CSS。 在 src/scss/styles.scss 中添加以下内容以导入所有 Bootstrap 的源 Sass。
```
// Import all of Bootstrap’s CSS
@import "bootstrap/scss/bootstrap";
```
如果你愿意，你也可以单独导入我们的样式表。阅读我们的 Sass 导入文档了解详情。
接下来我们加载 CSS 并导入 Bootstrap 的 JavaScript。 将以下内容添加到 src/js/main.js 以加载 CSS 并导入所有的 Bootstrap JS。Popper 将通过 Bootstrap 自动导入。
```
// Import our custom CSS
import '../scss/styles.scss'

// Import all of Bootstrap’s JS
import * as bootstrap from 'bootstrap'
```
你还可以根据需要单独导入 JavaScript 插件，以缩小包大小：
```
import Alert from 'bootstrap/js/dist/alert';

// or, specify which plugins you need:
import { Tooltip, Toast, Popover } from 'bootstrap';
```
阅读我们的 JavaScript 文档以获取有关如何使用 Bootstrap 插件的更多信息。
你完成了！🎉 当 Bootstrap 的源 Sass 和 JS 完全加载后，你的本地开发服务器现在应该看起来像这样：

现在你可以开始添加任何你想使用的 Bootstrap 组件。一定要查看完整的 Vite 示例项目，了解如何包含额外的自定义 Sass，并通过仅导入你需要的 Bootstrap CSS 和 JS 部分来优化构建。

See something wrong or out of date here? Please open an issue on GitHub. Need help troubleshooting? Search or start a discussion on GitHub.