module ActionView::Helpers::FormTagHelper
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"
.
Public Instance Methods
Creates a check box form input tag.
Options¶ ↑
-
: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" />
# File lib/action_view/helpers/form_tag_helper.rb, line 443 def check_box_tag(name, value = "1", checked = false, options = {}) html_options = { "type" => "checkbox", "name" => name, "id" => sanitize_to_id(name), "value" => value }.update(options.stringify_keys) html_options["checked"] = "checked" if checked tag :input, html_options end
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" />
# File lib/action_view/helpers/form_tag_helper.rb, line 675 def color_field_tag(name, value = nil, options = {}) text_field_tag(name, value, options.merge(type: :color)) end
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" />
# File lib/action_view/helpers/form_tag_helper.rb, line 745 def date_field_tag(name, value = nil, options = {}) text_field_tag(name, value, options.merge(type: :date)) end
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.
# File lib/action_view/helpers/form_tag_helper.rb, line 772 def datetime_field_tag(name, value = nil, options = {}) text_field_tag(name, value, options.merge(type: "datetime-local")) end
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" />
# File lib/action_view/helpers/form_tag_helper.rb, line 846 def email_field_tag(name, value = nil, options = {}) text_field_tag(name, value, options.merge(type: :email)) end
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).
# File lib/action_view/helpers/form_tag_helper.rb, line 98 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
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][]">
# File lib/action_view/helpers/form_tag_helper.rb, line 128 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
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>
# File lib/action_view/helpers/form_tag_helper.rb, line 649 def field_set_tag(legend = nil, options = nil, &block) output = tag(:fieldset, options, true) output.safe_concat(content_tag("legend", legend)) unless legend.blank? output.concat(capture(&block)) if block_given? output.safe_concat("</fieldset>") end
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" />
# File lib/action_view/helpers/form_tag_helper.rb, line 343 def file_field_tag(name, options = {}) text_field_tag(name, nil, convert_direct_upload_option_to_url(options.merge(type: :file))) end
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
# File lib/action_view/helpers/form_tag_helper.rb, line 74 def form_tag(url_for_options = {}, options = {}, &block) html_options = html_options_for_form(url_for_options, options) if block_given? form_tag_with_body(html_options, capture(&block)) else form_tag_html(html_options) end end
Displays an image which when clicked will submit the form.
source
is passed to ActionView::Helpers::AssetUrlHelper#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" />
# File lib/action_view/helpers/form_tag_helper.rb, line 623 def image_submit_tag(source, options = {}) options = options.stringify_keys src = path_to_image(source, skip_pipeline: options.delete("skip_pipeline")) tag :input, { "type" => "image", "src" => src }.update(options) end
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>
# File lib/action_view/helpers/form_tag_helper.rb, line 277 def label_tag(name = nil, content_or_options = nil, options = nil, &block) if block_given? && content_or_options.is_a?(Hash) options = content_or_options = content_or_options.stringify_keys else options ||= {} options = options.stringify_keys end options["for"] = sanitize_to_id(name) unless name.blank? || options.has_key?("for") content_tag :label, content_or_options || name.to_s.humanize, options, &block end
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.
# File lib/action_view/helpers/form_tag_helper.rb, line 787 def month_field_tag(name, value = nil, options = {}) text_field_tag(name, value, options.merge(type: :month)) end
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" />
# File lib/action_view/helpers/form_tag_helper.rb, line 894 def number_field_tag(name, value = nil, options = {}) options = options.stringify_keys options["type"] ||= "number" if range = options.delete("in") || options.delete("within") options.update("min" => range.min, "max" => range.max) end text_field_tag(name, value, options) end
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" />
# File lib/action_view/helpers/form_tag_helper.rb, line 376 def password_field_tag(name = "password", value = nil, options = {}) text_field_tag(name, value, options.merge(type: :password)) end
Creates a range form element.
Options¶ ↑
Supports the same options as number_field_tag.
# File lib/action_view/helpers/form_tag_helper.rb, line 908 def range_field_tag(name, value = nil, options = {}) number_field_tag(name, value, options.merge(type: :range)) end
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" />
# File lib/action_view/helpers/form_tag_helper.rb, line 698 def search_field_tag(name, value = nil, options = {}) text_field_tag(name, value, options.merge(type: :search)) end
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", options_from_collection_for_select(@people, "id", "name") # <select id="people" name="people"><option value="1">David</option></select> select_tag "people", options_from_collection_for_select(@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", options_from_collection_for_select(@people, "id", "name"), include_blank: true # => <select id="people" name="people"><option value="" label=" "></option><option value="1">David</option></select> select_tag "people", options_from_collection_for_select(@people, "id", "name"), include_blank: "All" # => <select id="people" name="people"><option value="">All</option><option value="1">David</option></select> select_tag "people", options_from_collection_for_select(@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", options_for_select([ "VISA", "MasterCard" ], "MasterCard") # => <select id="credit_card" name="credit_card"><option>VISA</option> # <option selected="selected">MasterCard</option></select>
# File lib/action_view/helpers/form_tag_helper.rb, line 197 def select_tag(name, option_tags = nil, options = {}) option_tags ||= "" html_name = (options[:multiple] == true && !name.end_with?("[]")) ? "#{name}[]" : name if options.include?(:include_blank) include_blank = options[:include_blank] options = options.except(:include_blank) options_for_blank_options_tag = { value: "" } if include_blank == true include_blank = "" options_for_blank_options_tag[:label] = " " end if include_blank option_tags = content_tag("option", include_blank, options_for_blank_options_tag).safe_concat(option_tags) end end if prompt = options.delete(:prompt) option_tags = content_tag("option", prompt, value: "").safe_concat(option_tags) end content_tag "select", option_tags, { "name" => html_name, "id" => sanitize_to_id(name) }.update(options.stringify_keys) end
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?” />
# File lib/action_view/helpers/form_tag_helper.rb, line 516 def submit_tag(value = "Save changes", options = {}) options = options.deep_stringify_keys tag_options = { "type" => "submit", "name" => "commit", "value" => value }.update(options) set_default_disable_with value, tag_options tag :input, tag_options end
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" />
# File lib/action_view/helpers/form_tag_helper.rb, line 721 def telephone_field_tag(name, value = nil, options = {}) text_field_tag(name, value, options.merge(type: :tel)) end
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>
# File lib/action_view/helpers/form_tag_helper.rb, line 409 def text_area_tag(name, content = nil, options = {}) options = options.stringify_keys if size = options.delete("size") options["cols"], options["rows"] = size.split("x") if size.respond_to?(:split) end escape = options.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(options) end
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" />
# File lib/action_view/helpers/form_tag_helper.rb, line 259 def text_field_tag(name, value = nil, options = {}) tag :input, { "type" => "text", "name" => name, "id" => sanitize_to_id(name), "value" => value }.update(options.stringify_keys) end
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).
# File lib/action_view/helpers/form_tag_helper.rb, line 759 def time_field_tag(name, value = nil, options = {}) text_field_tag(name, value, options.merge(type: :time)) end
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" />
# File lib/action_view/helpers/form_tag_helper.rb, line 823 def url_field_tag(name, value = nil, options = {}) text_field_tag(name, value, options.merge(type: :url)) end
Creates the hidden UTF-8 enforcer tag. Override this method in a helper to customize the tag.
# File lib/action_view/helpers/form_tag_helper.rb, line 914 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
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.
# File lib/action_view/helpers/form_tag_helper.rb, line 800 def week_field_tag(name, value = nil, options = {}) text_field_tag(name, value, options.merge(type: :week)) end
Private Instance Methods
# File lib/action_view/helpers/form_tag_helper.rb, line 1010 def convert_direct_upload_option_to_url(options) if options.delete(:direct_upload) && respond_to?(:rails_direct_uploads_url) options["data-direct-upload-url"] = rails_direct_uploads_url end options end
# File lib/action_view/helpers/form_tag_helper.rb, line 979 def form_tag_html(html_options) extra_tags = extra_tags_for_form(html_options) tag(:form, html_options, true) + extra_tags end
# File lib/action_view/helpers/form_tag_helper.rb, line 984 def form_tag_with_body(html_options, content) output = form_tag_html(html_options) output << content.to_s if content output.safe_concat("</form>") end
# File lib/action_view/helpers/form_tag_helper.rb, line 922 def html_options_for_form(url_for_options, options) options.stringify_keys.tap do |html_options| html_options["enctype"] = "multipart/form-data" if html_options.delete("multipart") # The following URL is unescaped, this is just a hash of options, and it is the # responsibility of the caller to escape all the values. if url_for_options == false || html_options["action"] == false html_options.delete("action") else html_options["action"] = url_for(url_for_options) end html_options["accept-charset"] = "UTF-8" html_options["data-remote"] = true if html_options.delete("remote") if html_options["data-remote"] && embed_authenticity_token_in_remote_forms == false && html_options["authenticity_token"].blank? # The authenticity token is taken from the meta tag in this case html_options["authenticity_token"] = false elsif html_options["authenticity_token"] == true # Include the default authenticity_token, which is only generated when its set to nil, # but we needed the true value to override the default of no authenticity_token on data-remote. html_options["authenticity_token"] = nil end end end
see www.w3.org/TR/html4/types.html#type-name
# File lib/action_view/helpers/form_tag_helper.rb, line 991 def sanitize_to_id(name) name.to_s.delete("]").tr("^-a-zA-Z0-9:.", "_") end
# File lib/action_view/helpers/form_tag_helper.rb, line 995 def set_default_disable_with(value, tag_options) data = tag_options.fetch("data", {}) if tag_options["data-disable-with"] == false || data["disable_with"] == false data.delete("disable_with") elsif ActionView::Base.automatically_disable_submit_tag disable_with_text = tag_options["data-disable-with"] disable_with_text ||= data["disable_with"] disable_with_text ||= value.to_s.clone tag_options.deep_merge!("data" => { "disable_with" => disable_with_text }) end tag_options.delete("data-disable-with") end