Module: ActionView::Helpers::FormTagHelper
- Extended by:
- ActiveSupport::Concern
- Includes:
- ContentExfiltrationPreventionHelper, TextHelper, UrlHelper
- Included in:
- ActionView::Helpers, FormHelper, Tags::Base
- Defined in:
- lib/action_view/helpers/form_tag_helper.rb
Overview
Action View Form Tag Helpers
Provides a number of methods for creating form tags that don’t rely on an Active Record object assigned to the template like FormHelper does. Instead, you provide the names and values manually.
NOTE: The HTML options disabled
, readonly
, and multiple
can all be treated as booleans. So specifying disabled: true
will give disabled="disabled"
.
Constant Summary
Constants included from ContentExfiltrationPreventionHelper
ContentExfiltrationPreventionHelper::CLOSE_CDATA_COMMENT, ContentExfiltrationPreventionHelper::CLOSE_FORM_TAG, ContentExfiltrationPreventionHelper::CLOSE_OPTION_TAG, ContentExfiltrationPreventionHelper::CLOSE_QUOTES_COMMENT, ContentExfiltrationPreventionHelper::CONTENT_EXFILTRATION_PREVENTION_MARKUP
Constants included from TagHelper
TagHelper::ARIA_PREFIXES, TagHelper::BOOLEAN_ATTRIBUTES, TagHelper::DATA_PREFIXES, TagHelper::PRE_CONTENT_STRINGS, TagHelper::TAG_TYPES
Constants included from UrlHelper
UrlHelper::BUTTON_TAG_METHOD_VERBS
Instance Method Summary collapse
-
#button_tag(content_or_options = nil, options = nil, &block) ⇒ Object
Creates a button element that defines a
submit
button,reset
button or a generic button which can be used in JavaScript, for example. -
#check_box_tag(name, *args) ⇒ Object
:call-seq: check_box_tag(name, options = {}) check_box_tag(name, value, options = {}) check_box_tag(name, value, checked, options = {}).
-
#color_field_tag(name, value = nil, options = {}) ⇒ Object
Creates a text field of type “color”.
-
#date_field_tag(name, value = nil, options = {}) ⇒ Object
Creates a text field of type “date”.
-
#datetime_field_tag(name, value = nil, options = {}) ⇒ Object
(also: #datetime_local_field_tag)
Creates a text field of type “datetime-local”.
-
#email_field_tag(name, value = nil, options = {}) ⇒ Object
Creates a text field of type “email”.
-
#field_id(object_name, method_name, *suffixes, index: nil, namespace: nil) ⇒ Object
Generate an HTML
id
attribute value for the given name and field combination. -
#field_name(object_name, method_name, *method_names, multiple: false, index: nil) ⇒ Object
Generate an HTML
name
attribute value for the given name and field combination. -
#field_set_tag(legend = nil, options = nil, &block) ⇒ Object
Creates a field set for grouping HTML form elements.
-
#file_field_tag(name, options = {}) ⇒ Object
Creates a file upload field.
-
#form_tag(url_for_options = {}, options = {}, &block) ⇒ Object
Starts a form tag that points the action to a URL configured with
url_for_options
just like ActionController::Base#url_for. -
#hidden_field_tag(name, value = nil, options = {}) ⇒ Object
Creates a hidden form input field used to transmit data that would be lost due to HTTP’s statelessness or data that should be hidden from the user.
-
#image_submit_tag(source, options = {}) ⇒ Object
Displays an image which when clicked will submit the form.
-
#label_tag(name = nil, content_or_options = nil, options = nil, &block) ⇒ Object
Creates a label element.
-
#month_field_tag(name, value = nil, options = {}) ⇒ Object
Creates a text field of type “month”.
-
#number_field_tag(name, value = nil, options = {}) ⇒ Object
Creates a number field.
-
#password_field_tag(name = "password", value = nil, options = {}) ⇒ Object
Creates a password field, a masked text field that will hide the users input behind a mask character.
-
#radio_button_tag(name, value, *args) ⇒ Object
:call-seq: radio_button_tag(name, value, options = {}) radio_button_tag(name, value, checked, options = {}).
-
#range_field_tag(name, value = nil, options = {}) ⇒ Object
Creates a range form element.
-
#search_field_tag(name, value = nil, options = {}) ⇒ Object
Creates a text field of type “search”.
-
#select_tag(name, option_tags = nil, options = {}) ⇒ Object
Creates a dropdown selection box, or if the
:multiple
option is set to true, a multiple choice selection box. -
#submit_tag(value = "Save changes", options = {}) ⇒ Object
Creates a submit button with the text
value
as the caption. -
#telephone_field_tag(name, value = nil, options = {}) ⇒ Object
(also: #phone_field_tag)
Creates a text field of type “tel”.
-
#text_area_tag(name, content = nil, options = {}) ⇒ Object
Creates a text input area; use a textarea for longer text inputs such as blog posts or descriptions.
-
#text_field_tag(name, value = nil, options = {}) ⇒ Object
Creates a standard text field; use these text fields to input smaller chunks of text like a username or a search query.
-
#time_field_tag(name, value = nil, options = {}) ⇒ Object
Creates a text field of type “time”.
-
#url_field_tag(name, value = nil, options = {}) ⇒ Object
Creates a text field of type “url”.
-
#utf8_enforcer_tag ⇒ Object
Creates the hidden UTF-8 enforcer tag.
-
#week_field_tag(name, value = nil, options = {}) ⇒ Object
Creates a text field of type “week”.
Methods included from ContentExfiltrationPreventionHelper
Methods included from TextHelper
#concat, #current_cycle, #cycle, #excerpt, #highlight, #pluralize, #reset_cycle, #safe_concat, #simple_format, #truncate, #word_wrap
Methods included from OutputSafetyHelper
#raw, #safe_join, #to_sentence
Methods included from TagHelper
build_tag_values, #cdata_section, #content_tag, #escape_once, #tag, #token_list
Methods included from CaptureHelper
#capture, #content_for, #content_for?, #provide, #with_output_buffer
Methods included from SanitizeHelper
#sanitize, #sanitize_css, #strip_links, #strip_tags
Methods included from UrlHelper
#button_to, #current_page?, #link_to, #link_to_if, #link_to_unless, #link_to_unless_current, #mail_to, #phone_to, #sms_to, #url_for
Instance Method Details
#button_tag(content_or_options = nil, options = nil, &block) ⇒ Object
Creates a button element that defines a submit
button, reset
button or a generic button which can be used in JavaScript, for example. You can use the button tag as a regular submit tag but it isn’t supported in legacy browsers. However, the button tag does allow for richer labels such as images and emphasis, so this helper will also accept a block. By default, it will create a button tag with type submit
, if type is not given.
Options
-
:data
- This option can be used to add custom data attributes. -
:disabled
- If true, the user will not be able to use this input. -
Any other key creates standard HTML options for the tag.
Examples
# => <button name="button" type="submit">Button</button>
'Reset', type: 'reset'
# => <button name="button" type="reset">Reset</button>
'Button', type: 'button'
# => <button name="button" type="button">Button</button>
'Reset', type: 'reset', disabled: true
# => <button name="button" type="reset" disabled="disabled">Reset</button>
(type: 'button') do
content_tag(:strong, 'Ask me!')
end
# => <button name="button" type="button">
# <strong>Ask me!</strong>
# </button>
Deprecated: Rails UJS attributes
Prior to Rails 7, Rails shipped with a JavaScript library called @rails/ujs on by default. Following Rails 7, this library is no longer on by default. This library integrated with the following options:
-
confirm: 'question?'
- If present, the unobtrusive JavaScript drivers will provide a prompt with the question specified. If the user accepts, the form is processed normally, otherwise no action is taken. -
:disable_with
- Value of this parameter will be used as the value for a disabled version of the submit button when the form is submitted. This feature is provided by the unobtrusive JavaScript driver.button_tag “Save”, data: { confirm: “Are you sure?” } # => <button name=“button” type=“submit” data-confirm=“Are you sure?”>Save</button>
button_tag “Checkout”, data: { disable_with: “Please wait…” } # => <button data-disable-with=“Please wait…” name=“button” type=“submit”>Checkout</button>
605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 605 def ( = nil, = nil, &block) if .is_a? Hash = else ||= {} end = { "name" => "button", "type" => "submit" }.merge!(.stringify_keys) if block_given? content_tag :button, , &block else content_tag :button, || "Button", end end |
#check_box_tag(name, *args) ⇒ Object
:call-seq:
check_box_tag(name, = {})
check_box_tag(name, value, = {})
check_box_tag(name, value, checked, = {})
Creates a check box form input tag.
Options
-
:value
- The value of the input. Defaults to"1"
. -
:checked
- If set to true, the checkbox will be checked by default. -
:disabled
- If set to true, the user will not be able to use this input. -
Any other key creates standard HTML options for the tag.
Examples
check_box_tag 'accept'
# => <input id="accept" name="accept" type="checkbox" value="1" />
check_box_tag 'rock', 'rock music'
# => <input id="rock" name="rock" type="checkbox" value="rock music" />
check_box_tag 'receive_email', 'yes', true
# => <input checked="checked" id="receive_email" name="receive_email" type="checkbox" value="yes" />
check_box_tag 'tos', 'yes', false, class: 'accept_tos'
# => <input class="accept_tos" id="tos" name="tos" type="checkbox" value="yes" />
check_box_tag 'eula', 'accepted', false, disabled: true
# => <input disabled="disabled" id="eula" name="eula" type="checkbox" value="accepted" />
455 456 457 458 459 460 461 462 463 464 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 455 def check_box_tag(name, *args) if args.length >= 4 raise ArgumentError, "wrong number of arguments (given #{args.length + 1}, expected 1..4)" end = args. value, checked = args.empty? ? ["1", false] : [*args, false] = { "type" => "checkbox", "name" => name, "id" => sanitize_to_id(name), "value" => value }.update(.stringify_keys) ["checked"] = "checked" if checked tag :input, end |
#color_field_tag(name, value = nil, options = {}) ⇒ Object
Creates a text field of type “color”.
Options
Supports the same options as #text_field_tag.
Examples
color_field_tag 'name'
# => <input id="name" name="name" type="color" />
color_field_tag 'color', '#DEF726'
# => <input id="color" name="color" type="color" value="#DEF726" />
color_field_tag 'color', nil, class: 'special_input'
# => <input class="special_input" id="color" name="color" type="color" />
color_field_tag 'color', '#DEF726', class: 'special_input', disabled: true
# => <input disabled="disabled" class="special_input" id="color" name="color" type="color" value="#DEF726" />
703 704 705 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 703 def color_field_tag(name, value = nil, = {}) text_field_tag(name, value, .merge(type: :color)) end |
#date_field_tag(name, value = nil, options = {}) ⇒ Object
Creates a text field of type “date”.
Options
Supports the same options as #text_field_tag.
Examples
date_field_tag 'name'
# => <input id="name" name="name" type="date" />
date_field_tag 'date', '01/01/2014'
# => <input id="date" name="date" type="date" value="01/01/2014" />
date_field_tag 'date', nil, class: 'special_input'
# => <input class="special_input" id="date" name="date" type="date" />
date_field_tag 'date', '01/01/2014', class: 'special_input', disabled: true
# => <input disabled="disabled" class="special_input" id="date" name="date" type="date" value="01/01/2014" />
773 774 775 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 773 def date_field_tag(name, value = nil, = {}) text_field_tag(name, value, .merge(type: :date)) end |
#datetime_field_tag(name, value = nil, options = {}) ⇒ Object Also known as: datetime_local_field_tag
Creates a text field of type “datetime-local”.
Options
Supports the same options as #text_field_tag. Additionally, supports:
-
:min
- The minimum acceptable value. -
:max
- The maximum acceptable value. -
:step
- The acceptable value granularity. -
:include_seconds
- Include seconds in the output timestamp format (true by default).
801 802 803 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 801 def datetime_field_tag(name, value = nil, = {}) text_field_tag(name, value, .merge(type: "datetime-local")) end |
#email_field_tag(name, value = nil, options = {}) ⇒ Object
Creates a text field of type “email”.
Options
Supports the same options as #text_field_tag.
Examples
email_field_tag 'name'
# => <input id="name" name="name" type="email" />
email_field_tag 'email', 'email@example.com'
# => <input id="email" name="email" type="email" value="email@example.com" />
email_field_tag 'email', nil, class: 'special_input'
# => <input class="special_input" id="email" name="email" type="email" />
email_field_tag 'email', 'email@example.com', class: 'special_input', disabled: true
# => <input disabled="disabled" class="special_input" id="email" name="email" type="email" value="email@example.com" />
875 876 877 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 875 def email_field_tag(name, value = nil, = {}) text_field_tag(name, value, .merge(type: :email)) end |
#field_id(object_name, method_name, *suffixes, index: nil, namespace: nil) ⇒ Object
Generate an HTML id
attribute value for the given name and field combination
Return the value generated by the FormBuilder
for the given attribute name.
<%= label_tag :post, :title %>
<%= text_field_tag :post, :title, aria: { describedby: field_id(:post, :title, :error) } %>
<%= tag.span("is blank", id: field_id(:post, :title, :error) %>
In the example above, the <input type="text">
element built by the call to text_field_tag
declares an aria-describedby
attribute referencing the <span>
element, sharing a common id
root (post_title
, in this case).
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 102 def field_id(object_name, method_name, *suffixes, index: nil, namespace: nil) if object_name.respond_to?(:model_name) object_name = object_name.model_name.singular end sanitized_object_name = object_name.to_s.gsub(/\]\[|[^-a-zA-Z0-9:.]/, "_").delete_suffix("_") sanitized_method_name = method_name.to_s.delete_suffix("?") [ namespace, sanitized_object_name.presence, (index unless sanitized_object_name.empty?), sanitized_method_name, *suffixes, ].tap(&:compact!).join("_") end |
#field_name(object_name, method_name, *method_names, multiple: false, index: nil) ⇒ Object
Generate an HTML name
attribute value for the given name and field combination
Return the value generated by the FormBuilder
for the given attribute name.
<%= text_field_tag :post, :title, name: field_name(:post, :title, :subtitle) %>
<%# => <input type="text" name="post[title][subtitle]">
<%= text_field_tag :post, :tag, name: field_name(:post, :tag, multiple: true) %>
<%# => <input type="text" name="post[tag][]">
132 133 134 135 136 137 138 139 140 141 142 143 144 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 132 def field_name(object_name, method_name, *method_names, multiple: false, index: nil) names = method_names.map! { |name| "[#{name}]" }.join # a little duplication to construct fewer strings case when object_name.blank? "#{method_name}#{names}#{multiple ? "[]" : ""}" when index "#{object_name}[#{index}][#{method_name}]#{names}#{multiple ? "[]" : ""}" else "#{object_name}[#{method_name}]#{names}#{multiple ? "[]" : ""}" end end |
#field_set_tag(legend = nil, options = nil, &block) ⇒ Object
Creates a field set for grouping HTML form elements.
legend
will become the fieldset’s title (optional as per W3C). options
accept the same values as tag.
Examples
<%= field_set_tag do %>
<p><%= text_field_tag 'name' %></p>
<% end %>
# => <fieldset><p><input id="name" name="name" type="text" /></p></fieldset>
<%= field_set_tag 'Your details' do %>
<p><%= text_field_tag 'name' %></p>
<% end %>
# => <fieldset><legend>Your details</legend><p><input id="name" name="name" type="text" /></p></fieldset>
<%= field_set_tag nil, class: 'format' do %>
<p><%= text_field_tag 'name' %></p>
<% end %>
# => <fieldset class="format"><p><input id="name" name="name" type="text" /></p></fieldset>
677 678 679 680 681 682 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 677 def field_set_tag(legend = nil, = nil, &block) output = tag(:fieldset, , true) output.safe_concat(content_tag("legend", legend)) unless legend.blank? output.concat(capture(&block)) if block_given? output.safe_concat("</fieldset>") end |
#file_field_tag(name, options = {}) ⇒ Object
Creates a file upload field. If you are using file uploads then you will also need to set the multipart option for the form tag:
<%= form_tag '/upload', multipart: true do %>
<label for="file">File to Upload</label> <%= file_field_tag "file" %>
<%= submit_tag %>
<% end %>
The specified URL will then be passed a File object containing the selected file, or if the field was left blank, a StringIO object.
Options
-
Creates standard HTML attributes for the tag.
-
:disabled
- If set to true, the user will not be able to use this input. -
:multiple
- If set to true, *in most updated browsers* the user will be allowed to select multiple files. -
:accept
- If set to one or multiple mime-types, the user will be suggested a filter when choosing a file. You still need to set up model validations.
Examples
file_field_tag 'attachment'
# => <input id="attachment" name="attachment" type="file" />
file_field_tag 'avatar', class: 'profile_input'
# => <input class="profile_input" id="avatar" name="avatar" type="file" />
file_field_tag 'picture', disabled: true
# => <input disabled="disabled" id="picture" name="picture" type="file" />
file_field_tag 'resume', value: '~/resume.doc'
# => <input id="resume" name="resume" type="file" value="~/resume.doc" />
file_field_tag 'user_pic', accept: 'image/png,image/gif,image/jpeg'
# => <input accept="image/png,image/gif,image/jpeg" id="user_pic" name="user_pic" type="file" />
file_field_tag 'file', accept: 'text/html', class: 'upload', value: 'index.html'
# => <input accept="text/html" class="upload" id="file" name="file" type="file" value="index.html" />
347 348 349 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 347 def file_field_tag(name, = {}) text_field_tag(name, nil, convert_direct_upload_option_to_url(.merge(type: :file))) end |
#form_tag(url_for_options = {}, options = {}, &block) ⇒ Object
Starts a form tag that points the action to a URL configured with url_for_options
just like ActionController::Base#url_for. The method for the form defaults to POST.
Options
-
:multipart
- If set to true, the enctype is set to “multipart/form-data”. -
:method
- The method to use when submitting the form, usually either “get” or “post”. If “patch”, “put”, “delete”, or another verb is used, a hidden input with name_method
is added to simulate the verb over post. -
:authenticity_token
- Authenticity token to use in the form. Use only if you need to pass custom authenticity token string, or to not add authenticity_token field at all (by passingfalse
). Remote forms may omit the embedded authenticity token by settingconfig.action_view.embed_authenticity_token_in_remote_forms = false
. This is helpful when you’re fragment-caching the form. Remote forms get the authenticity token from themeta
tag, so embedding is unnecessary unless you support browsers without JavaScript. -
:remote
- If set to true, will allow the Unobtrusive JavaScript drivers to control the submit behavior. By default this behavior is an ajax submit. -
:enforce_utf8
- If set to false, a hidden input with name utf8 is not output. -
Any other key creates standard HTML attributes for the tag.
Examples
form_tag('/posts')
# => <form action="/posts" method="post">
form_tag('/posts/1', method: :put)
# => <form action="/posts/1" method="post"> ... <input name="_method" type="hidden" value="put" /> ...
form_tag('/upload', multipart: true)
# => <form action="/upload" method="post" enctype="multipart/form-data">
<%= form_tag('/posts') do -%>
<div><%= submit_tag 'Save' %></div>
<% end -%>
# => <form action="/posts" method="post"><div><input type="submit" name="commit" value="Save" /></div></form>
<%= form_tag('/posts', remote: true) %>
# => <form action="/posts" method="post" data-remote="true">
form_tag(false, method: :get)
# => <form method="get">
form_tag('http://far.away.com/form', authenticity_token: false)
# form without authenticity token
form_tag('http://far.away.com/form', authenticity_token: "cf50faa3fe97702ca1ae")
# form with custom authenticity token
78 79 80 81 82 83 84 85 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 78 def form_tag( = {}, = {}, &block) = (, ) if block_given? form_tag_with_body(, capture(&block)) else form_tag_html() end end |
#hidden_field_tag(name, value = nil, options = {}) ⇒ Object
Creates a hidden form input field used to transmit data that would be lost due to HTTP’s statelessness or data that should be hidden from the user.
Options
-
Creates standard HTML attributes for the tag.
Examples
hidden_field_tag 'tags_list'
# => <input type="hidden" name="tags_list" id="tags_list" autocomplete="off" />
hidden_field_tag 'token', 'VUBJKB23UIVI1UU1VOBVI@'
# => <input type="hidden" name="token" id="token" value="VUBJKB23UIVI1UU1VOBVI@" autocomplete="off" />
hidden_field_tag 'collected_input', '', onchange: "alert('Input collected!')"
# => <input type="hidden" name="collected_input" id="collected_input"
value="" onchange="alert('Input collected!')" autocomplete="off" />
308 309 310 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 308 def hidden_field_tag(name, value = nil, = {}) text_field_tag(name, value, .merge(type: :hidden, autocomplete: "off")) end |
#image_submit_tag(source, options = {}) ⇒ Object
Displays an image which when clicked will submit the form.
source
is passed to AssetTagHelper#path_to_image
Options
-
:data
- This option can be used to add custom data attributes. -
:disabled
- If set to true, the user will not be able to use this input. -
Any other key creates standard HTML options for the tag.
Data attributes
-
confirm: 'question?'
- This will add a JavaScript confirm prompt with the question specified. If the user accepts, the form is processed normally, otherwise no action is taken.
Examples
image_submit_tag("login.png")
# => <input src="/assets/login.png" type="image" />
image_submit_tag("purchase.png", disabled: true)
# => <input disabled="disabled" src="/assets/purchase.png" type="image" />
image_submit_tag("search.png", class: 'search_button', alt: 'Find')
# => <input class="search_button" src="/assets/search.png" type="image" />
image_submit_tag("agree.png", disabled: true, class: "agree_disagree_button")
# => <input class="agree_disagree_button" disabled="disabled" src="/assets/agree.png" type="image" />
image_submit_tag("save.png", data: { confirm: "Are you sure?" })
# => <input src="/assets/save.png" data-confirm="Are you sure?" type="image" />
651 652 653 654 655 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 651 def image_submit_tag(source, = {}) = .stringify_keys src = path_to_image(source, skip_pipeline: .delete("skip_pipeline")) tag :input, { "type" => "image", "src" => src }.update() end |
#label_tag(name = nil, content_or_options = nil, options = nil, &block) ⇒ Object
Creates a label element. Accepts a block.
Options
-
Creates standard HTML attributes for the tag.
Examples
label_tag 'name'
# => <label for="name">Name</label>
label_tag 'name', 'Your name'
# => <label for="name">Your name</label>
label_tag 'name', nil, class: 'small_label'
# => <label for="name" class="small_label">Name</label>
281 282 283 284 285 286 287 288 289 290 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 281 def label_tag(name = nil, = nil, = nil, &block) if block_given? && .is_a?(Hash) = = .stringify_keys else ||= {} = .stringify_keys end ["for"] = sanitize_to_id(name) unless name.blank? || .has_key?("for") content_tag :label, || name.to_s.humanize, , &block end |
#month_field_tag(name, value = nil, options = {}) ⇒ Object
Creates a text field of type “month”.
Options
Supports the same options as #text_field_tag. Additionally, supports:
-
:min
- The minimum acceptable value. -
:max
- The maximum acceptable value. -
:step
- The acceptable value granularity.
816 817 818 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 816 def month_field_tag(name, value = nil, = {}) text_field_tag(name, value, .merge(type: :month)) end |
#number_field_tag(name, value = nil, options = {}) ⇒ Object
Creates a number field.
Options
Supports the same options as #text_field_tag. Additionally, supports:
-
:min
- The minimum acceptable value. -
:max
- The maximum acceptable value. -
:in
- A range specifying the:min
and:max
values. -
:within
- Same as:in
. -
:step
- The acceptable value granularity.
Examples
number_field_tag 'quantity'
# => <input id="quantity" name="quantity" type="number" />
number_field_tag 'quantity', '1'
# => <input id="quantity" name="quantity" type="number" value="1" />
number_field_tag 'quantity', nil, class: 'special_input'
# => <input class="special_input" id="quantity" name="quantity" type="number" />
number_field_tag 'quantity', nil, min: 1
# => <input id="quantity" name="quantity" min="1" type="number" />
number_field_tag 'quantity', nil, max: 9
# => <input id="quantity" name="quantity" max="9" type="number" />
number_field_tag 'quantity', nil, in: 1...10
# => <input id="quantity" name="quantity" min="1" max="9" type="number" />
number_field_tag 'quantity', nil, within: 1...10
# => <input id="quantity" name="quantity" min="1" max="9" type="number" />
number_field_tag 'quantity', nil, min: 1, max: 10
# => <input id="quantity" name="quantity" min="1" max="10" type="number" />
number_field_tag 'quantity', nil, min: 1, max: 10, step: 2
# => <input id="quantity" name="quantity" min="1" max="10" step="2" type="number" />
number_field_tag 'quantity', '1', class: 'special_input', disabled: true
# => <input disabled="disabled" class="special_input" id="quantity" name="quantity" type="number" value="1" />
923 924 925 926 927 928 929 930 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 923 def number_field_tag(name, value = nil, = {}) = .stringify_keys ["type"] ||= "number" if range = .delete("in") || .delete("within") .update("min" => range.min, "max" => range.max) end text_field_tag(name, value, ) end |
#password_field_tag(name = "password", value = nil, options = {}) ⇒ Object
Creates a password field, a masked text field that will hide the users input behind a mask character.
Options
-
:disabled
- If set to true, the user will not be able to use this input. -
:size
- The number of visible characters that will fit in the input. -
:maxlength
- The maximum number of characters that the browser will allow the user to enter. -
Any other key creates standard HTML attributes for the tag.
Examples
password_field_tag 'pass'
# => <input id="pass" name="pass" type="password" />
password_field_tag 'secret', 'Your secret here'
# => <input id="secret" name="secret" type="password" value="Your secret here" />
password_field_tag 'masked', nil, class: 'masked_input_field'
# => <input class="masked_input_field" id="masked" name="masked" type="password" />
password_field_tag 'token', '', size: 15
# => <input id="token" name="token" size="15" type="password" value="" />
password_field_tag 'key', nil, maxlength: 16
# => <input id="key" maxlength="16" name="key" type="password" />
password_field_tag 'confirm_pass', nil, disabled: true
# => <input disabled="disabled" id="confirm_pass" name="confirm_pass" type="password" />
password_field_tag 'pin', '1234', maxlength: 4, size: 6, class: "pin_input"
# => <input class="pin_input" id="pin" maxlength="4" name="pin" size="6" type="password" value="1234" />
380 381 382 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 380 def password_field_tag(name = "password", value = nil, = {}) text_field_tag(name, value, .merge(type: :password)) end |
#radio_button_tag(name, value, *args) ⇒ Object
:call-seq:
(name, value, = {})
(name, value, checked, = {})
Creates a radio button; use groups of radio buttons named the same to allow users to select from a group of options.
Options
-
:checked
- If set to true, the radio button will be selected by default. -
:disabled
- If set to true, the user will not be able to use this input. -
Any other key creates standard HTML options for the tag.
Examples
'favorite_color', 'maroon'
# => <input id="favorite_color_maroon" name="favorite_color" type="radio" value="maroon" />
'receive_updates', 'no', true
# => <input checked="checked" id="receive_updates_no" name="receive_updates" type="radio" value="no" />
'time_slot', "3:00 p.m.", false, disabled: true
# => <input disabled="disabled" id="time_slot_3:00_p.m." name="time_slot" type="radio" value="3:00 p.m." />
'color', "green", true, class: "color_input"
# => <input checked="checked" class="color_input" id="color_green" name="color" type="radio" value="green" />
491 492 493 494 495 496 497 498 499 500 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 491 def (name, value, *args) if args.length >= 3 raise ArgumentError, "wrong number of arguments (given #{args.length + 2}, expected 2..4)" end = args. checked = args.empty? ? false : args.first = { "type" => "radio", "name" => name, "id" => "#{sanitize_to_id(name)}_#{sanitize_to_id(value)}", "value" => value }.update(.stringify_keys) ["checked"] = "checked" if checked tag :input, end |
#range_field_tag(name, value = nil, options = {}) ⇒ Object
Creates a range form element.
Options
Supports the same options as #number_field_tag.
937 938 939 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 937 def range_field_tag(name, value = nil, = {}) number_field_tag(name, value, .merge(type: :range)) end |
#search_field_tag(name, value = nil, options = {}) ⇒ Object
Creates a text field of type “search”.
Options
Supports the same options as #text_field_tag.
Examples
search_field_tag 'name'
# => <input id="name" name="name" type="search" />
search_field_tag 'search', 'Enter your search query here'
# => <input id="search" name="search" type="search" value="Enter your search query here" />
search_field_tag 'search', nil, class: 'special_input'
# => <input class="special_input" id="search" name="search" type="search" />
search_field_tag 'search', 'Enter your search query here', class: 'special_input', disabled: true
# => <input disabled="disabled" class="special_input" id="search" name="search" type="search" value="Enter your search query here" />
726 727 728 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 726 def search_field_tag(name, value = nil, = {}) text_field_tag(name, value, .merge(type: :search)) end |
#select_tag(name, option_tags = nil, options = {}) ⇒ Object
Creates a dropdown selection box, or if the :multiple
option is set to true, a multiple choice selection box.
Helpers::FormOptions can be used to create common select boxes such as countries, time zones, or associated records. option_tags
is a string containing the option tags for the select box.
Options
-
:multiple
- If set to true, the selection will allow multiple choices. -
:disabled
- If set to true, the user will not be able to use this input. -
:include_blank
- If set to true, an empty option will be created. If set to a string, the string will be used as the option’s content and the value will be empty. -
:prompt
- Create a prompt option with blank value and the text asking user to select something. -
Any other key creates standard HTML attributes for the tag.
Examples
select_tag "people", (@people, "id", "name")
# <select id="people" name="people"><option value="1">David</option></select>
select_tag "people", (@people, "id", "name", "1")
# <select id="people" name="people"><option value="1" selected="selected">David</option></select>
select_tag "people", raw("<option>David</option>")
# => <select id="people" name="people"><option>David</option></select>
select_tag "count", raw("<option>1</option><option>2</option><option>3</option><option>4</option>")
# => <select id="count" name="count"><option>1</option><option>2</option>
# <option>3</option><option>4</option></select>
select_tag "colors", raw("<option>Red</option><option>Green</option><option>Blue</option>"), multiple: true
# => <select id="colors" multiple="multiple" name="colors[]"><option>Red</option>
# <option>Green</option><option>Blue</option></select>
select_tag "locations", raw("<option>Home</option><option selected='selected'>Work</option><option>Out</option>")
# => <select id="locations" name="locations"><option>Home</option><option selected='selected'>Work</option>
# <option>Out</option></select>
select_tag "access", raw("<option>Read</option><option>Write</option>"), multiple: true, class: 'form_input', id: 'unique_id'
# => <select class="form_input" id="unique_id" multiple="multiple" name="access[]"><option>Read</option>
# <option>Write</option></select>
select_tag "people", (@people, "id", "name"), include_blank: true
# => <select id="people" name="people"><option value="" label=" "></option><option value="1">David</option></select>
select_tag "people", (@people, "id", "name"), include_blank: "All"
# => <select id="people" name="people"><option value="">All</option><option value="1">David</option></select>
select_tag "people", (@people, "id", "name"), prompt: "Select something"
# => <select id="people" name="people"><option value="">Select something</option><option value="1">David</option></select>
select_tag "destination", raw("<option>NYC</option><option>Paris</option><option>Rome</option>"), disabled: true
# => <select disabled="disabled" id="destination" name="destination"><option>NYC</option>
# <option>Paris</option><option>Rome</option></select>
select_tag "credit_card", ([ "VISA", "MasterCard" ], "MasterCard")
# => <select id="credit_card" name="credit_card"><option>VISA</option>
# <option selected="selected">MasterCard</option></select>
201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 201 def select_tag(name, = nil, = {}) ||= "" html_name = ([:multiple] == true && !name.end_with?("[]")) ? "#{name}[]" : name if .include?(:include_blank) include_blank = [:include_blank] = .except(:include_blank) = { value: "" } if include_blank == true include_blank = "" [:label] = " " end if include_blank = content_tag("option", include_blank, ).safe_concat() end end if prompt = .delete(:prompt) = content_tag("option", prompt, value: "").safe_concat() end content_tag "select", , { "name" => html_name, "id" => sanitize_to_id(name) }.update(.stringify_keys) end |
#submit_tag(value = "Save changes", options = {}) ⇒ Object
Creates a submit button with the text value
as the caption.
Options
-
:data
- This option can be used to add custom data attributes. -
:disabled
- If true, the user will not be able to use this input. -
Any other key creates standard HTML options for the tag.
Examples
submit_tag
# => <input name="commit" data-disable-with="Save changes" type="submit" value="Save changes" />
submit_tag "Edit this article"
# => <input name="commit" data-disable-with="Edit this article" type="submit" value="Edit this article" />
submit_tag "Save edits", disabled: true
# => <input disabled="disabled" name="commit" data-disable-with="Save edits" type="submit" value="Save edits" />
submit_tag nil, class: "form_submit"
# => <input class="form_submit" name="commit" type="submit" />
submit_tag "Edit", class: "edit_button"
# => <input class="edit_button" data-disable-with="Edit" name="commit" type="submit" value="Edit" />
Deprecated: Rails UJS attributes
Prior to Rails 7, Rails shipped with the JavaScript library called @rails/ujs on by default. Following Rails 7, this library is no longer on by default. This library integrated with the following options:
-
confirm: 'question?'
- If present the unobtrusive JavaScript drivers will provide a prompt with the question specified. If the user accepts, the form is processed normally, otherwise no action is taken. -
:disable_with
- Value of this parameter will be used as the value for a disabled version of the submit button when the form is submitted. This feature is provided by the unobtrusive JavaScript driver. To disable this feature for a single submit tag pass:data => { disable_with: false }
Defaults to value attribute.submit_tag “Complete sale”, data: { disable_with: “Submitting…” } # => <input name=“commit” data-disable-with=“Submitting…” type=“submit” value=“Complete sale” />
submit_tag “Save”, data: { confirm: “Are you sure?” } # => <input name=‘commit’ type=‘submit’ value=‘Save’ data-disable-with=“Save” data-confirm=“Are you sure?” />
544 545 546 547 548 549 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 544 def submit_tag(value = "Save changes", = {}) = .deep_stringify_keys = { "type" => "submit", "name" => "commit", "value" => value }.update() set_default_disable_with value, tag :input, end |
#telephone_field_tag(name, value = nil, options = {}) ⇒ Object Also known as: phone_field_tag
Creates a text field of type “tel”.
Options
Supports the same options as #text_field_tag.
Examples
telephone_field_tag 'name'
# => <input id="name" name="name" type="tel" />
telephone_field_tag 'tel', '0123456789'
# => <input id="tel" name="tel" type="tel" value="0123456789" />
telephone_field_tag 'tel', nil, class: 'special_input'
# => <input class="special_input" id="tel" name="tel" type="tel" />
telephone_field_tag 'tel', '0123456789', class: 'special_input', disabled: true
# => <input disabled="disabled" class="special_input" id="tel" name="tel" type="tel" value="0123456789" />
749 750 751 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 749 def telephone_field_tag(name, value = nil, = {}) text_field_tag(name, value, .merge(type: :tel)) end |
#text_area_tag(name, content = nil, options = {}) ⇒ Object
Creates a text input area; use a textarea for longer text inputs such as blog posts or descriptions.
Options
-
:size
- A string specifying the dimensions (columns by rows) of the textarea (e.g., “25x10”). -
:rows
- Specify the number of rows in the textarea -
:cols
- Specify the number of columns in the textarea -
:disabled
- If set to true, the user will not be able to use this input. -
:escape
- By default, the contents of the text input are HTML escaped. If you need unescaped contents, set this to false. -
Any other key creates standard HTML attributes for the tag.
Examples
text_area_tag 'post'
# => <textarea id="post" name="post"></textarea>
text_area_tag 'bio', @user.bio
# => <textarea id="bio" name="bio">This is my biography.</textarea>
text_area_tag 'body', nil, rows: 10, cols: 25
# => <textarea cols="25" id="body" name="body" rows="10"></textarea>
text_area_tag 'body', nil, size: "25x10"
# => <textarea name="body" id="body" cols="25" rows="10"></textarea>
text_area_tag 'description', "Description goes here.", disabled: true
# => <textarea disabled="disabled" id="description" name="description">Description goes here.</textarea>
text_area_tag 'comment', nil, class: 'comment_input'
# => <textarea class="comment_input" id="comment" name="comment"></textarea>
413 414 415 416 417 418 419 420 421 422 423 424 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 413 def text_area_tag(name, content = nil, = {}) = .stringify_keys if size = .delete("size") ["cols"], ["rows"] = size.split("x") if size.respond_to?(:split) end escape = .delete("escape") { true } content = ERB::Util.html_escape(content) if escape content_tag :textarea, content.to_s.html_safe, { "name" => name, "id" => sanitize_to_id(name) }.update() end |
#text_field_tag(name, value = nil, options = {}) ⇒ Object
Creates a standard text field; use these text fields to input smaller chunks of text like a username or a search query.
Options
-
:disabled
- If set to true, the user will not be able to use this input. -
:size
- The number of visible characters that will fit in the input. -
:maxlength
- The maximum number of characters that the browser will allow the user to enter. -
:placeholder
- The text contained in the field by default which is removed when the field receives focus. If set to true, use the translation found in the current I18n locale (through helpers.placeholder.<modelname>.<attribute>). -
Any other key creates standard HTML attributes for the tag.
Examples
text_field_tag 'name'
# => <input id="name" name="name" type="text" />
text_field_tag 'query', 'Enter your search query here'
# => <input id="query" name="query" type="text" value="Enter your search query here" />
text_field_tag 'search', nil, placeholder: 'Enter search term...'
# => <input id="search" name="search" placeholder="Enter search term..." type="text" />
text_field_tag 'request', nil, class: 'special_input'
# => <input class="special_input" id="request" name="request" type="text" />
text_field_tag 'address', '', size: 75
# => <input id="address" name="address" size="75" type="text" value="" />
text_field_tag 'zip', nil, maxlength: 5
# => <input id="zip" maxlength="5" name="zip" type="text" />
text_field_tag 'payment_amount', '$0.00', disabled: true
# => <input disabled="disabled" id="payment_amount" name="payment_amount" type="text" value="$0.00" />
text_field_tag 'ip', '0.0.0.0', maxlength: 15, size: 20, class: "ip-input"
# => <input class="ip-input" id="ip" maxlength="15" name="ip" size="20" type="text" value="0.0.0.0" />
263 264 265 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 263 def text_field_tag(name, value = nil, = {}) tag :input, { "type" => "text", "name" => name, "id" => sanitize_to_id(name), "value" => value }.update(.stringify_keys) end |
#time_field_tag(name, value = nil, options = {}) ⇒ Object
Creates a text field of type “time”.
Options
Supports the same options as #text_field_tag. Additionally, supports:
-
:min
- The minimum acceptable value. -
:max
- The maximum acceptable value. -
:step
- The acceptable value granularity. -
:include_seconds
- Include seconds and ms in the output timestamp format (true by default).
787 788 789 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 787 def time_field_tag(name, value = nil, = {}) text_field_tag(name, value, .merge(type: :time)) end |
#url_field_tag(name, value = nil, options = {}) ⇒ Object
Creates a text field of type “url”.
Options
Supports the same options as #text_field_tag.
Examples
url_field_tag 'name'
# => <input id="name" name="name" type="url" />
url_field_tag 'url', 'http://rubyonrails.org'
# => <input id="url" name="url" type="url" value="http://rubyonrails.org" />
url_field_tag 'url', nil, class: 'special_input'
# => <input class="special_input" id="url" name="url" type="url" />
url_field_tag 'url', 'http://rubyonrails.org', class: 'special_input', disabled: true
# => <input disabled="disabled" class="special_input" id="url" name="url" type="url" value="http://rubyonrails.org" />
852 853 854 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 852 def url_field_tag(name, value = nil, = {}) text_field_tag(name, value, .merge(type: :url)) end |
#utf8_enforcer_tag ⇒ Object
Creates the hidden UTF-8 enforcer tag. Override this method in a helper to customize the tag.
943 944 945 946 947 948 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 943 def utf8_enforcer_tag # Use raw HTML to ensure the value is written as an HTML entity; it # needs to be the right character regardless of which encoding the # browser infers. '<input name="utf8" type="hidden" value="✓" autocomplete="off" />'.html_safe end |
#week_field_tag(name, value = nil, options = {}) ⇒ Object
Creates a text field of type “week”.
Options
Supports the same options as #text_field_tag. Additionally, supports:
-
:min
- The minimum acceptable value. -
:max
- The maximum acceptable value. -
:step
- The acceptable value granularity.
829 830 831 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 829 def week_field_tag(name, value = nil, = {}) text_field_tag(name, value, .merge(type: :week)) end |