Module: ActionView::Helpers::FormTagHelper

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Included In: `::ActionDispatch::DebugView`, `::ActionView::Base`, `::ActionView::Helpers`, `FormHelper`, `Tags::Base`, `Tags::CheckBox`, `Tags::CollectionCheckBoxes`, `Tags::CollectionRadioButtons`, `Tags::CollectionSelect`, `Tags::ColorField`, `Tags::DateField`, `Tags::DateSelect`, `Tags::DatetimeField`, `Tags::DatetimeLocalField`, `Tags::DatetimeSelect`, `Tags::EmailField`, `Tags::FileField`, `Tags::GroupedCollectionSelect`, `Tags::HiddenField`, `Tags::Label`, `Tags::MonthField`, `Tags::NumberField`, `Tags::PasswordField`, `Tags::RadioButton`, `Tags::RangeField`, `Tags::SearchField`, `Tags::Select`, `Tags::TelField`, `Tags::TextArea`, `Tags::TextField`, `Tags::TimeField`, `Tags::TimeSelect`, `Tags::TimeZoneSelect`, `Tags::UrlField`, `Tags::WeekField`, `Tags::WeekdaySelect`, `::ActionView::TestCase`, `::ActionView::TestCase::Behavior`
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, `::ActiveSupport::Concern`
Instance Chain: self, `TextHelper`, `SanitizeHelper`, `UrlHelper`, `ContentExfiltrationPreventionHelper`, `TagHelper`, `OutputSafetyHelper`, `CaptureHelper`
Defined in:	actionview/lib/action_view/helpers/form_tag_helper.rb

Overview

Action View Form Tag Helpers

Provides a number of methods for creating form tags that don’t rely on an Active Record object assigned to the template like FormHelper does. Instead, you provide the names and values manually.

NOTE: The HTML options disabled, readonly, and multiple can all be treated as booleans. So specifying disabled: true will give disabled="disabled".

Constant Summary

Class Attribute Summary

.default_enforce_utf8 (also: #default_enforce_utf8) rw
.embed_authenticity_token_in_remote_forms (also: #embed_authenticity_token_in_remote_forms) rw

Class Method Summary

`::ActiveSupport::Concern` - Extended

class_methods	Define class methods from given block.
included	Evaluate given block in context of base class, so that you can write class macros here.
prepended	Evaluate given block in context of base class, so that you can write class macros here.
append_features, prepend_features

Instance Attribute Summary

#default_enforce_utf8 rw
#embed_authenticity_token_in_remote_forms rw

`ContentExfiltrationPreventionHelper` - Included

#prepend_content_exfiltration_prevention

Instance Method Summary

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

Creates a button element that defines a submit button, reset button or a generic button which can be used in JavaScript, for example.
#check_box_tag(name, *args)

Alias for #checkbox_tag.
#checkbox_tag(name, options = {}) (also: #check_box_tag)

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 = {}) (also: #datetime_local_field_tag)

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

Alias for #datetime_field_tag.
#email_field_tag(name, value = nil, options = {})

Creates a text field of type “email”.
#field_id(object_name, method_name, *suffixes, index: nil, namespace: nil)

Generate an HTML id attribute value for the given name and field combination.
#field_name(object_name, method_name, *method_names, multiple: false, index: nil)

Generate an HTML name attribute value for the given name and field combination.
#field_set_tag(legend = nil, options = nil, &block) (also: #fieldset_tag)

Creates a field set for grouping HTML form elements.
#fieldset_tag(legend = nil, options = nil, &block)

Alias for #field_set_tag.
#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 a 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, 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 = {})

Alias for #textarea_tag.
#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.
#textarea_tag(name, content = nil, options = {}) (also: #text_area_tag)

Creates a text input area; use a textarea for longer text inputs such as blog posts or descriptions.
#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 UTF-8 enforcer tag.
#week_field_tag(name, value = nil, options = {})

Creates a text field of type “week”.
#convert_direct_upload_option_to_url(options) private
#extra_tags_for_form(html_options) private
#form_tag_html(html_options) private
#form_tag_with_body(html_options, content) private
#html_options_for_form(url_for_options, options) private
#sanitize_to_id(name) private

see www.w3.org/TR/html4/types.html#type-name.
#set_default_disable_with(value, tag_options) private

`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 the first occurrence of `phrase` plus surrounding text from `text`.
#highlight	Highlights occurrences of `phrases` in `text` by formatting them with 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 `text` if it is longer than a specified `:length`.
#word_wrap	Wraps the `text` into lines no longer than `line_width` width.
#cut_excerpt_part,
#get_cycle	The cycle helpers need to store the cycles in a place that is guaranteed to be reset every time a page is rendered, so it uses an instance variable of `::ActionView::Base`.
#set_cycle, #split_paragraphs

`SanitizeHelper` - Included

#sanitize	Sanitizes HTML input, stripping all but known-safe tags and attributes.
#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 and special characters.

`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 an anchor element 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.
#phone_to	Creates a TEL anchor link tag to the specified `phone_number`.
#sms_to	Creates an SMS anchor link tag to the specified `phone_number`.
#add_method_to_attributes!, #convert_options_to_data_attributes, #link_to_remote_options?, #method_for_options, #method_not_get_method?, #method_tag, #remove_trailing_slash!,
#to_form_params	Returns an array of hashes each containing `:name` and `:value` keys suitable for use as the names and values of form input fields:
#token_tag, #url_target,
#url_for	Basic implementation of url_for to allow use helpers without routes existence.
#_back_url, #_filtered_referrer

`ContentExfiltrationPreventionHelper` - Included

#prevent_content_exfiltration

`TagHelper` - Included

#cdata_section	Returns a CDATA section with the given `content`.
#class_names	Alias for TagHelper#token_list.
#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 HTML tag.
#token_list	Returns a string of tokens built from `args`.
#build_tag_values, #ensure_valid_html5_tag_name, #tag_builder

`OutputSafetyHelper` - Included

#raw	This method outputs without escaping a string.
#safe_join	This method returns an HTML safe string similar to what `Array#join` would return.
#to_sentence	Converts the array to a comma-separated sentence where the last element is joined by the connector word.

`CaptureHelper` - Included

#capture	The capture method extracts part of a template as a string object.
#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.
#with_output_buffer	Use an alternate output buffer for the duration of the block.

Class Attribute Details

.default_enforce_utf8 (rw) Also known as: #default_enforce_utf8

[ GitHub ]

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


mattr_accessor :default_enforce_utf8, default: true

.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 26


mattr_accessor :embed_authenticity_token_in_remote_forms

Instance Attribute Details

#default_enforce_utf8 (rw)

[ GitHub ]

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


mattr_accessor :default_enforce_utf8, default: true

#embed_authenticity_token_in_remote_forms (rw)

[ GitHub ]

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


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, reset button or a generic button which can be used in JavaScript, for example. You can use the button tag as a regular submit tag but it isn’t supported in legacy browsers. However, the button tag does allow for richer labels such as images and emphasis, so this helper will also accept a block. By default, it will create a button tag with type submit, if type is not given.

Options

:data - This option can be used to add custom data attributes.
:disabled - If true, the user will not be able to use this input.
Any other key creates standard HTML options for the tag.

Examples

button_tag
# => <button name="button" type="submit">Button</button>

button_tag 'Reset', type: 'reset'
# => <button name="button" type="reset">Reset</button>

button_tag 'Button', type: 'button'
# => <button name="button" type="button">Button</button>

button_tag 'Reset', type: 'reset', disabled: true
# => <button name="button" type="reset" disabled="disabled">Reset</button>

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

[ GitHub ]

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


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, *args)

Alias for #checkbox_tag.

[ GitHub ]

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


alias_method :check_box_tag, :checkbox_tag

#checkbox_tag(name, options = {}) #checkbox_tag(name, value, options = {}) #checkbox_tag(name, value, checked, options = {})
Also known as: #check_box_tag

Creates a check box form input tag.

Options

:value - The value of the input. Defaults to "1".
:checked - If set to true, the checkbox will be checked by default.
:disabled - If set to true, the user will not be able to use this input.
Any other key creates standard HTML options for the tag.

Examples

checkbox_tag 'accept'
# => <input id="accept" name="accept" type="checkbox" value="1" />

checkbox_tag 'rock', 'rock music'
# => <input id="rock" name="rock" type="checkbox" value="rock music" />

checkbox_tag 'receive_email', 'yes', true
# => <input checked="checked" id="receive_email" name="receive_email" type="checkbox" value="yes" />

checkbox_tag 'tos', 'yes', false, class: 'accept_tos'
# => <input class="accept_tos" id="tos" name="tos" type="checkbox" value="yes" />

checkbox_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 456


def checkbox_tag(name, *args)
  if args.length >= 4
    raise ArgumentError, "wrong number of arguments (given #{args.length + 1}, expected 1..4)"
  end
  options = args.extract_options!
  value, checked = args.empty? ? ["1", false] : [*args, false]
  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

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

[ GitHub ]

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


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

#convert_direct_upload_option_to_url(options) (private)

[ GitHub ]

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


def convert_direct_upload_option_to_url(options)
  return options unless options.delete(:direct_upload)

  if respond_to?(:rails_direct_uploads_url)
    options["data-direct-upload-url"] = rails_direct_uploads_url
  elsif respond_to?(:main_app) && main_app.respond_to?(:rails_direct_uploads_url)
    options["data-direct-upload-url"] = main_app.rails_direct_uploads_url
  end

  options
end

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

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', '2014-12-31'
# => <input id="date" name="date" type="date" value="2014-12-31" />

date_field_tag 'date', nil, class: 'special_input'
# => <input class="special_input" id="date" name="date" type="date" />

date_field_tag 'date', '2014-12-31', class: 'special_input', disabled: true
# => <input disabled="disabled" class="special_input" id="date" name="date" type="date" value="2014-12-31" />

[ GitHub ]

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


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 = {}) Also known as: #datetime_local_field_tag

Creates a text field of type “datetime-local”.

Options

Supports the same options as #text_field_tag. Additionally, supports:

:min - The minimum acceptable value.
:max - The maximum acceptable value.
:step - The acceptable value granularity.
:include_seconds - Include seconds in the output timestamp format (true by default).

Examples

datetime_field_tag 'name'
# => <input id="name" name="name" type="datetime-local" />

datetime_field_tag 'datetime', '2014-01-01T01:01'
# => <input id="datetime" name="datetime" type="datetime-local" value="2014-01-01T01:01" />

datetime_field_tag 'datetime', nil, class: 'special_input'
# => <input class="special_input" id="datetime" name="datetime" type="datetime-local" />

datetime_field_tag 'datetime', '2014-01-01T01:01', class: 'special_input', disabled: true
# => <input disabled="disabled" class="special_input" id="datetime" name="datetime" type="datetime-local" value="2014-01-01T01:01" />

[ GitHub ]

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


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

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

Alias for #datetime_field_tag.

[ GitHub ]

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


alias datetime_local_field_tag datetime_field_tag

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

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

[ GitHub ]

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


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

#extra_tags_for_form(html_options) (private)

[ GitHub ]

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


def extra_tags_for_form(html_options)
  authenticity_token = html_options.delete("authenticity_token")
  method = html_options.delete("method").to_s.downcase

  method_tag = \
    case method
    when "get"
      html_options["method"] = "get"
      ""
    when "post", ""
      html_options["method"] = "post"
      token_tag(authenticity_token, form_options: {
        action: html_options["action"],
        method: "post"
      })
    else
      html_options["method"] = "post"
      method_tag(method) + token_tag(authenticity_token, form_options: {
        action: html_options["action"],
        method: method
      })
    end

  if html_options.delete("enforce_utf8") { default_enforce_utf8 }
    utf8_enforcer_tag + method_tag
  else
    method_tag
  end
end

#field_id(object_name, method_name, *suffixes, index: nil, namespace: nil)

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 :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 declares an aria-describedby attribute referencing the <span> element, sharing a common id root (post_title, in this case).

[ GitHub ]

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


def field_id(object_name, method_name, *suffixes, index: nil, namespace: nil)
  if object_name.respond_to?(:model_name)
    object_name = object_name.model_name.singular
  end

  sanitized_object_name = object_name.to_s.gsub(/\]\[|[^-a-zA-Z0-9:.]/, "_").delete_suffix("_")

  sanitized_method_name = method_name.to_s.delete_suffix("?")

  [
    namespace,
    sanitized_object_name.presence,
    (index unless sanitized_object_name.empty?),
    sanitized_method_name,
    *suffixes,
  ].tap(&:compact!).join("_")
end

#field_name(object_name, method_name, *method_names, multiple: false, index: nil)

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 :post, :title, name: field_name(:post, :title, :subtitle) %>
<%# => <input type="text" name="post[title][subtitle]"> %>

<%= text_field :post, :tag, name: field_name(:post, :tag, multiple: true) %>
<%# => <input type="text" name="post[tag][]"> %>

[ GitHub ]

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


def field_name(object_name, method_name, *method_names, multiple: false, index: nil)
  names = method_names.map! { |name| "[#{name}]" }.join

  # a little duplication to construct fewer strings
  case
  when object_name.blank?
    "#{method_name}#{names}#{multiple ? "[]" : ""}"
  when index
    "#{object_name}[#{index}][#{method_name}]#{names}#{multiple ? "[]" : ""}"
  else
    "#{object_name}[#{method_name}]#{names}#{multiple ? "[]" : ""}"
  end
end

#field_set_tag(legend = nil, options = nil, &block) Also known as: #fieldset_tag

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 640


def field_set_tag(legend = nil, options = nil, &block)
  content = []
  content << content_tag("legend", legend) unless legend.blank?
  content << capture(&block) if block_given?

  content_tag(:fieldset, safe_join(content), options)
end

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

Alias for #field_set_tag.

[ GitHub ]

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


alias_method :fieldset_tag, :field_set_tag

#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 347


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

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

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 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(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

[ GitHub ]

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


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

#form_tag_html(html_options) (private)

[ GitHub ]

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


def form_tag_html(html_options)
  extra_tags = extra_tags_for_form(html_options)
  html = tag(:form, html_options, true) + extra_tags
  prevent_content_exfiltration(html)
end

#form_tag_with_body(html_options, content) (private)

[ GitHub ]

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


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

#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 type="hidden" name="tags_list" id="tags_list" autocomplete="off" />

hidden_field_tag 'token', 'VUBJKB23UIVI1UU1VOBVI@'
# => <input type="hidden" name="token" id="token" value="VUBJKB23UIVI1UU1VOBVI@" autocomplete="off" />

hidden_field_tag 'collected_input', '', onchange: "alert('Input collected!')"
# => <input type="hidden" name="collected_input" id="collected_input"
     value="" onchange="alert(&#39;Input collected!&#39;)" autocomplete="off" />

[ GitHub ]

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


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

#html_options_for_form(url_for_options, options) (private)

[ GitHub ]

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


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

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

[ GitHub ]

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


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

#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 281


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

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.

Examples

month_field_tag 'name'
# => <input id="name" name="name" type="month" />

month_field_tag 'month', '2014-01'
# => <input id="month" name="month" type="month" value="2014-01" />

month_field_tag 'month', nil, class: 'special_input'
# => <input class="special_input" id="month" name="month" type="month" />

month_field_tag 'month', '2014-01', class: 'special_input', disabled: true
# => <input disabled="disabled" class="special_input" id="month" name="month" type="month" value="2014-01" />

[ GitHub ]

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


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

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

[ GitHub ]

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


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 380


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 717


alias phone_field_tag telephone_field_tag

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

Creates a radio button; use groups of radio buttons named the same to allow users to select from a group of options.

Options

:checked - If set to true, the radio button will be selected by default.
:disabled - If set to true, the user will not be able to use this input.
Any other key creates standard HTML options for the tag.

Examples

radio_button_tag 'favorite_color', 'maroon'
# => <input id="favorite_color_maroon" name="favorite_color" type="radio" value="maroon" />

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_3:00_p.m." 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 493


def radio_button_tag(name, value, *args)
  if args.length >= 3
    raise ArgumentError, "wrong number of arguments (given #{args.length + 2}, expected 2..4)"
  end
  options = args.extract_options!
  checked = args.empty? ? false : args.first
  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

Supports the same options as #number_field_tag.

Examples

range_field_tag 'quantity', '1'
# => <input id="quantity" name="quantity" type="range" value="1" />

range_field_tag 'quantity', in: 1...10
# => <input id="quantity" name="quantity" min="1" max="9" type="range" />

range_field_tag 'quantity', min: 1, max: 10, step: 2
# => <input id="quantity" name="quantity" min="1" max="10" step="2" type="range"

[ GitHub ]

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


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

#sanitize_to_id(name) (private)

see www.w3.org/TR/html4/types.html#type-name

[ GitHub ]

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


def sanitize_to_id(name)
  name.to_s.delete("]").tr("^-a-zA-Z0-9:.", "_")
end

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

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

[ GitHub ]

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


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

[ GitHub ]

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


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

#set_default_disable_with(value, tag_options) (private)

[ GitHub ]

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


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

#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.

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

[ GitHub ]

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


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

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

Creates a text field of type “tel”.

Options

Supports the same options as #text_field_tag.

Examples

telephone_field_tag 'name'
# => <input id="name" name="name" type="tel" />

telephone_field_tag 'tel', '0123456789'
# => <input id="tel" name="tel" type="tel" value="0123456789" />

telephone_field_tag 'tel', nil, class: 'special_input'
# => <input class="special_input" id="tel" name="tel" type="tel" />

telephone_field_tag 'tel', '0123456789', class: 'special_input', disabled: true
# => <input disabled="disabled" class="special_input" id="tel" name="tel" type="tel" value="0123456789" />

[ GitHub ]

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


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

Alias for #textarea_tag.

[ GitHub ]

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


alias_method :text_area_tag, :textarea_tag

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

[ GitHub ]

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


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

#textarea_tag(name, content = nil, options = {}) Also known as: #text_area_tag

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

textarea_tag 'post'
# => <textarea id="post" name="post"></textarea>

textarea_tag 'bio', @user.bio
# => <textarea id="bio" name="bio">This is my biography.</textarea>

textarea_tag 'body', nil, rows: 10, cols: 25
# => <textarea cols="25" id="body" name="body" rows="10"></textarea>

textarea_tag 'body', nil, size: "25x10"
# => <textarea name="body" id="body" cols="25" rows="10"></textarea>

textarea_tag 'description', "Description goes here.", disabled: true
# => <textarea disabled="disabled" id="description" name="description">Description goes here.</textarea>

textarea_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 413


def textarea_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

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

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).

Examples

time_field_tag 'name'
# => <input id="name" name="name" type="time" />

time_field_tag 'time', '01:01'
# => <input id="time" name="time" type="time" value="01:01" />

time_field_tag 'time', nil, class: 'special_input'
# => <input class="special_input" id="time" name="time" type="time" />

time_field_tag 'time', '01:01', include_seconds: true
# => <input id="time" name="time" type="time" value="01:01:00.000" />

time_field_tag 'time', '01:01', min: '00:00', max: '23:59', step: 1
# => <input id="time" max="23:59" min="00:00" name="time" step="1" type="time" value="01:01" />

[ GitHub ]

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


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

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

[ GitHub ]

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


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

#utf8_enforcer_tag

Creates the hidden UTF-8 enforcer tag. Override this method in a helper to customize the tag.

[ GitHub ]

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


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;" autocomplete="off" />'.html_safe
end

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

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.

Examples

week_field_tag 'name'
# => <input id="name" name="name" type="week" />

week_field_tag 'week', '2014-W01'
# => <input id="week" name="week" type="week" value="2014-W01" />

week_field_tag 'week', nil, class: 'special_input'
# => <input class="special_input" id="week" name="week" type="week" />

week_field_tag 'week', '2014-W01', class: 'special_input', disabled: true
# => <input disabled="disabled" class="special_input" id="week" name="week" type="week" value="2014-W01" />

[ GitHub ]

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


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

Module: ActionView::Helpers::FormTagHelper

Overview

Action View Form Tag Helpers

Constant Summary

TagHelper - Included

ContentExfiltrationPreventionHelper - Included

UrlHelper - Included

Class Attribute Summary

Class Method Summary

::ActiveSupport::Concern - Extended

Instance Attribute Summary

SanitizeHelper - Included

UrlHelper - Included

ContentExfiltrationPreventionHelper - Included

Instance Method Summary

TextHelper - Included

SanitizeHelper - Included

UrlHelper - Included

ContentExfiltrationPreventionHelper - Included

TagHelper - Included

OutputSafetyHelper - Included

CaptureHelper - Included

Class Attribute Details

.default_enforce_utf8 (rw) Also known as: #default_enforce_utf8

.embed_authenticity_token_in_remote_forms (rw) Also known as: #embed_authenticity_token_in_remote_forms

Instance Attribute Details

#default_enforce_utf8 (rw)

#embed_authenticity_token_in_remote_forms (rw)

Instance Method Details

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

Options

Examples

#check_box_tag(name, *args)

#checkbox_tag(name, options = {}) #checkbox_tag(name, value, options = {}) #checkbox_tag(name, value, checked, options = {}) Also known as: #check_box_tag

Options

Examples

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

Options

Examples

#convert_direct_upload_option_to_url(options) (private)

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

Options

Examples

#datetime_field_tag(name, value = nil, options = {}) Also known as: #datetime_local_field_tag

Options

Examples

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

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

Options

Examples

#extra_tags_for_form(html_options) (private)

#field_id(object_name, method_name, *suffixes, index: nil, namespace: nil)

#field_name(object_name, method_name, *method_names, multiple: false, index: nil)

#field_set_tag(legend = nil, options = nil, &block) Also known as: #fieldset_tag

Examples

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

#file_field_tag(name, options = {})

Options

Examples

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

Options

Examples

#form_tag_html(html_options) (private)

#form_tag_with_body(html_options, content) (private)

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

Options

Examples

#html_options_for_form(url_for_options, options) (private)

#image_submit_tag(source, options = {})

Options

Data attributes

Examples

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

Options

Examples

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

Options

Examples

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

Options

`TagHelper` - Included

`ContentExfiltrationPreventionHelper` - Included

`UrlHelper` - Included

`::ActiveSupport::Concern` - Extended

`SanitizeHelper` - Included

`UrlHelper` - Included

`ContentExfiltrationPreventionHelper` - Included

`TextHelper` - Included

`SanitizeHelper` - Included

`UrlHelper` - Included

`ContentExfiltrationPreventionHelper` - Included

`TagHelper` - Included

`OutputSafetyHelper` - Included

`CaptureHelper` - Included

#checkbox_tag(name, options = {}) #checkbox_tag(name, value, options = {}) #checkbox_tag(name, value, checked, options = {})
Also known as: #check_box_tag