ActionView::Helpers::FormTagHelper

checkbox_tag

API ドキュメント（Rails 8.1.4.1） ↗

alias: check_box_tag

def checkbox_tag(name, value = "1", checked = false, options = {})

説明

モデルに紐づかない、type="checkbox" の <input> を作ります。

引数

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

name

:agree

"user[tag_ids][]"

<input> の name 属性と id 属性の値にします。id 属性の値は、[ と空白などを _ にし、] を消した形です。

value = "1"

渡した値を、value 属性の値にします。nil を渡すと、value を追加しません。

checked = false

true

false と nil 以外の値を渡すと、checked 属性を追加します（"0" でも追加します）。

options= {}

:value = nil

"other"

引数の value の代わりに、渡した値を value 属性の値にします。nil を渡すと、value 属性を追加しません。

ヘルパー共通の options

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

フォームヘルパー共通

:name = 自動で作る

"q"

自動で作る name 属性の値の代わりに、渡した値を使います。nil を渡すと、name 属性を追加しません。

:id = 自動で作る

nil

自動で作る id 属性の値の代わりに、渡した値を使います。nil を渡すと、id 属性を追加しません。

すべてのヘルパー共通

:disabled

truefalse

true にすると disabled="disabled" を追加し、false にすると追加しません。readonly、required、autofocus など、Rails が持っている一覧（BOOLEAN_ATTRIBUTES）にある HTML 属性はどれも同じで、値が false と nil 以外なら 属性名="属性名" の形で追加します。

:class

{active: true, hidden: false}

Hash を渡すと、値が false と nil 以外のキーを空白でつなぎます。配列を渡すと、nil、false、空の文字列（空白だけの文字列も）を外して、空白でつなぎます。

:data

{controller: "tags", tags_suggestions_value: ["ruby", "rails"]}

Hash を渡すと、キーの _ を - にして、data-* 属性を追加します。値に配列や Hash を渡すと、JSON の文字列にします。

:aria

{describedby: ["name_help", "name_error"], invalid: false}

:data と同じく、aria-* 属性を追加します。値が配列なら、nil と空の文字列を外して、空白でつなぎます（何も残らなければ、追加しません）。値が Hash なら、値が false と nil 以外のキーを空白でつなぎます。

ここにない options は、<input> の HTML 属性になります。値が nil なら、その HTML 属性は追加しません。

ERB

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

HTML

プレビュー

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

フォーム送信

フォームデータ

name	value

リクエストボディを見る

Content-Type：

params