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".
Creates a check box form input tag.
: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.
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" />
# File lib/action_view/helpers/form_tag_helper.rb, line 351 351: def check_box_tag(name, value = "1", checked = false, options = {}) 352: html_options = { "type" => "checkbox", "name" => name, "id" => sanitize_to_id(name), "value" => value }.update(options.stringify_keys) 353: html_options["checked"] = "checked" if checked 354: tag :input, html_options 355: end
Creates a text field of type “email”.
Accepts the same options as text_field_tag.
# File lib/action_view/helpers/form_tag_helper.rb, line 582 582: def email_field_tag(name, value = nil, options = {}) 583: text_field_tag(name, value, options.stringify_keys.update("type" => "email")) 584: end
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.
<%= 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>
# File lib/action_view/helpers/form_tag_helper.rb, line 545 545: def field_set_tag(legend = nil, options = nil, &block) 546: content = capture(&block) 547: output = tag(:fieldset, options, true) 548: output.safe_concat(content_tag(:legend, legend)) unless legend.blank? 549: output.concat(content) 550: output.safe_concat("</fieldset>") 551: end
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.
Creates standard HTML attributes for the tag.
:disabled - If set to true, the user will not be able to use this input.
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" />
# File lib/action_view/helpers/form_tag_helper.rb, line 251 251: def file_field_tag(name, options = {}) 252: text_field_tag(name, nil, options.update("type" => "file")) 253: end
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.
: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.
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
# File lib/action_view/helpers/form_tag_helper.rb, line 67 67: def form_tag(url_for_options = {}, options = {}, &block) 68: html_options = html_options_for_form(url_for_options, options) 69: if block_given? 70: form_tag_in_block(html_options, &block) 71: else 72: form_tag_html(html_options) 73: end 74: end
Displays an image which when clicked will submit the form.
source is passed to AssetTagHelper#path_to_image
: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.
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" />
# File lib/action_view/helpers/form_tag_helper.rb, line 513 513: def image_submit_tag(source, options = {}) 514: options = options.stringify_keys 515: 516: if confirm = options.delete("confirm") 517: ActiveSupport::Deprecation.warn ":confirm option is deprecated and will be removed from Rails 4.0. Use ':data => { :confirm => \'Text\' }' instead" 518: 519: options["data-confirm"] = confirm 520: end 521: 522: tag :input, { "type" => "image", "src" => path_to_image(source) }.update(options) 523: end
Creates a label element. Accepts a block.
Creates standard HTML attributes for the tag.
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>
# File lib/action_view/helpers/form_tag_helper.rb, line 187 187: def label_tag(name = nil, content_or_options = nil, options = nil, &block) 188: if block_given? && content_or_options.is_a?(Hash) 189: options = content_or_options = content_or_options.stringify_keys 190: else 191: options ||= {} 192: options = options.stringify_keys 193: end 194: options["for"] = sanitize_to_id(name) unless name.blank? || options.has_key?("for") 195: content_tag :label, content_or_options || name.to_s.humanize, options, &block 196: end
Creates a number field.
: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.
number_field_tag 'quantity', nil, :in => 1...10 # => <input id="quantity" name="quantity" min="1" max="9" type="number" />
# File lib/action_view/helpers/form_tag_helper.rb, line 599 599: def number_field_tag(name, value = nil, options = {}) 600: options = options.stringify_keys 601: options["type"] ||= "number" 602: if range = options.delete("in") || options.delete("within") 603: options.update("min" => range.min, "max" => range.max) 604: end 605: text_field_tag(name, value, options) 606: end
Creates a password field, a masked text field that will hide the users input behind a mask character.
: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.
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" />
# File lib/action_view/helpers/form_tag_helper.rb, line 284 284: def password_field_tag(name = "password", value = nil, options = {}) 285: text_field_tag(name, value, options.update("type" => "password")) 286: end
Creates a range form element.
Accepts the same options as number_field_tag.
# File lib/action_view/helpers/form_tag_helper.rb, line 612 612: def range_field_tag(name, value = nil, options = {}) 613: number_field_tag(name, value, options.stringify_keys.update("type" => "range")) 614: end
Creates a text field of type “search”.
Accepts the same options as text_field_tag.
# File lib/action_view/helpers/form_tag_helper.rb, line 557 557: def search_field_tag(name, value = nil, options = {}) 558: text_field_tag(name, value, options.stringify_keys.update("type" => "search")) 559: end
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.
: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.
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>
# File lib/action_view/helpers/form_tag_helper.rb, line 121 121: def select_tag(name, option_tags = nil, options = {}) 122: html_name = (options[:multiple] == true && !name.to_s.ends_with?("[]")) ? "#{name}[]" : name 123: 124: if options.delete(:include_blank) 125: option_tags = "<option value=\"\"></option>".html_safe + option_tags 126: end 127: 128: if prompt = options.delete(:prompt) 129: option_tags = "<option value=\"\">#{prompt}</option>".html_safe + option_tags 130: end 131: 132: content_tag :select, option_tags, { "name" => html_name, "id" => sanitize_to_id(name) }.update(options.stringify_keys) 133: end
Creates a submit button with the text value as the caption.
: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.
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?" />
# File lib/action_view/helpers/form_tag_helper.rb, line 416 416: def submit_tag(value = "Save changes", options = {}) 417: options = options.stringify_keys 418: 419: if disable_with = options.delete("disable_with") 420: ActiveSupport::Deprecation.warn ":disable_with option is deprecated and will be removed from Rails 4.0. Use 'data-disable-with' instead" 421: 422: options["data-disable-with"] = disable_with 423: end 424: 425: if confirm = options.delete("confirm") 426: ActiveSupport::Deprecation.warn ":confirm option is deprecated and will be removed from Rails 4.0. Use ':data => { :confirm => \'Text\' }' instead" 427: 428: options["data-confirm"] = confirm 429: end 430: 431: tag :input, { "type" => "submit", "name" => "commit", "value" => value }.update(options) 432: end
Creates a text field of type “tel”.
Accepts the same options as text_field_tag.
# File lib/action_view/helpers/form_tag_helper.rb, line 565 565: def telephone_field_tag(name, value = nil, options = {}) 566: text_field_tag(name, value, options.stringify_keys.update("type" => "tel")) 567: end
Creates a text input area; use a textarea for longer text inputs such as blog posts or descriptions.
: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.
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>
# File lib/action_view/helpers/form_tag_helper.rb, line 317 317: def text_area_tag(name, content = nil, options = {}) 318: options = options.stringify_keys 319: 320: if size = options.delete("size") 321: options["cols"], options["rows"] = size.split("x") if size.respond_to?(:split) 322: end 323: 324: escape = options.key?("escape") ? options.delete("escape") : true 325: content = ERB::Util.html_escape(content) if escape 326: 327: content_tag :textarea, content.to_s.html_safe, { "name" => name, "id" => sanitize_to_id(name) }.update(options) 328: end
Creates a standard text field; use these text fields to input smaller chunks of text like a username or a search query.
: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.
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" />
# File lib/action_view/helpers/form_tag_helper.rb, line 169 169: def text_field_tag(name, value = nil, options = {}) 170: tag :input, { "type" => "text", "name" => name, "id" => sanitize_to_id(name), "value" => value }.update(options.stringify_keys) 171: end
Creates a text field of type “url”.
Accepts the same options as text_field_tag.
# File lib/action_view/helpers/form_tag_helper.rb, line 574 574: def url_field_tag(name, value = nil, options = {}) 575: text_field_tag(name, value, options.stringify_keys.update("type" => "url")) 576: end
Creates the hidden UTF8 enforcer tag. Override this method in a helper to customize the tag.
# File lib/action_view/helpers/form_tag_helper.rb, line 618 618: def utf8_enforcer_tag 619: tag(:input, :type => "hidden", :name => "utf8", :value => "✓".html_safe) 620: end
# File lib/action_view/helpers/form_tag_helper.rb, line 666 666: def form_tag_html(html_options) 667: extra_tags = extra_tags_for_form(html_options) 668: (tag(:form, html_options, true) + extra_tags).html_safe 669: end
# File lib/action_view/helpers/form_tag_helper.rb, line 671 671: def form_tag_in_block(html_options, &block) 672: content = capture(&block) 673: output = ActiveSupport::SafeBuffer.new 674: output.safe_concat(form_tag_html(html_options)) 675: output << content 676: output.safe_concat("</form>") 677: end
# File lib/action_view/helpers/form_tag_helper.rb, line 623 623: def html_options_for_form(url_for_options, options) 624: options.stringify_keys.tap do |html_options| 625: html_options["enctype"] = "multipart/form-data" if html_options.delete("multipart") 626: # The following URL is unescaped, this is just a hash of options, and it is the 627: # responsibility of the caller to escape all the values. 628: html_options["action"] = url_for(url_for_options) 629: html_options["accept-charset"] = "UTF-8" 630: 631: html_options["data-remote"] = true if html_options.delete("remote") 632: 633: if html_options["data-remote"] && 634: !embed_authenticity_token_in_remote_forms && 635: html_options["authenticity_token"].blank? 636: # The authenticity token is taken from the meta tag in this case 637: html_options["authenticity_token"] = false 638: elsif html_options["authenticity_token"] == true 639: # Include the default authenticity_token, which is only generated when its set to nil, 640: # but we needed the true value to override the default of no authenticity_token on data-remote. 641: html_options["authenticity_token"] = nil 642: end 643: end 644: end
see www.w3.org/TR/html4/types.html#type-name
# File lib/action_view/helpers/form_tag_helper.rb, line 689 689: def sanitize_to_id(name) 690: name.to_s.gsub(']','').gsub(/[^-a-zA-Z0-9:.]/, "_") 691: end
# File lib/action_view/helpers/form_tag_helper.rb, line 679 679: def token_tag(token) 680: if token == false || !protect_against_forgery? 681: '' 682: else 683: token ||= form_authenticity_token 684: tag(:input, :type => "hidden", :name => request_forgery_protection_token.to_s, :value => token) 685: end 686: end
Disabled; run with --debug to generate this.
Generated with the Darkfish Rdoc Generator 1.1.6.