Module: ActionView::Helpers::FormTagHelper
- Extended by:
- ActiveSupport::Concern
- Includes:
- TextHelper, UrlHelper
- Included in:
- ActionView::Helpers
- Defined in:
- actionpack/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
Constant Summary
Constants included from TextHelper
TextHelper::AUTO_EMAIL_RE, TextHelper::AUTO_LINK_CRE, TextHelper::AUTO_LINK_RE, TextHelper::BRACKETS
Constants included from TagHelper
Instance Method Summary (collapse)
-
- (Object) button_tag(label = "Button",, options = {})
Creates a button element that defines a submit button, resetbutton or a generic button which can be used in JavaScript, for example.
-
- (Object) check_box_tag(name, value = "1",, checked = false, options = {})
Creates a check box form input tag.
-
- (Object) email_field_tag(name, value = nil, options = {})
Creates a text field of type "email".
-
- (Object) field_set_tag(legend = nil, options = nil, &block)
Creates a field set for grouping HTML form elements.
-
- (Object) file_field_tag(name, options = {})
Creates a file upload field.
-
- (Object) form_tag(url_for_options = {}, options = {}, *parameters_for_url, &block)
Starts a form tag that points the action to an url configured with url_for_options just like ActionController::Base#url_for.
-
- (Object) 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.
-
- (Object) image_submit_tag(source, options = {})
Displays an image which when clicked will submit the form.
-
- (Object) label_tag(name = nil, content_or_options = nil, options = nil, &block)
Creates a label element.
-
- (Object) number_field_tag(name, value = nil, options = {})
Creates a number field.
-
- (Object) 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.
-
- (Object) 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.
-
- (Object) range_field_tag(name, value = nil, options = {})
Creates a range form element.
-
- (Object) search_field_tag(name, value = nil, options = {})
Creates a text field of type "search".
-
- (Object) 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.
-
- (Object) submit_tag(value = "Save changes",, options = {})
Creates a submit button with the text value as the caption.
-
- (Object) telephone_field_tag(name, value = nil, options = {})
(also: #phone_field_tag)
Creates a text field of type "tel".
-
- (Object) 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.
-
- (Object) 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.
-
- (Object) url_field_tag(name, value = nil, options = {})
Creates a text field of type "url".
Methods included from ActiveSupport::Concern
append_features, extended, included
Methods included from TextHelper
#auto_link, #concat, #current_cycle, #cycle, #excerpt, #highlight, #pluralize, #reset_cycle, #safe_concat, #simple_format, #truncate, #word_wrap
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 TagHelper
#cdata_section, #content_tag, #escape_once, #tag
Methods included from CaptureHelper
#capture, #content_for, #content_for?, #flush_output_buffer, #with_output_buffer
Methods included from ActionDispatch::Routing::UrlFor
#initialize, #url_for, #url_options
Methods included from ActionDispatch::Routing::PolymorphicRoutes
#polymorphic_path, #polymorphic_url
Instance Method Details
- (Object) button_tag(label = "Button",, options = {})
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, button tag allows richer labels such as images and emphasis.
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="button">Button</button>
button_tag "<strong>Ask me!</strong>"
# => <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="button">Checkout</button>
445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 |
# File 'actionpack/lib/action_view/helpers/form_tag_helper.rb', line 445 def (label = "Button", = {}) .stringify_keys! if disable_with = .delete("disable_with") ["data-disable-with"] = disable_with end if confirm = .delete("confirm") ["data-confirm"] = confirm end ["type", "name"].each do |option| [option] = "button" unless [option] end content_tag :button, label, { "type" => .delete("type") }.update() end |
- (Object) 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" />
330 331 332 333 334 |
# File 'actionpack/lib/action_view/helpers/form_tag_helper.rb', line 330 def check_box_tag(name, value = "1", checked = false, = {}) = { "type" => "checkbox", "name" => name, "id" => sanitize_to_id(name), "value" => value }.update(.stringify_keys) ["checked"] = "checked" if checked tag :input, end |
- (Object) email_field_tag(name, value = nil, options = {})
Creates a text field of type "email".
Options
-
Accepts the same options as text_field_tag.
553 554 555 |
# File 'actionpack/lib/action_view/helpers/form_tag_helper.rb', line 553 def email_field_tag(name, value = nil, = {}) text_field_tag(name, value, .stringify_keys.update("type" => "email")) end |
- (Object) 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>
516 517 518 519 520 521 522 |
# File 'actionpack/lib/action_view/helpers/form_tag_helper.rb', line 516 def field_set_tag(legend = nil, = nil, &block) content = capture(&block) output = tag(:fieldset, , true) output.safe_concat(content_tag(:legend, legend)) unless legend.blank? output.concat(content) output.safe_concat("</fieldset>") end |
- (Object) 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.
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" />
230 231 232 |
# File 'actionpack/lib/action_view/helpers/form_tag_helper.rb', line 230 def file_field_tag(name, = {}) text_field_tag(name, nil, .update("type" => "file")) end |
- (Object) form_tag(url_for_options = {}, options = {}, *parameters_for_url, &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 ???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).
-
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 behaviour. By default this behaviour 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
59 60 61 62 63 64 65 66 |
# File 'actionpack/lib/action_view/helpers/form_tag_helper.rb', line 59 def form_tag( = {}, = {}, *parameters_for_url, &block) = (, , *parameters_for_url) if block_given? form_tag_in_block(, &block) else form_tag_html() end end |
- (Object) 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="" />
193 194 195 |
# File 'actionpack/lib/action_view/helpers/form_tag_helper.rb', line 193 def hidden_field_tag(name, value = nil, = {}) text_field_tag(name, value, .stringify_keys.update("type" => "hidden")) end |
- (Object) image_submit_tag(source, options = {})
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" />
486 487 488 489 490 491 492 493 494 |
# File 'actionpack/lib/action_view/helpers/form_tag_helper.rb', line 486 def image_submit_tag(source, = {}) .stringify_keys! if confirm = .delete("confirm") ["data-confirm"] = confirm end tag :input, { "type" => "image", "src" => path_to_image(source) }.update(.stringify_keys) end |
- (Object) 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>
169 170 171 172 173 174 175 |
# File 'actionpack/lib/action_view/helpers/form_tag_helper.rb', line 169 def label_tag(name = nil, = nil, = nil, &block) = if block_given? && .is_a?(Hash) ||= {} .stringify_keys! ["for"] = sanitize_to_id(name) unless name.blank? || .has_key?("for") content_tag :label, || name.to_s.humanize, , &block end |
- (Object) 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.
-
: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" />
570 571 572 573 574 575 576 577 |
# File 'actionpack/lib/action_view/helpers/form_tag_helper.rb', line 570 def number_field_tag(name, value = nil, = {}) = .stringify_keys ["type"] ||= "number" if range = .delete("in") || .delete("within") .update("min" => range.min, "max" => range.max) end text_field_tag(name, value, ) end |
- (Object) 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" />
263 264 265 |
# File 'actionpack/lib/action_view/helpers/form_tag_helper.rb', line 263 def password_field_tag(name = "password", value = nil, = {}) text_field_tag(name, value, .update("type" => "password")) end |
- (Object) 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
'gender', 'male'
# => <input id="gender_male" name="gender" type="radio" value="male" />
'receive_updates', 'no', true
# => <input checked="checked" id="receive_updates_no" name="receive_updates" type="radio" value="no" />
'time_slot', "3:00 p.m.", false, :disabled => true
# => <input disabled="disabled" id="time_slot_300_pm" name="time_slot" type="radio" value="3:00 p.m." />
'color', "green", true, :class => "color_input"
# => <input checked="checked" class="color_input" id="color_green" name="color" type="radio" value="green" />
355 356 357 358 359 |
# File 'actionpack/lib/action_view/helpers/form_tag_helper.rb', line 355 def (name, value, checked = false, = {}) = { "type" => "radio", "name" => name, "id" => "#{sanitize_to_id(name)}_#{sanitize_to_id(value)}", "value" => value }.update(.stringify_keys) ["checked"] = "checked" if checked tag :input, end |
- (Object) range_field_tag(name, value = nil, options = {})
Creates a range form element.
Options
-
Accepts the same options as number_field_tag.
583 584 585 |
# File 'actionpack/lib/action_view/helpers/form_tag_helper.rb', line 583 def range_field_tag(name, value = nil, = {}) number_field_tag(name, value, .stringify_keys.update("type" => "range")) end |
- (Object) search_field_tag(name, value = nil, options = {})
Creates a text field of type "search".
Options
-
Accepts the same options as text_field_tag.
528 529 530 |
# File 'actionpack/lib/action_view/helpers/form_tag_helper.rb', line 528 def search_field_tag(name, value = nil, = {}) text_field_tag(name, value, .stringify_keys.update("type" => "search")) end |
- (Object) 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.
-
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>"
# => <select id="people" name="people"><option>David</option></select>
select_tag "count", "<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", "<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", "<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", "<option>Read</option><option>Write</option>", :multiple => true, :class => 'form_input'
# => <select class="form_input" id="access" multiple="multiple" name="access[]"><option>Read</option>
# <option>Write</option></select>
select_tag "destination", "<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>
105 106 107 108 109 110 111 112 113 114 115 |
# File 'actionpack/lib/action_view/helpers/form_tag_helper.rb', line 105 def select_tag(name, = nil, = {}) html_name = ([:multiple] == true && !name.to_s.ends_with?("[]")) ? "#{name}[]" : name if blank = .delete(:include_blank) if blank.kind_of?(String) = "<option value=\"\">#{blank}</option>".html_safe + else = "<option value=\"\"></option>".html_safe + end end content_tag :select, , { "name" => html_name, "id" => sanitize_to_id(name) }.update(.stringify_keys) end |
- (Object) submit_tag(value = "Save changes",, options = {})
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?" />
399 400 401 402 403 404 405 406 407 408 409 410 411 |
# File 'actionpack/lib/action_view/helpers/form_tag_helper.rb', line 399 def submit_tag(value = "Save changes", = {}) .stringify_keys! if disable_with = .delete("disable_with") ["data-disable-with"] = disable_with end if confirm = .delete("confirm") ["data-confirm"] = confirm end tag :input, { "type" => "submit", "name" => "commit", "value" => value }.update(.stringify_keys) end |
- (Object) 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.
536 537 538 |
# File 'actionpack/lib/action_view/helpers/form_tag_helper.rb', line 536 def telephone_field_tag(name, value = nil, = {}) text_field_tag(name, value, .stringify_keys.update("type" => "tel")) end |
- (Object) 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>
296 297 298 299 300 301 302 303 304 305 306 307 |
# File 'actionpack/lib/action_view/helpers/form_tag_helper.rb', line 296 def text_area_tag(name, content = nil, = {}) .stringify_keys! if size = .delete("size") ["cols"], ["rows"] = size.split("x") if size.respond_to?(:split) end escape = .key?("escape") ? .delete("escape") : true content = ERB::Util.html_escape(content) if escape content_tag :textarea, content.to_s.html_safe, { "name" => name, "id" => sanitize_to_id(name) }.update() end |
- (Object) 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" />
151 152 153 |
# File 'actionpack/lib/action_view/helpers/form_tag_helper.rb', line 151 def text_field_tag(name, value = nil, = {}) tag :input, { "type" => "text", "name" => name, "id" => sanitize_to_id(name), "value" => value }.update(.stringify_keys) end |
- (Object) url_field_tag(name, value = nil, options = {})
Creates a text field of type "url".
Options
-
Accepts the same options as text_field_tag.
545 546 547 |
# File 'actionpack/lib/action_view/helpers/form_tag_helper.rb', line 545 def url_field_tag(name, value = nil, = {}) text_field_tag(name, value, .stringify_keys.update("type" => "url")) end |