Module: ActionView::Helpers::FormTagHelper

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Included In: ::ActionView::Base, ::ActionView::Helpers, FormHelper, ActionView::Helpers::Tags::Base, ActionView::Helpers::Tags::CheckBox, ActionView::Helpers::Tags::CollectionCheckBoxes, ActionView::Helpers::Tags::CollectionRadioButtons, ActionView::Helpers::Tags::CollectionSelect, ActionView::Helpers::Tags::ColorField, ActionView::Helpers::Tags::DateField, ActionView::Helpers::Tags::DateSelect, ActionView::Helpers::Tags::DatetimeField, ActionView::Helpers::Tags::DatetimeLocalField, ActionView::Helpers::Tags::DatetimeSelect, ActionView::Helpers::Tags::EmailField, ActionView::Helpers::Tags::FileField, ActionView::Helpers::Tags::GroupedCollectionSelect, ActionView::Helpers::Tags::HiddenField, ActionView::Helpers::Tags::Label, ActionView::Helpers::Tags::MonthField, ActionView::Helpers::Tags::NumberField, ActionView::Helpers::Tags::PasswordField, ActionView::Helpers::Tags::RadioButton, ActionView::Helpers::Tags::RangeField, ActionView::Helpers::Tags::SearchField, ActionView::Helpers::Tags::Select, ActionView::Helpers::Tags::TelField, ActionView::Helpers::Tags::TextArea, ActionView::Helpers::Tags::TextField, ActionView::Helpers::Tags::TimeField, ActionView::Helpers::Tags::TimeSelect, ActionView::Helpers::Tags::TimeZoneSelect, ActionView::Helpers::Tags::UrlField, ActionView::Helpers::Tags::WeekField, ::ActionView::TestCase, ::ActionView::TestCase::Behavior
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, ::ActiveSupport::Concern
Instance Chain: self, TextHelper, SanitizeHelper, UrlHelper, TagHelper, CaptureHelper
Defined in:	actionview/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

TagHelper - Included

BOOLEAN_ATTRIBUTES, PRE_CONTENT_STRINGS, TAG_PREFIXES

UrlHelper - Included

BUTTON_TAG_METHOD_VERBS

Class Attribute Summary

.embed_authenticity_token_in_remote_forms (also: #embed_authenticity_token_in_remote_forms) rw

Class Method Summary

::ActiveSupport::Concern - Extended

append_features, class_methods, included

Instance Attribute Summary

#embed_authenticity_token_in_remote_forms rw

Instance Method Summary

#button_tag(content_or_options = nil, options = nil, &block)

Creates a button element that defines a submit button, resetbutton or a generic button which can be used in JavaScript, for example.
#check_box_tag(name, value = "1", checked = false, options = {})

Creates a check box form input tag.
#color_field_tag(name, value = nil, options = {})

Creates a text field of type “color”.
#date_field_tag(name, value = nil, options = {})

Creates a text field of type “date”.
#datetime_field_tag(name, value = nil, options = {})

Creates a text field of type “datetime”.
#datetime_local_field_tag(name, value = nil, options = {})

Creates a text field of type “datetime-local”.
#email_field_tag(name, value = nil, options = {})

Creates a text field of type “email”.
#field_set_tag(legend = nil, options = nil, &block)

Creates a field set for grouping HTML form elements.
#file_field_tag(name, options = {})

Creates a file upload field.
#form_tag(url_for_options = {}, options = {}, &block)

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 = {})

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 = {})

Displays an image which when clicked will submit the form.
#label_tag(name = nil, content_or_options = nil, options = nil, &block)

Creates a label element.
#month_field_tag(name, value = nil, options = {})

Creates a text field of type “month”.
#number_field_tag(name, value = nil, options = {})

Creates a number field.
#password_field_tag(name = "password", value = nil, options = {})

Creates a password field, a masked text field that will hide the users input behind a mask character.
#phone_field_tag(name, value = nil, options = {})

Alias for #telephone_field_tag.
#radio_button_tag(name, value, checked = false, options = {})

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 = {})

Creates a range form element.
#search_field_tag(name, value = nil, options = {})

Creates a text field of type “search”.
#select_tag(name, option_tags = nil, options = {})

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 = {})

Creates a submit button with the text value as the caption.
#telephone_field_tag(name, value = nil, options = {}) (also: #phone_field_tag)

Creates a text field of type “tel”.
#text_area_tag(name, content = nil, options = {})

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 = {})

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 = {})

Creates a text field of type “time”.
#url_field_tag(name, value = nil, options = {})

Creates a text field of type “url”.
#utf8_enforcer_tag

Creates the hidden UTF8 enforcer tag.
#week_field_tag(name, value = nil, options = {})

Creates a text field of type “week”.

TextHelper - Included

#concat	The preferred method of outputting text in your views is to use the <%= “text” %> eRuby syntax.
#current_cycle	Returns the current cycle string after a cycle has been started.
#cycle	Creates a Cycle object whose to_s method cycles through elements of an array every time it is called.
#excerpt	Extracts an excerpt from `text` that matches the first instance of `phrase`.
#highlight	Highlights one or more `phrases` everywhere in `text` by inserting it into a `:highlighter` string.
#pluralize	Attempts to pluralize the `singular` word unless `count` is 1.
#reset_cycle	Resets a cycle so that it starts from the first element the next time it is called.
#safe_concat,
#simple_format	Returns `text` transformed into HTML using simple formatting rules.
#truncate	Truncates a given `text` after a given `:length` if `text` is longer than `:length` (defaults to 30).
#word_wrap	Wraps the `text` into lines no longer than `line_width` width.

SanitizeHelper - Included

#sanitize	Sanitizes HTML input, stripping all tags and attributes that aren't whitelisted.
#sanitize_css	Sanitizes a block of CSS code.
#strip_links	Strips all link tags from `html` leaving just the link text.
#strip_tags	Strips all HTML tags from `html`, including comments.

UrlHelper - Included

#button_to	Generates a form containing a single button that submits to the URL created by the set of `options`.
#current_page?	True if the current request ::URI was generated by the given `options`.
#link_to	Creates a link tag of the given `name` using a URL created by the set of `options`.
#link_to_if	Creates a link tag of the given `name` using a URL created by the set of `options` if `condition` is true, otherwise only the name is returned.
#link_to_unless	Creates a link tag of the given `name` using a URL created by the set of `options` unless `condition` is true, in which case only the name is returned.
#link_to_unless_current	Creates a link tag of the given `name` using a URL created by the set of `options` unless the current request ::URI is the same as the links, in which case only the name is returned (or the given block is yielded, if one exists).
#mail_to	Creates a mailto link tag to the specified `email_address`, which is also used as the name of the link unless `name` is specified.

TagHelper - Included

#cdata_section	Returns a CDATA section with the given `content`.
#content_tag	Returns an HTML block tag of type `name` surrounding the `content`.
#escape_once	Returns an escaped version of `html` without affecting existing escaped entities.
#tag	Returns an empty HTML tag of type `name` which by default is XHTML compliant.

CaptureHelper - Included

#capture	The capture method allows you to extract part of a template into a variable.
#content_for	Calling content_for stores a block of markup in an identifier for later use.
#content_for?	content_for? checks whether any content has been captured yet using `content_for`.
#provide	The same as `content_for` but when used with streaming flushes straight back to the layout.

Class Attribute Details

.embed_authenticity_token_in_remote_forms (rw) Also known as: #embed_authenticity_token_in_remote_forms

[ GitHub ]

# File 'actionview/lib/action_view/helpers/form_tag_helper.rb', line 20


mattr_accessor :embed_authenticity_token_in_remote_forms

Instance Attribute Details

#embed_authenticity_token_in_remote_forms (rw)

[ GitHub ]

# File 'actionview/lib/action_view/helpers/form_tag_helper.rb', line 20


mattr_accessor :embed_authenticity_token_in_remote_forms

Instance Method Details

#button_tag(content_or_options = nil, options = nil, &block)

Creates a button element that defines a submit button, resetbutton 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_tag
# => <button name="button" type="submit">Button</button>

button_tag(type: 'button') do
  content_tag(:strong, 'Ask me!')
end
# => <button name="button" type="button">
#     <strong>Ask me!</strong>
#    </button>

button_tag "Checkout", data: { disable_with: "Please wait..." }
# => <button data-disable-with="Please wait..." name="button" type="submit">Checkout</button>

[ GitHub ]

# File 'actionview/lib/action_view/helpers/form_tag_helper.rb', line 485


def button_tag(content_or_options = nil, options = nil, &block)
  if content_or_options.is_a? Hash
    options = content_or_options
  else
    options ||= {}
  end

  options = { 'name' => 'button', 'type' => 'submit' }.merge!(options.stringify_keys)

  if block_given?
    content_tag :button, options, &block
  else
    content_tag :button, content_or_options || 'Button', options
  end
end

#check_box_tag(name, value = "1", checked = false, options = {})

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" />

[ GitHub ]

# File 'actionview/lib/action_view/helpers/form_tag_helper.rb', line 372


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

#color_field_tag(name, value = nil, options = {})

Creates a text field of type “color”.

Options

Accepts 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" />

[ GitHub ]

# File 'actionview/lib/action_view/helpers/form_tag_helper.rb', line 580


def color_field_tag(name, value = nil, options = {})
  text_field_tag(name, value, options.merge(type: :color))
end

#date_field_tag(name, value = nil, options = {})

Creates a text field of type “date”.

Options

Accepts 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" />

[ GitHub ]

# File 'actionview/lib/action_view/helpers/form_tag_helper.rb', line 644


def date_field_tag(name, value = nil, options = {})
  text_field_tag(name, value, options.merge(type: :date))
end

#datetime_field_tag(name, value = nil, options = {})

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.

[ GitHub ]

# File 'actionview/lib/action_view/helpers/form_tag_helper.rb', line 666


def datetime_field_tag(name, value = nil, options = {})
  text_field_tag(name, value, options.merge(type: :datetime))
end

#datetime_local_field_tag(name, value = nil, options = {})

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.

[ GitHub ]

# File 'actionview/lib/action_view/helpers/form_tag_helper.rb', line 677


def datetime_local_field_tag(name, value = nil, options = {})
  text_field_tag(name, value, options.merge(type: 'datetime-local'))
end

#email_field_tag(name, value = nil, options = {})

Creates a text field of type “email”.

Options

Accepts 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" />

[ GitHub ]

# File 'actionview/lib/action_view/helpers/form_tag_helper.rb', line 741


def email_field_tag(name, value = nil, options = {})
  text_field_tag(name, value, options.merge(type: :email))
end

#field_set_tag(legend = nil, options = nil, &block)

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>

[ GitHub ]

# File 'actionview/lib/action_view/helpers/form_tag_helper.rb', line 556


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

#file_field_tag(name, options = {})

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" />

[ GitHub ]

# File 'actionview/lib/action_view/helpers/form_tag_helper.rb', line 272


def file_field_tag(name, options = {})
  text_field_tag(name, nil, options.merge(type: :file))
end

#form_tag(url_for_options = {}, options = {}, &block)

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 passing false). Remote forms may omit the embedded authenticity token by setting config.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 the meta 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

[ GitHub ]

# File 'actionview/lib/action_view/helpers/form_tag_helper.rb', line 67


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

#hidden_field_tag(name, value = nil, options = {})

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="" />

[ GitHub ]

# File 'actionview/lib/action_view/helpers/form_tag_helper.rb', line 233


def hidden_field_tag(name, value = nil, options = {})
  text_field_tag(name, value, options.merge(type: :hidden))
end

#image_submit_tag(source, options = {})

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="/assets/login.png" type="image" />

image_submit_tag("purchase.png", disabled: true)
# => <input alt="Purchase" disabled="disabled" src="/assets/purchase.png" type="image" />

image_submit_tag("search.png", class: 'search_button', alt: 'Find')
# => <input alt="Find" class="search_button" src="/assets/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="/assets/agree.png" type="image" />

image_submit_tag("save.png", data: { confirm: "Are you sure?" })
# => <input alt="Save" src="/assets/save.png" data-confirm="Are you sure?" type="image" />

[ GitHub ]

# File 'actionview/lib/action_view/helpers/form_tag_helper.rb', line 531


def image_submit_tag(source, options = {})
  options = options.stringify_keys
  tag :input, { "alt" => image_alt(source), "type" => "image", "src" => path_to_image(source) }.update(options)
end

#label_tag(name = nil, content_or_options = nil, options = nil, &block)

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>

[ GitHub ]

# File 'actionview/lib/action_view/helpers/form_tag_helper.rb', line 206


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

#month_field_tag(name, value = nil, options = {})

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.

[ GitHub ]

# File 'actionview/lib/action_view/helpers/form_tag_helper.rb', line 688


def month_field_tag(name, value = nil, options = {})
  text_field_tag(name, value, options.merge(type: :month))
end

#number_field_tag(name, value = nil, options = {})

Creates a number field.

Options

: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.
Otherwise accepts the same options as text_field_tag.

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="9" type="number" />

number_field_tag 'quantity', nil, min: 1, max: 10, step: 2
# => <input id="quantity" name="quantity" min="1" max="9" 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" />

[ GitHub ]

# File 'actionview/lib/action_view/helpers/form_tag_helper.rb', line 786


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

#password_field_tag(name = "password", value = nil, options = {})

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" />

[ GitHub ]

# File 'actionview/lib/action_view/helpers/form_tag_helper.rb', line 305


def password_field_tag(name = "password", value = nil, options = {})
  text_field_tag(name, value, options.merge(type: :password))
end

#phone_field_tag(name, value = nil, options = {})

Alias for #telephone_field_tag.

[ GitHub ]

# File 'actionview/lib/action_view/helpers/form_tag_helper.rb', line 625


alias phone_field_tag telephone_field_tag

#radio_button_tag(name, value, checked = false, options = {})

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

radio_button_tag 'gender', 'male'
# => <input id="gender_male" name="gender" type="radio" value="male" />

radio_button_tag 'receive_updates', 'no', true
# => <input checked="checked" id="receive_updates_no" name="receive_updates" type="radio" value="no" />

radio_button_tag '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." />

radio_button_tag 'color', "green", true, class: "color_input"
# => <input checked="checked" class="color_input" id="color_green" name="color" type="radio" value="green" />

[ GitHub ]

# File 'actionview/lib/action_view/helpers/form_tag_helper.rb', line 397


def radio_button_tag(name, value, checked = false, options = {})
  html_options = { "type" => "radio", "name" => name, "id" => "#{sanitize_to_id(name)}_#{sanitize_to_id(value)}", "value" => value }.update(options.stringify_keys)
  html_options["checked"] = "checked" if checked
  tag :input, html_options
end

#range_field_tag(name, value = nil, options = {})

Creates a range form element.

Options

Accepts the same options as number_field_tag.

[ GitHub ]

# File 'actionview/lib/action_view/helpers/form_tag_helper.rb', line 799


def range_field_tag(name, value = nil, options = {})
  number_field_tag(name, value, options.merge(type: :range))
end

#search_field_tag(name, value = nil, options = {})

Creates a text field of type “search”.

Options

Accepts 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" />

[ GitHub ]

# File 'actionview/lib/action_view/helpers/form_tag_helper.rb', line 601


def search_field_tag(name, value = nil, options = {})
  text_field_tag(name, value, options.merge(type: :search))
end

#select_tag(name, option_tags = nil, options = {})

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", "<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', 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=""></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", "<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", options_for_select([ "VISA", "MasterCard" ], "MasterCard")
# => <select id="credit_card" name="credit_card"><option>VISA</option>
#    <option selected="selected">MasterCard</option></select>

[ GitHub ]

# File 'actionview/lib/action_view/helpers/form_tag_helper.rb', line 131


def select_tag(name, option_tags = nil, options = {})
  option_tags ||= ""
  html_name = (options[:multiple] == true && !name.to_s.ends_with?("[]")) ? "#{name}[]" : name

  if options.include?(:include_blank)
    include_blank = options.delete(:include_blank)

    if include_blank == true
      include_blank = ''
    end

    if include_blank
      option_tags = content_tag(:option, include_blank, value: '').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

#submit_tag(value = "Save changes", options = {})

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?" />

[ GitHub ]

# File 'actionview/lib/action_view/helpers/form_tag_helper.rb', line 441


def submit_tag(value = "Save changes", options = {})
  options = options.stringify_keys

  tag :input, { "type" => "submit", "name" => "commit", "value" => value }.update(options)
end

#telephone_field_tag(name, value = nil, options = {}) Also known as: #phone_field_tag

Creates a text field of type “tel”.

Options

Accepts 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" />

[ GitHub ]

# File 'actionview/lib/action_view/helpers/form_tag_helper.rb', line 622


def telephone_field_tag(name, value = nil, options = {})
  text_field_tag(name, value, options.merge(type: :tel))
end

#text_area_tag(name, content = nil, options = {})

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>

[ GitHub ]

# File 'actionview/lib/action_view/helpers/form_tag_helper.rb', line 338


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

#text_field_tag(name, value = nil, options = {})

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" />

[ GitHub ]

# File 'actionview/lib/action_view/helpers/form_tag_helper.rb', line 188


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

#time_field_tag(name, value = nil, options = {})

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.

[ GitHub ]

# File 'actionview/lib/action_view/helpers/form_tag_helper.rb', line 655


def time_field_tag(name, value = nil, options = {})
  text_field_tag(name, value, options.merge(type: :time))
end

#url_field_tag(name, value = nil, options = {})

Creates a text field of type “url”.

Options

Accepts 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" />

[ GitHub ]

# File 'actionview/lib/action_view/helpers/form_tag_helper.rb', line 720


def url_field_tag(name, value = nil, options = {})
  text_field_tag(name, value, options.merge(type: :url))
end

#utf8_enforcer_tag

Creates the hidden UTF8 enforcer tag. Override this method in a helper to customize the tag.

[ GitHub ]

# File 'actionview/lib/action_view/helpers/form_tag_helper.rb', line 805


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="&#x2713;" />'.html_safe
end

#week_field_tag(name, value = nil, options = {})

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.

[ GitHub ]

# File 'actionview/lib/action_view/helpers/form_tag_helper.rb', line 699


def week_field_tag(name, value = nil, options = {})
  text_field_tag(name, value, options.merge(type: :week))
end