【Rails】ページネーション「kaminari」で用意されているテーマ一覧とスタイルのカスタマイズ

はじめに

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

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のページネーションをカスタマイズしていただければと思います。

関連記事

【Rails】Railsアップグレードまとめ
# はじめに Ruby on Railsに限らず、何らかのフレームワークを使ってWebシステムを構築している場合、フレームワークのアップグレード作業は避けて通れません。 一般的にフレームワークはバージョン毎にEOL (End of Life [...]
2022年10月1日 14:32
【Rails】ユーザー登録時に行うメールアドレス認証機能の実装方法
# はじめに ユーザー登録/解除やログイン/ログアウトといった認証機能の導入に「devise」というGemを使っている人は多いと思います。「devise」では以下のように記述するだけで、ユーザー登録時に確認メールを送付しメールアドレス認証を行う機 [...]
2022年9月24日 14:24
【Rails】モデルに列挙型(enum)を定義し、使いこなす方法
# はじめに Railsはモデルでカラム名と同名の列挙型(enum)を定義することで、カラムと列挙型の変数を紐付けることができます。カラムと列挙型の変数を紐付けると、カラムに対して様々な便利な使い方ができるようになります。 本記事では、モデ [...]
2022年9月3日 10:29
【Rails】RailsでCORSとPreflight requestの設定を行う方法
# はじめに RailsアプリをAPIサーバーとして構築するには、CORS (Cross-Origin Resource Sharing)と Preflight requestの設定を行う必要があります。APIサーバーは外部からの要求に対して処理 [...]
2022年8月27日 10:44
【Ruby】Bundlerを使ってRubyGemsを作成/公開する方法
# はじめに Bundlerを使ってRubyGemsを作成および公開する方法について説明します。Bundlerを使わずにRubyGemsを作成/公開する方法については以下の記事を参照してください。 <iframe class="hatena [...]
2022年7月12日 23:18
【Ruby】RubyGemsを作成/公開する方法
# はじめに RubyGemsを作成および公開する方法について説明します。Bundlerを使ってRubyGemsを作成する方法については以下の記事を参照してください。 <iframe class="hatenablogcard" style [...]
2022年7月11日 21:52
【Rails】M1チップ搭載MacでRuby on Railsの開発環境構築
# はじめに M1チップ搭載MacにRuby on Railsの開発環境を構築する手順を記載します。 - MacBook Air (M1, 2020) - macOS Monterey 12.3.1 # Homebrew ## [...]
2022年5月5日 11:56
【Rails】Rakeタスクの基本情報と作成・実行方法
# はじめに Railsには標準でRakeというGemが同梱されています。RakeはRubyで実装されたMake(UNIX系のOSで使用できるコマンド)のようなビルド作業を自動化するツールです。Ruby Make、略してRakeというわけですね。 [...]
2022年3月7日 22:12