レイアウトおよび部分テンプレートに関するまとめ (Rails4)
[履歴] (2014/06/17 21:34:43)
最近の投稿
注目の記事

概要

レイアウトおよび部分テンプレートはどちらもテンプレート (*.html.erb) に共通の要素をまとめておき、任意のテンプレートから利用できるようにしておくための仕組みです。フッターやヘッダーといった大枠はレイアウト、小さなパーツは部分テンプレートというイメージで使い分けましょう。

レイアウトの使用方法

クラス毎に指定する方法と、アクション毎に指定する方法があります。

app/views/layouts/my_layout.html.erb

[ヘッダー]
<%= yield %>
[フッター]

クラス毎に指定

app/controllers/my_models_controller.rb

class MyModelsController < ApplicationController
  layout 'my_layout'
  #layout false #レイアウトをなしにする場合
  ...

アクション毎に指定

class MyModelsController < ApplicationController
  before_action :set_my_model, only: [:show, :edit, :update, :destroy]

  # GET /my_models
  # GET /my_models.json
  def index
    @my_models = MyModel.all
    render layout: 'my_layout'
    #render layout: false #レイアウトをなしにする場合
  end
  ...

複雑なレイアウトの作成方法

"yield"を複数設置

app/views/layouts/my_layout.html.erb

[ヘッダー]
<%= yield :contentA %>
[共通コンテンツ]
<%= yield :contentB %>
[フッター]

app/views/my_models/index.html.erb

<% content_for :contentA do %>
コンテンツA
<% end %>
<% content_for :contentB do %>
コンテンツB
<% end %>

出力例

[ヘッダー]
コンテンツA

[共通コンテンツ]
コンテンツB

[フッター]

レイアウトのレイアウト

複数のレイアウト間に共通の大枠の要素がある場合、レイアウトのレイアウトにまとめておくと便利です。

app/views/layouts/my_layout.html.erb

<% content_for :normal_layout_content do %>
レイアウトその1
<%= yield %>
<% end %>
<%= render template: 'layouts/layout_of_layout' %>

app/views/layouts/my_layout2.html.erb

<% content_for :normal_layout_content do %>
レイアウトその2
<%= yield %>
<% end %>
<%= render template: 'layouts/layout_of_layout' %>

app/views/layouts/layout_of_layout.html.erb

[ヘッダー]
<%= yield(:normal_layout_content) %>
[フッター]

app/views/my_models/index.html.erb

本文です。

出力例

[ヘッダー]
レイアウトその1
本文です。


[フッター]

部分テンプレートの使用方法

app/views/my_models/_partial_template.html.erb

~~~~~~~~~~~~~~~~~~
小さな共通パーツ
<%= arg1 %>
<%= arg2 %>
~~~~~~~~~~~~~~~~~~

app/views/my_models/index.html.erb

<%= render 'my_models/partial_template', arg1: 'val1', arg2: 'val2' %>

出力例

~~~~~~~~~~~~~~~~~~
小さな共通パーツ
val1
val2
~~~~~~~~~~~~~~~~~~

繰り返しが発生する場合に便利な記法

ページャ等で同じようなアイテムを繰り返し出力する場合、部分テンプレートを使用するとよいのは想像の通りですが、その「繰り返し」をeachで実現する場合と比較して便利な記法が存在しています。

app/views/my_models/_my_model.html.erb (MyModelを表示するのための部分テンプレート)

<tr><td><%= arg1 %>:<%= my_model.id %></td></tr>

app/views/my_models/index.html.erb

<table>
<%= render @my_models, arg1: 'val1' %>
</table>

出力例

<table>
<tr><td>val1:1</td></tr>
<tr><td>val1:2</td></tr>
<tr><td>val1:3</td></tr>
</table>

@my_modelsに格納されているモデルをもとに自動で部分テンプレートが選択されます。今回の例では"MyModel"のみですので、すべて"my_models/_my_model.html.erb"が選択されました。

関連ページ
    概要 Rails における ERB と同様に、Spring Boot でもテンプレートエンジンを利用できます。今回は特に Thymeleaf (タイムリーフ) のサンプルコードを、こちらのページで構築した環境をもとにまとめます。 公式ドキュメント Serving Web Content with Spring MVC