ActionView::Helpers::FormBuilder

submit

API ドキュメント（Rails 8.1.4.1） ↗
def submit(value = nil, options = {})

説明

外のフォームのモデルに合わせた value 属性の値の、type="submit" の <input> を作ります。

引数

値を変えると、ERB と HTML が変わります。

= nil
渡すものによって、次のように変わります。
  • String：そのまま value 属性の値にします。
  • Hash：options として扱います（2 つ目の引数の options を省いて書けます）。
  • デフォルト：次のうち最初に見つかったものを value 属性の値にします。
    1. helpers.submit.article.create の訳（保存済みなら update。以下も同じ）
    2. helpers.submit.create の訳
    3. Create に、モデルの名前（model_name.human）をつないだ文字列（Create Article）
options= {}
"publish"
デフォルトでは name="commit" を追加します。この option を渡すと、代わりに渡した値を使います。nil を渡すと、name を追加しません。
false
渡す値によって、次のように変わります。
  • デフォルト：value 属性の値と同じ文字列で、data-disable-with を追加します。
  • false：追加しません。
  • 文字列：その文字列を data-disable-with 属性の値にします。
data-disable-with は Rails UJS が読む HTML 属性で、押したあとにボタンを使えなくし、value 属性の値をこの文字列に変えます。Rails UJS を入れていないアプリ（Rails 7 以降の標準）では、この HTML 属性は何もしません。
ヘルパー共通の options

Rails はどのヘルパーでも、これらの options を同じように処理します。HTML の仕様で <input> に使えないものや、使う場面が少ないとこのサイトで判断したものは、ここでは省いています。

すべてのヘルパー共通

true にすると disabled="disabled" を追加し、false にすると追加しません。readonly、required、autofocus など、Rails が持っている一覧（BOOLEAN_ATTRIBUTES）にある HTML 属性はどれも同じで、値が false と nil 以外なら 属性名="属性名" の形で追加します。
{active: true, hidden: false}
Hash を渡すと、値が false と nil 以外のキーを空白でつなぎます。配列を渡すと、nil、false、空の文字列（空白だけの文字列も）を外して、空白でつなぎます。
{disable_with: "Saving..."}
Hash を渡すと、キーの _ を - にして、data-* 属性を追加します。値に配列や Hash を渡すと、JSON の文字列にします。このページの disable_with は、自動で追加する data-disable-with の文字列の代わりに使います。
{describedby: ["name_help", "name_error"], invalid: false}
:data と同じく、aria-* 属性を追加します。値が配列なら、nil と空の文字列を外して、空白でつなぎます（何も残らなければ、追加しません）。値が Hash なら、値が false と nil 以外のキーを空白でつなぎます。
ここにない options は、<input> の HTML 属性になります。値が nil なら、その HTML 属性は追加しません。
前提
外のフォームに渡す @article です。引数の value を渡さないときの値が、新規なら Create Article、保存済みなら Update Article になります。

ERB

直前との違い： 追加 削除 変更


          

        


        

          

            
HTML

          

          

            
            

          

        


        

          

            
プレビュー

            

              
              
                
プレビューを操作すると、フォーム送信の内容が変わります。


            

          


          

            
フォーム送信

            

              
フォームデータ

              

                
namevalue

                
              

              

                リクエストボディを見る
                
Content-Type：

                

              

              

                
params

                

              

                
このサイトでは、CSRF のトークンの値を伏せています（(hidden)）。本物は、描画のたびに変わる長い文字列です。