Module: ActionView::Helpers::FormTagHelper
- Extended by:
- ActiveSupport::Concern
- Includes:
- TextHelper, UrlHelper
- Included in:
- ActionView::Helpers, FormHelper, Tags::Base
- Defined in:
- lib/action_view/helpers/form_tag_helper.rb
Overview
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 TagHelper
TagHelper::BOOLEAN_ATTRIBUTES, TagHelper::PRE_CONTENT_STRINGS
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, value = "1", checked = false, options = {}) ⇒ Object
Creates a check box form input tag.
-
#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
Creates a text field of type “datetime”.
-
#datetime_local_field_tag(name, value = nil, options = {}) ⇒ Object
Creates a text field of type “datetime-local”.
-
#email_field_tag(name, value = nil, options = {}) ⇒ Object
Creates a text field of type “email”.
-
#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 an 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, checked = false, options = {}) ⇒ Object
Creates a radio button; use groups of radio buttons named the same to allow users to select from a group of 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 UTF8 enforcer tag.
-
#week_field_tag(name, value = nil, options = {}) ⇒ Object
Creates a text field of type “week”.
Methods included from TextHelper
#concat, #current_cycle, #cycle, #excerpt, #highlight, #pluralize, #reset_cycle, #safe_concat, #simple_format, #truncate, #word_wrap
Methods included from OutputSafetyHelper
Methods included from TagHelper
#cdata_section, #content_tag, #escape_once, #tag
Methods included from CaptureHelper
#capture, #content_for, #content_for?, #flush_output_buffer, #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, #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 allows richer labels such as images and emphasis, so this helper will also accept a block.
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.
Data attributes
-
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.
Examples
# => <button name="button" type="submit">Button</button>
(type: 'button') do
content_tag(:strong, 'Ask me!')
end
# => <button name="button" type="button">
# <strong>Ask me!</strong>
# </button>
"Checkout", data: { disable_with: "Please wait..." }
# => <button data-disable-with="Please wait..." name="button" type="submit">Checkout</button>
479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 479 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, value = "1", checked = false, options = {}) ⇒ Object
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" />
366 367 368 369 370 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 366 def check_box_tag(name, value = "1", checked = 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
-
Accepts the same options as text_field_tag.
561 562 563 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 561 def color_field_tag(name, value = nil, = {}) text_field_tag(name, value, .stringify_keys.update("type" => "color")) end |
#date_field_tag(name, value = nil, options = {}) ⇒ Object
Creates a text field of type “date”.
Options
-
Accepts the same options as text_field_tag.
586 587 588 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 586 def date_field_tag(name, value = nil, = {}) text_field_tag(name, value, .stringify_keys.update("type" => "date")) end |
#datetime_field_tag(name, value = nil, options = {}) ⇒ Object
Creates a text field of type “datetime”.
Options
-
:min
- The minimum acceptable value. -
:max
- The maximum acceptable value. -
:step
- The acceptable value granularity. -
Otherwise accepts the same options as text_field_tag.
608 609 610 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 608 def datetime_field_tag(name, value = nil, = {}) text_field_tag(name, value, .stringify_keys.update("type" => "datetime")) end |
#datetime_local_field_tag(name, value = nil, options = {}) ⇒ Object
Creates a text field of type “datetime-local”.
Options
-
:min
- The minimum acceptable value. -
:max
- The maximum acceptable value. -
:step
- The acceptable value granularity. -
Otherwise accepts the same options as text_field_tag.
619 620 621 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 619 def datetime_local_field_tag(name, value = nil, = {}) text_field_tag(name, value, .stringify_keys.update("type" => "datetime-local")) end |
#email_field_tag(name, value = nil, options = {}) ⇒ Object
Creates a text field of type “email”.
Options
-
Accepts the same options as text_field_tag.
657 658 659 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 657 def email_field_tag(name, value = nil, = {}) text_field_tag(name, value, .stringify_keys.update("type" => "email")) 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>
550 551 552 553 554 555 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 550 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" />
266 267 268 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 266 def file_field_tag(name, = {}) text_field_tag(name, nil, .update("type" => "file")) end |
#form_tag(url_for_options = {}, options = {}, &block) ⇒ Object
Starts a form tag that points the action to an 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('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
67 68 69 70 71 72 73 74 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 67 def form_tag( = {}, = {}, &block) = (, ) if block_given? form_tag_in_block(, &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 id="tags_list" name="tags_list" type="hidden" />
hidden_field_tag 'token', 'VUBJKB23UIVI1UU1VOBVI@'
# => <input id="token" name="token" type="hidden" value="VUBJKB23UIVI1UU1VOBVI@" />
hidden_field_tag 'collected_input', '', onchange: "alert('Input collected!')"
# => <input id="collected_input" name="collected_input" onchange="alert('Input collected!')"
# type="hidden" value="" />
227 228 229 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 227 def hidden_field_tag(name, value = nil, = {}) text_field_tag(name, value, .stringify_keys.update("type" => "hidden")) 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 alt="Login" src="/images/login.png" type="image" />
image_submit_tag("purchase.png", disabled: true)
# => <input alt="Purchase" disabled="disabled" src="/images/purchase.png" type="image" />
image_submit_tag("search.png", class: 'search_button', alt: 'Find')
# => <input alt="Find" class="search_button" src="/images/search.png" type="image" />
image_submit_tag("agree.png", disabled: true, class: "agree_disagree_button")
# => <input alt="Agree" class="agree_disagree_button" disabled="disabled" src="/images/agree.png" type="image" />
image_submit_tag("save.png", data: { confirm: "Are you sure?" })
# => <input alt="Save" src="/images/save.png" data-confirm="Are you sure?" type="image" />
525 526 527 528 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 525 def image_submit_tag(source, = {}) = .stringify_keys tag :input, { "alt" => image_alt(source), "type" => "image", "src" => path_to_image(source) }.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>
200 201 202 203 204 205 206 207 208 209 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 200 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
-
:min
- The minimum acceptable value. -
:max
- The maximum acceptable value. -
:step
- The acceptable value granularity. -
Otherwise accepts the same options as text_field_tag.
630 631 632 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 630 def month_field_tag(name, value = nil, = {}) text_field_tag(name, value, .stringify_keys.update("type" => "month")) end |
#number_field_tag(name, value = nil, options = {}) ⇒ Object
Creates a number field.
Options
-
:min
- The minimum acceptable value. -
:max
- The maximum acceptable value. -
:in
- A range specifying the:min
and:max
values. -
:step
- The acceptable value granularity. -
Otherwise accepts the same options as text_field_tag.
Examples
number_field_tag 'quantity', nil, in: 1...10
# => <input id="quantity" name="quantity" min="1" max="9" type="number" />
674 675 676 677 678 679 680 681 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 674 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" />
299 300 301 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 299 def password_field_tag(name = "password", value = nil, = {}) text_field_tag(name, value, .update("type" => "password")) end |
#radio_button_tag(name, value, checked = false, options = {}) ⇒ Object
Creates a radio button; use groups of radio buttons named the same to allow users to select from a group of options.
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
'gender', 'male'
# => <input id="gender_male" name="gender" type="radio" value="male" />
'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_300_pm" 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" />
391 392 393 394 395 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 391 def (name, value, checked = false, = {}) = { "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
-
Accepts the same options as number_field_tag.
687 688 689 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 687 def range_field_tag(name, value = nil, = {}) number_field_tag(name, value, .stringify_keys.update("type" => "range")) end |
#search_field_tag(name, value = nil, options = {}) ⇒ Object
Creates a text field of type “search”.
Options
-
Accepts the same options as text_field_tag.
569 570 571 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 569 def search_field_tag(name, value = nil, = {}) text_field_tag(name, value, .stringify_keys.update("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. -
: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", "<option>David</option>".html_safe
# => <select id="people" name="people"><option>David</option></select>
select_tag "count", "<option>1</option><option>2</option><option>3</option><option>4</option>".html_safe
# => <select id="count" name="count"><option>1</option><option>2</option>
# <option>3</option><option>4</option></select>
select_tag "colors", "<option>Red</option><option>Green</option><option>Blue</option>".html_safe, multiple: true
# => <select id="colors" multiple="multiple" name="colors[]"><option>Red</option>
# <option>Green</option><option>Blue</option></select>
select_tag "locations", "<option>Home</option><option selected='selected'>Work</option><option>Out</option>".html_safe
# => <select id="locations" name="locations"><option>Home</option><option selected='selected'>Work</option>
# <option>Out</option></select>
select_tag "access", "<option>Read</option><option>Write</option>".html_safe, multiple: true, class: 'form_input'
# => <select class="form_input" id="access" 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=""></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", "<option>NYC</option><option>Paris</option><option>Rome</option>".html_safe, 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>
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 125 def select_tag(name, = nil, = {}) ||= "" html_name = ([:multiple] == true && !name.to_s.ends_with?("[]")) ? "#{name}[]" : name if .include?(:include_blank) include_blank = .delete(:include_blank) if include_blank == true include_blank = '' end if include_blank = content_tag(:option, include_blank, value: '').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.
Data attributes
-
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.
Examples
submit_tag
# => <input name="commit" type="submit" value="Save changes" />
submit_tag "Edit this article"
# => <input name="commit" type="submit" value="Edit this article" />
submit_tag "Save edits", disabled: true
# => <input disabled="disabled" name="commit" type="submit" value="Save edits" />
submit_tag "Complete sale", data: { disable_with: "Please wait..." }
# => <input name="commit" data-disable-with="Please wait..." type="submit" value="Complete sale" />
submit_tag nil, class: "form_submit"
# => <input class="form_submit" name="commit" type="submit" />
submit_tag "Edit", class: "edit_button"
# => <input class="edit_button" name="commit" type="submit" value="Edit" />
submit_tag "Save", data: { confirm: "Are you sure?" }
# => <input name='commit' type='submit' value='Save' data-confirm="Are you sure?" />
435 436 437 438 439 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 435 def submit_tag(value = "Save changes", = {}) = .stringify_keys tag :input, { "type" => "submit", "name" => "commit", "value" => value }.update() end |
#telephone_field_tag(name, value = nil, options = {}) ⇒ Object Also known as: phone_field_tag
Creates a text field of type “tel”.
Options
-
Accepts the same options as text_field_tag.
577 578 579 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 577 def telephone_field_tag(name, value = nil, = {}) text_field_tag(name, value, .stringify_keys.update("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>
332 333 334 335 336 337 338 339 340 341 342 343 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 332 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. -
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" />
182 183 184 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 182 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
-
:min
- The minimum acceptable value. -
:max
- The maximum acceptable value. -
:step
- The acceptable value granularity. -
Otherwise accepts the same options as text_field_tag.
597 598 599 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 597 def time_field_tag(name, value = nil, = {}) text_field_tag(name, value, .stringify_keys.update("type" => "time")) end |
#url_field_tag(name, value = nil, options = {}) ⇒ Object
Creates a text field of type “url”.
Options
-
Accepts the same options as text_field_tag.
649 650 651 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 649 def url_field_tag(name, value = nil, = {}) text_field_tag(name, value, .stringify_keys.update("type" => "url")) end |
#utf8_enforcer_tag ⇒ Object
Creates the hidden UTF8 enforcer tag. Override this method in a helper to customize the tag.
693 694 695 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 693 def utf8_enforcer_tag tag(:input, :type => "hidden", :name => "utf8", :value => "✓".html_safe) end |
#week_field_tag(name, value = nil, options = {}) ⇒ Object
Creates a text field of type “week”.
Options
-
:min
- The minimum acceptable value. -
:max
- The maximum acceptable value. -
:step
- The acceptable value granularity. -
Otherwise accepts the same options as text_field_tag.
641 642 643 |
# File 'lib/action_view/helpers/form_tag_helper.rb', line 641 def week_field_tag(name, value = nil, = {}) text_field_tag(name, value, .stringify_keys.update("type" => "week")) end |