Bootstrap and Vite
Viteを使ってBootstrapのCSSとJavaScriptをプロジェクトに取り込み、バンドルする方法を解説した公式ガイドです。
設定
Bootstrapを使ったViteプロジェクトをゼロから構築するため、実際に始める前にいくつかの前提条件と前段階があります。このガイドでは、Node.jsをインストールし、ターミナルをある程度使いこなしていることが必要です。
-
プロジェクトフォルダを作成し、npmを設定します。
my-project
フォルダを作成し、npmが対話的な質問ばかりしてくるのを避けるため、-y
引数でnpmを初期化することにします。mkdir my-project && cd my-project npm init -y
-
Viteをインストールします。 Webpackのガイドとは異なり、ここではビルドツールの依存関係は1つだけです。この依存関係は開発用であり、本番用ではないことを示すために、
--save-dev
を使用しています。npm i --save-dev vite
-
Bootstrapをインストールします。 これで、Bootstrapをインストールすることができます。ドロップダウン、ポップオーバー、ツールチップの配置はPopperに依存しているので、Popperもインストールします。これらのコンポーネントを使用する予定がない場合は、ここでPopperを省略することができます。
npm i --save bootstrap @popperjs/core
-
追加の依存関係をインストールします。 ViteとBootstrapに加えて、BootstrapのCSSを適切にインポートしてバンドルするために、もう一つの依存関係(Sass)が必要です。
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.config.js
がまだ記入されていないため、Viteは動作しません。
Viteを設定する
依存関係のインストールとプロジェクトフォルダの準備ができたので、Viteを設定し、ローカルでプロジェクトを実行することができます。
-
エディタで
vite.config.js
を開いてください。 空白なので、サーバーを起動できるように、定型的な設定を追加する必要があります。この設定部分は、ViteにプロジェクトのJavaScriptを探す場所と、開発サーバーの動作(ホットリロードでsrc
フォルダから取得)を指示します。const path = require('path') export default { root: path.resolve(__dirname, 'src'), build: { outDir: '../dist' }, server: { port: 8080 } }
-
次に、
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>
ここでは、
div class="container"
と<button>
を使って、Bootstrapのスタイリングを少し入れて、BootstrapのCSSがViteによって読み込まれたときに表示されるようにしています -
あとは、Viteを実行するためのnpmスクリプトが必要です。
package.json
を開き、以下に示すstart
スクリプトを追加します(すでにテストスクリプトはあるはずです)。このスクリプトを使用して、ローカルのVite devサーバーを起動します。{ // ... "scripts": { "start": "vite", "test": "echo \"Error: no test specified\" && exit 1" }, // ... }
-
そして、ようやくViteを起動することができます。 ターミナルにある
my-project
フォルダから、新しく追加したnpmスクリプトを実行します:npm start
このガイドの最後となる次のセクションでは、BootstrapのすべてのCSSとJavaScriptをインポートします。
Bootstrapをインポートする
-
Import Bootstrap’s CSS. Add the following to
src/scss/styles.scss
to import all of Bootstrap’s source 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';
Bootstrapのプラグインの使用方法については、JavaScriptのドキュメントをお読みください。
-
で、終了です! 🎉 BootstrapのソースであるSassとJSが完全に読み込まれ、ローカルの開発サーバーはこのような状態になりました。
これで、使用したいBootstrapコンポーネントを追加し始めることができます。カスタムSassを追加して、BootstrapのCSSとJSの必要な部分だけをインポートしてビルドを最適化する方法については、Viteの完全なサンプルプロジェクトをチェックを必ず参照してください。
何か間違っていたり、古くなっていたりしませんか?GitHubで課題を開いてください。トラブルシューティングのヘルプが必要ですか?GitHubで検索するか、ディスカッションを開始してください。