はじめに
Railsアプリにページネーションを簡単に実装できるkaminari
というGemには、BootstrapなどのCSSフレームワークのテーマ(テンプレートファイル)が用意されています。わざわざCSSフレームワークのクラスを手動で付与しなくても、専用コマンドを実行するだけで各テーマのテンプレートファイルをRailsアプリにフェッチすることができます。
本記事では、kaminari
で使用できるテーマ一覧を画像付きで紹介します。また、CSSフレームワークではなく独自のスタイルにしたい場合に、kaminari
で実際に生成されるタグやクラスを紹介します。
CSSフレームワークのテーマ一覧
CSSフレームワークのテーマをフェッチするには、以下のコマンドを実行します。
$ rails generate kaminari:views THEME
THEME
にCSSフレームワークの名称を指定します。THEME
を入力せずにコマンドを実行すると使用できるテーマの一覧が表示されます。
このコマンドはkaminari_themes
というリポジトリから指定したテーマのテンプレートファイルをフェッチしています。連続してこのコマンドを実行していると、フェッチ回数がGitHubのレート制限の上限に達してしまい、それ以降コマンドが実行できなくなることがあります。
このコマンドを何度も実行することがあらかじめわかっている場合は、以下のリポジトリをクローンしてからテンプレートファイルをコピーするという方法をおすすめします。
$ git clone https://github.com/amatsuda/kaminari_themes.git
$ cd kaminari_themes/bootstrap4/
$ cp -rp app/views/ /path/to/rails/app/views/
Bootstrap
Bootstrapのテーマは、Bootstrap2、Bootstrap3、Bootstrap4の3種類がありますが、ここではBootstrap4のみを紹介します。
$ rails generate kaminari:views bootstrap4
Bulma
$ rails generate kaminari:views bulma
Foundation
Foundationのテーマは、FoundationとFoundation5の2種類がありますが、ここではFoundation5のみを紹介します。
$ rails generate kaminari:views foundation5
GitHub
GitHubはCSSフレームワークではありませんが、テーマとして用意されています。
$ rails generate kaminari:views github
GoogleはCSSフレームワークではありませんが、テーマとして用意されています(使う人いるのか...?)。
$ rails generate kaminari:views google
Materialize
Materializeは前のページ、次のページのアイコンにGoogleのマテリアルアイコンを使用しています。Materialize CSSフレームワークと一緒にマテリアルアイコンも導入する必要があります。
$ rails generate kaminari:views materialize
Pure CSS
$ rails generate kaminari:views purecss
Semantic UI
$ rails generate kaminari:views semantic_ui
スタイルのカスタマイズ
CSSフレームワークではなく独自のスタイルにカスタマイズしたい場合は、kaminari
によって生成されるタグやクラスにスタイルを適用します。以下は、Bootstrapのテーマを適用させた場合に生成されるHTMLです。
<nav>
<ul class="pagination">
<li class="page-item">
<a class="page-link" href="/users">« First</a>
</li>
<li class="page-item">
<a rel="prev" class="page-link" href="/users">‹ Prev</a>
</li>
<li class="page-item">
<a rel="prev" class="page-link" href="/users">1</a>
</li>
<li class="page-item active">
<a data-remote="false" class="page-link">2</a>
</li>
<li class="page-item">
<a rel="next" class="page-link" href="/users?page=3">3</a>
</li>
<li class="page-item disabled">
<a class="page-link" href="#">…</a>
</li>
<li class="page-item">
<a rel="next" class="page-link" href="/users?page=3">Next ›</a>
</li>
<li class="page-item">
<a class="page-link" href="/users?page=9">Last »</a>
</li>
</ul>
</nav>
クラス一覧とその説明は以下の通りです。
クラス | 説明 |
---|---|
.pagination |
リスト全体に適用されるスタイルを設定。リストを横並びにするにはFlexboxを使う。 |
.page-item |
リストアイテムに適用されるスタイルを設定。 |
.active |
現在のページ番号のリストアイテムに適用されるスタイルを設定。 |
.disabled |
リンクではないリストアイテムに適用されるスタイルを設定。 |
.page-link |
リストアイテムの中のリンクに適用されるスタイルを設定。 |
まとめ
ページネーションを実装するGemの中でkaminari
はよく使われており人気があります。CSSフレームワークを使っている人も独自のスタイルを書いている人も本記事を参考にしてkaminari
のページネーションをカスタマイズしていただければと思います。