Module: ActionView::Helpers::FormTagHelper

Extended by:
ActiveSupport::Concern
Includes:
TextHelper, UrlHelper
Included in:
ActionView::Helpers, FormHelper, InstanceTag
Defined in:
lib/action_view/helpers/form_tag_helper.rb

Overview

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

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

Constant Summary

Constants included from TagHelper

TagHelper::BOOLEAN_ATTRIBUTES, TagHelper::PRE_CONTENT_STRINGS

Instance Method Summary collapse

Methods included from TextHelper

#concat, #current_cycle, #cycle, #excerpt, #highlight, #pluralize, #reset_cycle, #safe_concat, #simple_format, #truncate, #word_wrap

Methods included from TagHelper

#cdata_section, #content_tag, #escape_once, #tag

Methods included from CaptureHelper

#capture, #content_for, #content_for?, #flush_output_buffer, #provide, #with_output_buffer

Methods included from SanitizeHelper

#sanitize, #sanitize_css, #strip_links, #strip_tags

Methods included from UrlHelper

#_routes_context, #button_to, #current_page?, #link_to, #link_to_if, #link_to_unless, #link_to_unless_current, #mail_to, #url_for, #url_options

Methods included from ActionDispatch::Routing::UrlFor

#initialize, #url_for, #url_options

Methods included from ActionDispatch::Routing::PolymorphicRoutes

#polymorphic_path, #polymorphic_url

Instance Method Details

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

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

  • :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.

  • :disabled - If true, the user will not be able to use this input.

  • :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.

  • Any other key creates standard HTML options for the tag.

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", :disable_with => "Please wait..."
# => <button data-disable-with="Please wait..." name="button" type="submit">Checkout</button>



465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
 
# File 'lib/action_view/helpers/form_tag_helper.rb', line 465

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

  if disable_with = options.delete("disable_with")
    options["data-disable-with"] = disable_with
  end

  if confirm = options.delete("confirm")
    options["data-confirm"] = confirm
  end

  options.reverse_merge! 'name' => 'button', 'type' => 'submit'

  content_tag :button, content_or_options || 'Button', options, &block
end

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

Creates a check box form input tag.

Options

  • :disabled - If set to true, the user will not be able to use this input.

  • Any other key creates standard HTML options for the tag.

Examples

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

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

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

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

check_box_tag 'eula', 'accepted', false, :disabled => true
# => <input disabled="disabled" id="eula" name="eula" type="checkbox" value="accepted" />



352
353
354
355
356
 
# File 'lib/action_view/helpers/form_tag_helper.rb', line 352

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

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

Creates a text field of type “email”.

Options

  • Accepts the same options as text_field_tag.



573
574
575
 
# File 'lib/action_view/helpers/form_tag_helper.rb', line 573

def email_field_tag(name, value = nil, options = {})
  text_field_tag(name, value, options.stringify_keys.update("type" => "email"))
end

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

Creates a field set for grouping HTML form elements.

legend will become the fieldset’s title (optional as per W3C). options accept the same values as tag.

Examples

<%= field_set_tag do %>
  <p><%= text_field_tag 'name' %></p>
<% end %>
# => <fieldset><p><input id="name" name="name" type="text" /></p></fieldset>

<%= field_set_tag 'Your details' do %>
  <p><%= text_field_tag 'name' %></p>
<% end %>
# => <fieldset><legend>Your details</legend><p><input id="name" name="name" type="text" /></p></fieldset>

<%= field_set_tag nil, :class => 'format' do %>
  <p><%= text_field_tag 'name' %></p>
<% end %>
# => <fieldset class="format"><p><input id="name" name="name" type="text" /></p></fieldset>



536
537
538
539
540
541
542
 
# File 'lib/action_view/helpers/form_tag_helper.rb', line 536

def field_set_tag(legend = nil, options = nil, &block)
  content = capture(&block)
  output = tag(:fieldset, options, true)
  output.safe_concat(content_tag(:legend, legend)) unless legend.blank?
  output.concat(content)
  output.safe_concat("</fieldset>")
end

#file_field_tag(name, options = {}) ⇒ Object

Creates a file upload field. If you are using file uploads then you will also need to set the multipart option for the form tag:

<%= form_tag '/upload', :multipart => true do %>
  <label for="file">File to Upload</label> <%= file_field_tag "file" %>
  <%= submit_tag %>
<% end %>

The specified URL will then be passed a File object containing the selected file, or if the field was left blank, a StringIO object.

Options

  • Creates standard HTML attributes for the tag.

  • :disabled - If set to true, the user will not be able to use this input.

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



252
253
254
 
# File 'lib/action_view/helpers/form_tag_helper.rb', line 252

def file_field_tag(name, options = {})
  text_field_tag(name, nil, options.update("type" => "file"))
end

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

Starts a form tag that points the action to an url configured with url_for_options just like ActionController::Base#url_for. The method for the form defaults to POST.

Options

  • :multipart - If set to true, the enctype is set to “multipart/form-data”.

  • :method - The method to use when submitting the form, usually either “get” or “post”. If “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 from the meta tag, so embedding is unnecessary unless you support browsers without JavaScript.

  • A list of parameters to feed to the URL the form will be posted to.

  • :remote - If set to true, will allow the Unobtrusive JavaScript drivers to control the submit behavior. By default this behavior is an ajax submit.

Examples

form_tag('/posts')
# => <form action="/posts" method="post">

form_tag('/posts/1', :method => :put)
# => <form action="/posts/1" method="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="submit" value="Save" /></div></form>

<%= form_tag('/posts', :remote => true) %>
# => <form action="/posts" method="post" data-remote="true">

form_tag('http://far.away.com/form', :authenticity_token => false)
# form without authenticity token

form_tag('http://far.away.com/form', :authenticity_token => "cf50faa3fe97702ca1ae")
# form with custom authenticity token



67
68
69
70
71
72
73
74
 
# File 'lib/action_view/helpers/form_tag_helper.rb', line 67

def form_tag(url_for_options = {}, options = {}, &block)
  html_options = html_options_for_form(url_for_options, options)
  if block_given?
    form_tag_in_block(html_options, &block)
  else
    form_tag_html(html_options)
  end
end

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

Creates a hidden form input field used to transmit data that would be lost due to HTTP’s statelessness or data that should be hidden from the user.

Options

  • Creates standard HTML attributes for the tag.

Examples

hidden_field_tag 'tags_list'
# => <input id="tags_list" name="tags_list" type="hidden" />

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

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



215
216
217
 
# File 'lib/action_view/helpers/form_tag_helper.rb', line 215

def hidden_field_tag(name, value = nil, options = {})
  text_field_tag(name, value, options.stringify_keys.update("type" => "hidden"))
end

#image_submit_tag(source, options = {}) ⇒ Object

Displays an image which when clicked will submit the form.

source is passed to AssetTagHelper#path_to_image

Options

  • :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.

  • :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

image_submit_tag("login.png")
# => <input src="/images/login.png" type="image" />

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

image_submit_tag("search.png", :class => 'search_button')
# => <input class="search_button" src="/images/search.png" type="image" />

image_submit_tag("agree.png", :disabled => true, :class => "agree_disagree_button")
# => <input class="agree_disagree_button" disabled="disabled" src="/images/agree.png" type="image" />



506
507
508
509
510
511
512
513
514
 
# File 'lib/action_view/helpers/form_tag_helper.rb', line 506

def image_submit_tag(source, options = {})
  options = options.stringify_keys

  if confirm = options.delete("confirm")
    options["data-confirm"] = confirm
  end

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

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

Creates a label element. Accepts a block.

Options

  • Creates standard HTML attributes for the tag.

Examples

label_tag 'name'
# => <label for="name">Name</label>

label_tag 'name', 'Your name'
# => <label for="name">Your Name</label>

label_tag 'name', nil, :class => 'small_label'
# => <label for="name" class="small_label">Name</label>



188
189
190
191
192
193
194
195
196
197
 
# File 'lib/action_view/helpers/form_tag_helper.rb', line 188

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

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

Creates a number field.

Options

  • :min - The minimum acceptable value.

  • :max - The maximum acceptable value.

  • :in - A range specifying the :min and :max values.

  • :step - The acceptable value granularity.

  • Otherwise accepts the same options as text_field_tag.

Examples

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



590
591
592
593
594
595
596
597
 
# File 'lib/action_view/helpers/form_tag_helper.rb', line 590

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

Creates a password field, a masked text field that will hide the users input behind a mask character.

Options

  • :disabled - If set to true, the user will not be able to use this input.

  • :size - The number of visible characters that will fit in the input.

  • :maxlength - The maximum number of characters that the browser will allow the user to enter.

  • Any other key creates standard HTML attributes for the tag.

Examples

password_field_tag 'pass'
# => <input id="pass" name="pass" type="password" />

password_field_tag 'secret', 'Your secret here'
# => <input id="secret" name="secret" type="password" value="Your secret here" />

password_field_tag 'masked', nil, :class => 'masked_input_field'
# => <input class="masked_input_field" id="masked" name="masked" type="password" />

password_field_tag 'token', '', :size => 15
# => <input id="token" name="token" size="15" type="password" value="" />

password_field_tag 'key', nil, :maxlength => 16
# => <input id="key" maxlength="16" name="key" type="password" />

password_field_tag 'confirm_pass', nil, :disabled => true
# => <input disabled="disabled" id="confirm_pass" name="confirm_pass" type="password" />

password_field_tag 'pin', '1234', :maxlength => 4, :size => 6, :class => "pin_input"
# => <input class="pin_input" id="pin" maxlength="4" name="pin" size="6" type="password" value="1234" />



285
286
287
 
# File 'lib/action_view/helpers/form_tag_helper.rb', line 285

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

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

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

Options

  • :disabled - If set to true, the user will not be able to use this input.

  • Any other key creates standard HTML options for the tag.

Examples

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



377
378
379
380
381
 
# File 'lib/action_view/helpers/form_tag_helper.rb', line 377

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

Creates a range form element.

Options

  • Accepts the same options as number_field_tag.



603
604
605
 
# File 'lib/action_view/helpers/form_tag_helper.rb', line 603

def range_field_tag(name, value = nil, options = {})
  number_field_tag(name, value, options.stringify_keys.update("type" => "range"))
end

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

Creates a text field of type “search”.

Options

  • Accepts the same options as text_field_tag.



548
549
550
 
# File 'lib/action_view/helpers/form_tag_helper.rb', line 548

def search_field_tag(name, value = nil, options = {})
  text_field_tag(name, value, options.stringify_keys.update("type" => "search"))
end

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

Creates a dropdown selection box, or if the :multiple option is set to true, a multiple choice selection box.

Helpers::FormOptions can be used to create common select boxes such as countries, time zones, or associated records. option_tags is a string containing the option tags for the select box.

Options

  • :multiple - If set to true the selection will allow multiple choices.

  • :disabled - If set to true, the user will not be able to use this input.

  • :include_blank - If set to true, an empty option will be create

  • :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", "<option>David</option>".html_safe
# => <select id="people" name="people"><option>David</option></select>

select_tag "count", "<option>1</option><option>2</option><option>3</option><option>4</option>".html_safe
# => <select id="count" name="count"><option>1</option><option>2</option>
#    <option>3</option><option>4</option></select>

select_tag "colors", "<option>Red</option><option>Green</option><option>Blue</option>".html_safe, :multiple => true
# => <select id="colors" multiple="multiple" name="colors[]"><option>Red</option>
#    <option>Green</option><option>Blue</option></select>

select_tag "locations", "<option>Home</option><option selected="selected">Work</option><option>Out</option>".html_safe
# => <select id="locations" name="locations"><option>Home</option><option selected='selected'>Work</option>
#    <option>Out</option></select>

select_tag "access", "<option>Read</option><option>Write</option>".html_safe, :multiple => true, :class => 'form_input'
# => <select class="form_input" id="access" multiple="multiple" name="access[]"><option>Read</option>
#    <option>Write</option></select>

select_tag "people", 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"), :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>



121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/action_view/helpers/form_tag_helper.rb', line 121

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

  if options.delete(:include_blank)
    option_tags = content_tag(:option, '', :value => '').safe_concat(option_tags)
  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 = {}) ⇒ Object

Creates a submit button with the text value as the caption.

Options

  • :confirm => 'question?' - If present the unobtrusive JavaScript drivers will provide a prompt with the question specified. If the user accepts, the form is processed normally, otherwise no action is taken.

  • :disabled - If true, the user will not be able to use this input.

  • :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.

  • Any other key creates standard HTML options for the tag.

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", :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", :disable_with => "Editing...", :class => "edit_button"
# => <input class="edit_button" data-disable_with="Editing..." name="commit" type="submit" value="Edit" />

submit_tag "Save", :confirm => "Are you sure?"
# => <input name='commit' type='submit' value='Save' data-confirm="Are you sure?" />



417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/action_view/helpers/form_tag_helper.rb', line 417

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

  if disable_with = options.delete("disable_with")
    options["data-disable-with"] = disable_with
  end

  if confirm = options.delete("confirm")
    options["data-confirm"] = confirm
  end

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

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

Creates a text field of type “tel”.

Options

  • Accepts the same options as text_field_tag.



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

def telephone_field_tag(name, value = nil, options = {})
  text_field_tag(name, value, options.stringify_keys.update("type" => "tel"))
end

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

Creates a text input area; use a textarea for longer text inputs such as blog posts or descriptions.

Options

  • :size - A string specifying the dimensions (columns by rows) of the textarea (e.g., “25x10”).

  • :rows - Specify the number of rows in the textarea

  • :cols - Specify the number of columns in the textarea

  • :disabled - If set to true, the user will not be able to use this input.

  • :escape - By default, the contents of the text input are HTML escaped. If you need unescaped contents, set this to false.

  • Any other key creates standard HTML attributes for the tag.

Examples

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

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

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

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

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

text_area_tag 'comment', nil, :class => 'comment_input'
# => <textarea class="comment_input" id="comment" name="comment"></textarea>



318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/action_view/helpers/form_tag_helper.rb', line 318

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.key?("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 = {}) ⇒ Object

Creates a standard text field; use these text fields to input smaller chunks of text like a username or a search query.

Options

  • :disabled - If set to true, the user will not be able to use this input.

  • :size - The number of visible characters that will fit in the input.

  • :maxlength - The maximum number of characters that the browser will allow the user to enter.

  • :placeholder - The text contained in the field by default which is removed when the field receives focus.

  • Any other key creates standard HTML attributes for the tag.

Examples

text_field_tag 'name'
# => <input id="name" name="name" type="text" />

text_field_tag 'query', 'Enter your search query here'
# => <input id="query" name="query" type="text" value="Enter your search query here" />

text_field_tag 'search', nil, :placeholder => 'Enter search term...'
# => <input id="search" name="search" placeholder="Enter search term..." type="text" />

text_field_tag 'request', nil, :class => 'special_input'
# => <input class="special_input" id="request" name="request" type="text" />

text_field_tag 'address', '', :size => 75
# => <input id="address" name="address" size="75" type="text" value="" />

text_field_tag 'zip', nil, :maxlength => 5
# => <input id="zip" maxlength="5" name="zip" type="text" />

text_field_tag 'payment_amount', '$0.00', :disabled => true
# => <input disabled="disabled" id="payment_amount" name="payment_amount" type="text" value="$0.00" />

text_field_tag 'ip', '0.0.0.0', :maxlength => 15, :size => 20, :class => "ip-input"
# => <input class="ip-input" id="ip" maxlength="15" name="ip" size="20" type="text" value="0.0.0.0" />



170
171
172
 
# File 'lib/action_view/helpers/form_tag_helper.rb', line 170

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

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

Creates a text field of type “url”.

Options

  • Accepts the same options as text_field_tag.



565
566
567
 
# File 'lib/action_view/helpers/form_tag_helper.rb', line 565

def url_field_tag(name, value = nil, options = {})
  text_field_tag(name, value, options.stringify_keys.update("type" => "url"))
end

#utf8_enforcer_tag ⇒ Object

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



609
610
611
 
# File 'lib/action_view/helpers/form_tag_helper.rb', line 609

def utf8_enforcer_tag
  tag(:input, :type => "hidden", :name => "utf8", :value => "&#x2713;".html_safe)
end