Tailwind CSS プラグイン · v1.4.2

Bootstrap のグリッドを、 Tailwind で。

すでに行と列で考える習慣があるなら、そのまま続けられます。tw-bootstrap-grid は、おなじみの 12 カラムグリッド、つまり .row、.col-6、.offset-2、.g-4 を Tailwind に持ち込みます。RTL に対応しており、コンポーネントの見た目については何も指図しません。

$npm install tw-bootstrap-grid

できること

  • 12 カラムグリッド

    .row、.col、.col-auto、そして .col-1 から .col-12 まで。Bootstrap と同じです。

  • テーマに沿ったガター

    .g-*、.gx-*、.gy-* は Tailwind のスペーシングスケールを使うので、デザインのほかの部分と揃います。

  • オフセット

    .offset-0 から .offset-12 まで。カラムを中央に寄せたり、間隔を空けたりできます。

  • 行ごとのカラム数

    .row-cols-1 から .row-cols-6 と .row-cols-auto で、行に 1 つクラスを付けるだけで、すべての子要素の幅が決まります。

  • コンテナ

    ガターを考慮したパディングを持つ .container と .container-fluid。最大幅は Tailwind 自身のブレークポイントから決まります。

  • レスポンシブと RTL

    すべてのクラスが md:col-6 のような Tailwind のブレークポイント接頭辞に対応し、dir="rtl" で正しく反転します。

担当するのはレイアウトだけです。色もコンポーネントもリセットもありません。Tailwind を置き換えるのではなく、上に付け加えるので、同じページで col-4 と flex を気兼ねなく併用できます。

はじめに

インストール

3 つのステップです。パッケージをインストールし、プラグインを登録して、クラスを使い始めます。

1パッケージをインストールする

npm install tw-bootstrap-grid

2プラグインを登録する

ヘッダーで Tailwind のバージョンを選ぶと、下のコードもそれに合わせて切り替わります。Tailwind v4 では CSS で、v3 では設定ファイルでプラグインを登録します。

Tailwind v4

main.css
@import "tailwindcss";
@plugin "tw-bootstrap-grid";

CommonJS を使う v3 の設定では、plugins: [require("tw-bootstrap-grid")] も使えます。

3クラスを使う

これだけです。ほかの Tailwind のクラスと同じようにマークアップに書いてください。sm:、md:、hover: でできることは、ここでも使えます。

index.html
<div class="container">
  <div class="row g-4">
    <div class="col-12 md:col-6 lg:col-4">One</div>
    <div class="col-12 md:col-6 lg:col-4">Two</div>
    <div class="col-12 lg:col-4">Three</div>
  </div>
</div>

ビルドステップが必要です

プラグインは Tailwind のコンパイラ(PostCSS、Vite、Webpack、Tailwind CLI など)の中で動きます。npm からプラグインを読み込めない Tailwind Play CDN のスクリプトでは動きません。

はじめに

設定

デフォルトは Bootstrap と同じなので、このページは飛ばしても構いません。ブレークポイントやガターのサイズを変えたくなったら戻ってきてください。

ブレークポイント

プラグイン自体にはブレークポイントがありません。md:col-6 のような接頭辞も .container の最大幅も Tailwind から来るので、スクリーンの設定を変えればグリッドも一緒に変わります。

Tailwind v4

main.css
@import "tailwindcss";
@plugin "tw-bootstrap-grid";

@theme {
  --breakpoint-sm: 40rem;  /* 640px */
  --breakpoint-md: 48rem;  /* 768px */
  --breakpoint-lg: 64rem;  /* 1024px */
  --breakpoint-xl: 80rem;  /* 1280px */
  --breakpoint-2xl: 96rem; /* 1536px */
}

ガターのサイズ

ガターはカラム同士の間隔です。デフォルトは横が 1.5rem、縦が 0 です。すべてに対して 1 度だけ設定することも、コンテナと行で別々に設定することもできます。v3 ではプラグインにオプションを渡し、v4 では CSS 変数を設定します。

Tailwind v4

main.css
@import "tailwindcss";
@plugin "tw-bootstrap-grid";

:root {
  /* used by containers and rows */
  --bs-global-gutter-x: 1.5rem;
  --bs-global-gutter-y: 0;

  /* overrides for one of them only */
  --bs-container-gutter-x: 1rem;
  --bs-row-gutter-x: 2rem;
  --bs-row-gutter-y: 1rem;
}
ガターが決まる順序
優先度CSS 変数オプション備考
1--bs-row-gutter-x / --bs-container-gutter-xrowGutters / containerGutters最も具体的な値が優先されます。
2--bs-global-gutter-xgutters両方に共通するフォールバックです。
31.5rem (x) と 0 (y)組み込みのデフォルトBootstrap と同じデフォルトです。

CSS 変数は実行時に読み込まれるので、どちらのバージョンでも、任意の要素で上書きしてそのセクションだけのガターを変えられます。1 つの行だけなら .g-*、.gx-*、.gy-* を使います。

コンテナをオフにする

Tailwind 自身の container だけを使いたい場合は、generateContainers を false にします。プラグインは .container-fluid とガターを考慮したパディングを生成しなくなります。行とカラムには影響しません。

Tailwind v4

main.css
@import "tailwindcss";
@plugin "tw-bootstrap-grid" {
  generateContainers: false;
}

v4 でなぜ変数なのか

Tailwind v4 は generateContainers: false; のような単純な値はプラグインに渡せますが、gutters のような入れ子のオブジェクトは渡せません。CSS 変数ならそれを補え、要素ごとに上書きできるという利点もあります。

リファレンス

クラス

プラグインが追加するものを、まとめて確認できます。

レイアウト

レイアウトのクラス
クラス働き備考
.containerwidth: 100%、中央寄せ、ガターに基づくパディング最大幅は Tailwind のブレークポイントから決まります。
.container-fluid.container と同じどのブレークポイントでも全幅です。
.rowdisplay: flex; flex-wrap: wrap; 負のマージン外側のガターを打ち消し、子要素を並べます。

カラム

カラムのクラス
クラス働き備考
.colflex: 1 0 0%残りの幅を均等に分け合います。
.col-autoflex: 0 0 auto; width: auto内容に合わせた幅になります。
.col-1 … .col-12flex: 0 0 auto; width: n / 1212 分割のうち n 個分を占めます。

オフセットと行ごとのカラム数

オフセットと行ごとのカラム数のクラス
クラス働き備考
.offset-0 … .offset-12margin-inline-start: n / 12RTL では自動的に反転します。
.row-cols-1 … .row-cols-6子要素に width: 1 / n が付く.row に設定し、すべての子要素に適用されます。
.row-cols-auto子要素に width: auto が付く子要素は内容に合わせた幅になります。

ガター

ガターのクラス
クラス働き備考
.g-*--bs-gutter-x と --bs-gutter-y両方向です。
.gx-*--bs-gutter-x横方向のみです。
.gy-*--bs-gutter-y縦方向のみです。

すべてレスポンシブです

上のどのクラスにもブレークポイント接頭辞を付けられます。md:col-6、lg:offset-3、sm:row-cols-2、xl:g-8 などです。

ガターの段階には何がありますか

.g-*、.gx-*、.gy-* はスペーシングのテーマから生成されます。v3 では theme.spacing のキーのうち、小数点を含まないものすべてです(g-4 はあり、g-0.5 はありません)。v4 では標準のスケール、つまり g-0 から g-96 と g-px です。

配置と並び順は Tailwind のものです

プラグインは独自の justify-*、items-*、order-* を持ちません。.row は普通の flex コンテナなので、Tailwind のユーティリティをそのまま使えます。

Bootstrap から来た方へ

Bootstrap からの移行

グリッドの使い方は、覚えているままです。違って見えるのは 3 つだけです。レスポンシブなクラスの書き方、スペーシングの数値、ブレークポイントの幅です。

  • 変わらないもの

    構造です。.container、.row、.col-*、.offset-*、.row-cols-*。CSS 変数の名前も --bs-gutter-x と --bs-gutter-y のままなので、それらを読む独自の CSS もそのまま動きます。

  • 中置ではなく接頭辞

    Bootstrap では col-md-6 と書きます。Tailwind では md:col-6 と書きます。いちばん多く手を入れる部分ですが、スクリプトで置き換えられます。

  • 異なる数値

    ガターとスペーシングの数値は Tailwind のスケールに従うので、Bootstrap の g-3 はここでは g-4 です。ブレークポイントの幅も少し違います。

完全なガイドには、クラスの対応表、ガターのサイズの変化、Bootstrap のブレークポイントに合わせる方法、マークアップを変換するコマンドがあります。

移行ガイドを読む

使い方

例

どの例もその場で動きます。左の HTML を編集すると、入力に合わせてプレビューが更新されます。Bootstrap のグリッド (新しいタブで開きます)を知っていれば、すぐになじめるはずです。

基本のレイアウト

.container は内容を中央に寄せ、.row はカラムを横に並べ、.col-* は使える 12 分割のうちその数だけを占めます。2 つの col-6 で行を半分に分けられます。

プレビュー
編集できる HTML

カラムは必ず折り返します。1 行で 12 分割を超えた分は次の行に回るので、カードの一覧に便利です。

等幅のカラムと自動幅のカラム

何も付けない .col は残りの幅を分け合うので、3 つ並べれば 3 つの等幅カラムになります。.col-auto は内容に合わせた幅になり、隣の .col が残りを使います。

プレビュー
編集できる HTML

レスポンシブなカラム

どのクラスも Tailwind のブレークポイント接頭辞に対応します。まずモバイル向けに col-12 で始め、大きな画面では sm:、md:、lg: などで幅を変えます。プレビューの上にある幅のボタンで、各ブレークポイントが効く様子を確認できます。

プレビュー
768px · md · 0%
編集できる HTML

プレビューは本物のビューポートです。隅に幅とブレークポイントが表示され、スマートフォン、タブレット、デスクトップのボタンで切り替えられるので、md: と lg: はその画面とまったく同じように適用されます。

ガター

ガターはカラム同士の間隔です。.g-* は両方向、.gx-* は横だけ、.gy-* は縦だけを設定します。数値は Tailwind のスペーシングスケールから来ているので、g-4 は p-4 と同じ段階です。

プレビュー
編集できる HTML

ガターのクラスは .row に付けます。間隔を完全になくすには g-0 を使います。

オフセット

.offset-* はカラムをその数だけ横にずらします。カラムを中央に寄せたり間隔を空けたりする手早い方法です。オフセットは lg:offset-3 のようにブレークポイント接頭辞とも併用できます。

プレビュー
編集できる HTML

オフセットは margin-inline-start を使うので、ページが右から左のときも正しい側から押し出します。プレビューの上の RTL ボタンを試してみてください。

行ごとのカラム数

すべてのカラムが同じ大きさなら、子要素ごとではなく行に 1 度だけ設定します。.row-cols-1 から .row-cols-6 は各子要素に等しい幅を与え、.row-cols-auto は内容に合わせた幅にします。

プレビュー
編集できる HTML

ブレークポイントと組み合わせると、画面が大きくなるにつれてカラム数を変えられます。たとえば row-cols-2 lg:row-cols-3 です。

入れ子

カラムの中に別の .row を置けます。入れ子の行はそのカラムの中で新しい 12 分割のグリッドを始めるので、必要なだけ何度でも領域を分けられます。

プレビュー
編集できる HTML

配置と並び順

.row は普通の flex コンテナなので、Tailwind の flexbox ユーティリティがそのまま使えます。items-*、justify-*、self-*、order-* などです。プラグインがこれらを再定義することはありません。

プレビュー
編集できる HTML

order-2 md:order-1 のような入れ替えはよく使われる手法です。スマートフォンではある順序で積み、大きな画面では逆にします。

右から左

コンテナに dir="rtl" を付けるか、ページ全体なら <html> に付けると、グリッドが右から流れます。アラビア語、ペルシャ語、ヘブライ語など RTL の言語ではこれを使います。

プレビュー
編集できる HTML

設定は不要です。行のガターは左右対称で、オフセットは論理プロパティを使うので、自動的に反転します。

知っておくと便利

右から左

dir="rtl" を付けるだけで、グリッドが自分で反転します。設定は何もいりません。

ページ全体に

index.html
<html dir="rtl">
  ...
</html>

1 つのセクションに

index.html
<div class="container" dir="rtl">
  <div class="row">
    <div class="col-6 offset-3">Starts from the right</div>
  </div>
</div>

なぜそのまま動くのか

オフセットは margin-inline-start を使い、行の負のマージンとカラムのパディングも左右対称なので、自動的に反転します。上のどの例でも RTL ボタンで確認できます。

知っておくと便利

よくある質問

よく寄せられる質問への答えです。

いいえ。Tailwind の container が引き続きブレークポイントごとの最大幅を決めます。プラグインはその上に、中央寄せとガターを考慮したパディングを加えます。それが不要な場合は generateContainers を false にします。

はい、それが狙いです。.row は flex コンテナなので、items-center、justify-between、order-2、mt-4 などは、行にもその中のカラムにもいつもどおり適用されます。

Tailwind は、ソースファイルの中で見つけたクラスの CSS だけを生成します。自分のプロジェクトではそれが自動で行われます。このページの編集できる例には何でも書けるので、デモではプラグインのすべてのクラスとブレークポイントをあらかじめ生成しています。

いいえ。CDN のスクリプトは npm からプラグインを読み込めません。Vite、PostCSS、Webpack、Tailwind CLI などのビルド環境を使ってください。

Tailwind v3.4 と v4 に対応し、Node 18 以降で動作します。パッケージには TypeScript の型つきの ESM と CommonJS のビルドが含まれます。

クラス名はよく似ています。col-md-6 は md:col-6 になり、ガターの数値は Tailwind のスケールに従います。移行ガイドに完全な対応表と、マークアップを変換するコマンドがあります。

バグを見つけた、またはアイデアがありますか?

GitHub でissue を作成 (新しいタブで開きます)するか、プルリクエスト (新しいタブで開きます)を送ってください。小さな修正やドキュメントの改善は大歓迎です。