【Rails】レンダリング(renderメソッド)でアンカー指定を行う

2021年5月25日 12:26

はじめに

通常、Railsでアンカー付きのリクエストを発生させるにはredirect_toを使います。

redirect_to root_path(anchor: 'target')

では、renderでビューを表示させるときにアンカーを指定したいときはどうすればいいのでしょうか。renderredirect_toのような書き方はできません。

# 以下の書き方はできない
render :index(anchor: 'target')
render "index#target"

renderredirect_toの使い方やその違いについては以下の記事を参照してください。

アンカー指定が必要なケース

そもそも、renderでアンカー指定が必要なケースとはどのようなものでしょうか。よくあるのは、フォーム送信時にバリデーションエラーで元のページを再レンダリングするときです。

contact_controller.rb

class ContactsController < ApplicationController
  def sending
    @contact = Contact.new(contact_params)
    if @contact.valid?
      ContactMailer.send_mail(@contact).deliver_now
      redirect_to contact_done_path
    else
      render :index
    end
  end

  private
    def contact_params
      params.require(:contact).permit(:name, :email, :content, :confirm)
    end
end

renderの部分を抜き出すと以下になります。

contact_controller.rb (抜粋)

    if @contact.valid?
      ContactMailer.send_mail(@contact).deliver_now
      redirect_to contact_done_path
    else
      render :index
    end

バリデーションチェックの結果が真の場合はメールを送信し送信完了ページにリダイレクトしています。一方、バリデーションチェックの結果が偽の場合、フォームを設置しているページを再レンダリングしています。再レンダリングしたページでは@contact.errorsに格納されているエラーメッセージを使用するため、redirect_toではなくrenderを使う必要があります。

このとき、フォームをページ下部に設置している場合、再レンダリングでページ先頭に戻されるのはユーザーフレンドリーな設計とは言えません。ページ先頭ではなくフォームの先頭に再レンダリングしたいと考えるのが普通です。

レンダリングでアンカー指定

結論から言うとrenderでアンカー指定することはできません(renderはビューをレンダリングするだけでURLの変更は行わないため)。代わりにフォーム送信時のURL指定時にアンカーを指定します。

index.html.erb

<%= form_with model: @contact, url: contact_sending_path(anchor: 'form') id: 'form' do |form| %>
<%= form_with model: @contact, url: '/contact/sending#form' id: 'form' do |form| %>

index.html.slim

= form_with model: @contact, url: contact_sending_path(anchor: 'form') id: 'form' do |form|
= form_with model: @contact, url: '/contact/sending#form' id: 'form' do |form|

renderは新しいURLのリクエストを作成するわけではないので、フォーム送信時に指定したURLが再レンダリング後のページでも使用されます。当然、そのURLにアンカーが指定されているなら再レンダリング後のページでも機能します。

ちなみに、バリデーションチェックの結果が真の場合にリダイレクトされるURL、つまり送信完了ページのURLにもフォームで指定したアンカーが残りますが、送信完了ページに該当のID(今回は#form)が含まれない場合はアンカーは無視されます。ただし、表示されているURLはアンカー付きのままなので(/contact/done#form)、それが気になるならJavaScriptで削ってください。

まとめ

Railsの機能というより裏ワザ的なテクニックなので、知っている人はあまり多くないかもしれません。renderでアンカー指定する機会はあまりないかもしれませんが、知っておくとよりユーザーフレンドリーな設計のWebアプリにできるかと思います。

本記事を参考にしていただければと思います。

関連記事

【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