跳到主要内容 跳到文档导航

Bootstrap & Vite

关于如何使用 Vite 在项目中包含和打包 Bootstrap 的 CSS 和 JavaScript 的官方指南。

想跳到最后?从twbs/examples 存储库下载本指南的源代码和工作演示。您还可以在 StackBlitz 中打开示例进行实时编辑。

设置

我们正在使用 Bootstrap 从头开始构建一个 Vite 项目,因此在我们真正开始之前有一些先决条件和前期步骤。本指南要求您安装 Node.js 并熟悉终端。

  1. 创建项目文件夹并设置 npm。我们将创建my-project文件夹并使用参数-y初始化 npm,以避免它向我们询问所有交互式问题。

    mkdir my-project && cd my-project
    npm init -y
    
  2. 安装 Vite。与我们的 Webpack 指南不同,这里只有一个构建工具依赖项。我们用--save-dev来表示此依赖项仅供开发使用,不适用于生产。

    npm i --save-dev vite
    
  3. 安装Bootstrap。现在我们可以安装 Bootstrap。我们还将安装 Popper,因为我们的下拉菜单、弹出窗口和工具提示都依赖于它来定位。如果你不打算使用这些组件,你可以在这里省略 Popper。

    npm i --save bootstrap @popperjs/core
    
  4. 安装额外的依赖项。除了 Vite 和 Bootstrap,我们还需要另一个依赖(Sass)来正确导入和打包 Bootstrap 的 CSS。

    npm i --save-dev sass
    

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

项目结构

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

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

完成后,您的完整项目应如下所示:

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

此时,一切都在正确的地方,但是 Vite 不会工作,因为我们还没有填写我们的vite.config.js

配置 Vite

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

  1. 在你的编辑器中打开vite.config.js由于它是空白的,我们需要向其中添加一些样板配置,以便我们可以启动我们的服务器。这部分配置告诉 Vite 在哪里寻找我们项目的 JavaScript 以及开发服务器应该如何表现(从src文件夹中拉取热重载)。

    const path = require('path')
    
    export default {
      root: path.resolve(__dirname, 'src'),
      server: {
        port: 8080,
        hot: true
      }
    }
    
  2. 接下来我们填写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>
      </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>
        <script type="module" src="./js/main.js"></script>
      </body>
    </html>
    

    我们在这里使用和包含了一些 Bootstrap 样式div class="container"<button>,这样我们就可以看到 Bootstrap 的 CSS 何时被 Vite 加载。

  3. 现在我们需要一个 npm 脚本来运行 Vite。打开package.json并添加start如下所示的脚本(您应该已经有了测试脚本)。我们将使用这个脚本来启动我们本地的 Vite 开发服务器。

    {
      // ...
      "scripts": {
        "start": "vite",
        "test": "echo \"Error: no test specified\" && exit 1"
      },
      // ...
    }
    
  4. 最后,我们可以启动 Vite。进入my-project文件夹,命令行运行新添加的 npm 脚本:

    npm start
    
    Vite 开发服务器运行

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

导入Bootstrap

  1. vite.config.js建立Bootstrap Sass导入. 您的配置文件现已完成,应该与下面的代码片段匹配。这里唯一的新部分是resolve属性——我们用它来为我们的源文件添加一个别名,node_modules以使导入尽可能简单。

    const path = require('path')
    
    export default {
      root: path.resolve(__dirname, 'src'),
      resolve: {
        alias: {
          '~bootstrap': path.resolve(__dirname, 'node_modules/bootstrap'),
        }
      },
      server: {
        port: 8080,
        hot: true
      }
    }
    
  2. 现在,让我们导入 Bootstrap 的 CSS。添加以下内容到src/scss/styles.scss以导入所有 Bootstrap 的源 Sass。

    // Import all of Bootstrap's CSS
    @import "~bootstrap/scss/bootstrap";
    

    如果需要,您也可以单独导入我们的样式表。阅读我们的 Sass 导入文档了解详细信息。

  3. 接下来我们加载 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 插件的更多信息。

  4. 你完成了!🎉 Bootstrap 的源代码 Sass 和 JS 完全加载后,您的本地开发服务器现在应该如下所示。

    使用 Bootstrap 运行的 Vite 开发服务器

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


在这里看到错误或过时的东西?请在 GitHub 上打开一个问题。需要帮助进行故障排除?在 GitHub 上搜索或发起讨论。