ActionView::Helpers::FormTagHelper - Ruby on Rails 中文

button_tag(content_or_options = nil, options = nil, &block) 链接

创建一个按钮元素，定义一个 submit 按钮、reset 按钮或一个可在 JavaScript 中使用的通用按钮，例如。您可以将按钮标签用作常规提交标签，但它不受旧版浏览器的支持。但是，按钮标签确实允许更丰富的标签，例如图像和强调，因此此助手也将接受一个代码块。默认情况下，它将创建一个类型为 submit 的按钮标签，如果未给出类型，则为 submit。

选项

:data - 此选项可用于添加自定义数据属性。
:disabled - 如果为 true，则用户将无法使用此输入。
任何其他键都会为标签创建标准的 HTML 选项。

示例

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) 链接

别名：checkbox_tag

checkbox_tag(name, options = {})
checkbox_tag(name, value, options = {})
checkbox_tag(name, value, checked, options = {}) 链接

创建一个复选框表单输入标签。

选项

:value - 输入的值。默认为 "1"。
:checked - 如果设置为 true，则复选框默认情况下会被选中。
:disabled - 如果设置为 true，则用户将无法使用此输入。
任何其他键都会为标签创建标准的 HTML 选项。

示例

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

也称为：check_box_tag

源代码：显示 | 在 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 = {}) 链接

创建一个类型为“color”的文本字段。

选项

支持与 text_field_tag 相同的选项。

示例

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

date_field_tag(name, value = nil, options = {}) 链接

创建一个类型为“date”的文本字段。

选项

支持与 text_field_tag 相同的选项。

示例

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

创建一个类型为“datetime-local”的文本字段。

选项

支持与 text_field_tag 相同的选项。此外，还支持

:min - 可接受的最小值。
:max - 可接受的最大值。
:step - 可接受的值粒度。
:include_seconds - 在输出时间戳格式中包含秒（默认情况下为 true）。

示例

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

也称为：datetime_local_field_tag

源代码：显示 | 在 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 = {}) 链接

别名：datetime_field_tag

email_field_tag(name, value = nil, options = {}) 链接

创建一个类型为“email”的文本字段。

选项

支持与 text_field_tag 相同的选项。

示例

email_field_tag 'name'
# => <input id="name" name="name" type="email" />

email_field_tag 'email', '[email protected]'
# => <input id="email" name="email" type="email" value="[email protected]" />

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

email_field_tag 'email', '[email protected]', class: 'special_input', disabled: true
# => <input disabled="disabled" class="special_input" id="email" name="email" type="email" value="[email protected]" />

源代码：显示 | 在 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

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

为给定的名称和字段组合生成一个 HTML id 属性值

返回 FormBuilder 为给定属性名称生成的 value。

<%= 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) %>

在上面的示例中，<input type="text"> 元素是由对 text_field 的调用构建的，它声明了一个 aria-describedby 属性，该属性引用了 <span> 元素，共享一个共同的 id 根（在本例中为 post_title）。

源代码：显示 | 在 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) 链接

为给定的名称和字段组合生成一个 HTML name 属性值

返回 FormBuilder 为给定属性名称生成的 value。

<%= 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) 链接

创建一个用于对 HTML 表单元素进行分组的字段集。

legend 将成为字段集的标题（根据 W3C 可选）。options 接受与标签相同的值。

示例

<%= 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>

也称为：fieldset_tag

源代码：显示 | 在 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) 链接

别名：field_set_tag

file_field_tag(name, options = {}) 链接

创建一个文件上传字段。如果您使用文件上传，则还需要为表单标签设置 multipart 选项

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

然后，指定的 URL 将传递一个 File 对象，其中包含所选文件，或者如果字段为空，则包含一个 StringIO 对象。

选项

为标签创建标准 HTML 属性。
:disabled - 如果设置为 true，则用户将无法使用此输入。
:multiple - 如果设置为 true，*在大多数更新的浏览器中*，用户将被允许选择多个文件。
:accept - 如果设置为一个或多个 mime 类型，则用户在选择文件时会建议使用过滤器。您仍然需要设置模型验证。

示例

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) 链接

启动一个表单标签，将操作指向使用 url_for_options 配置的 URL，就像 ActionController::Base#url_for 一样。表单的方法默认为 POST。

选项

:multipart - 如果设置为 true，则 enctype 设置为“multipart/form-data”。
:method - 提交表单时要使用的方法，通常是“get”或“post”。如果使用“patch”、“put”、“delete”或其他动词，则会添加一个名称为 _method 的隐藏输入，以模拟通过 post 的动词。
:authenticity_token - 在表单中使用的真实性令牌。仅当您需要传递自定义真实性令牌字符串或完全不添加真实性令牌字段（通过传递 false）时使用。远程表单可以通过设置 config.action_view.embed_authenticity_token_in_remote_forms = false 来省略嵌入的真实性令牌。当您对表单进行片段缓存时，这很有用。远程表单从 meta 标签获取真实性令牌，因此除非您支持没有 JavaScript 的浏览器，否则嵌入是不必要的。
:remote - 如果设置为 true，将允许 Unobtrusive JavaScript 驱动程序控制提交行为。默认情况下，此行为是 ajax 提交。
:enforce_utf8 - 如果设置为 false，则不会输出名称为 utf8 的隐藏输入。
任何其他键都会为标签创建标准的 HTML 属性。

示例

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

hidden_field_tag(name, value = nil, options = {}) 链接

创建一个隐藏的表单输入字段，用于传输由于 HTTP 的无状态性而丢失的数据或应向用户隐藏的数据。

选项

为标签创建标准 HTML 属性。

示例

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

image_submit_tag(source, options = {}) 链接

显示一个图像，单击该图像将提交表单。

source 传递给 AssetTagHelper#path_to_image

选项

:data - 此选项可用于添加自定义数据属性。
:disabled - 如果设置为 true，则用户将无法使用此输入。
任何其他键都会为标签创建标准的 HTML 选项。

数据属性

confirm: 'question?' - 这将添加一个带有指定问题的 JavaScript 确认提示。如果用户接受，则表单将正常处理，否则不采取任何操作。

示例

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) 链接

创建一个标签元素。接受一个块。

选项

为标签创建标准 HTML 属性。

示例

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>

模块 ActionView::Helpers::FormTagHelper

Action View 表单标签助手

实例公有方法

button_tag(content_or_options = nil, options = nil, &block) 链接

选项

示例

check_box_tag(name, *args) 链接

checkbox_tag(name, options = {})checkbox_tag(name, value, options = {})checkbox_tag(name, value, checked, options = {}) 链接

选项

示例

color_field_tag(name, value = nil, options = {}) 链接

选项

示例

date_field_tag(name, value = nil, options = {}) 链接

选项

示例

datetime_field_tag(name, value = nil, options = {}) 链接

选项

示例

datetime_local_field_tag(name, value = nil, options = {}) 链接

email_field_tag(name, value = nil, options = {}) 链接

选项

示例

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) 链接

示例

fieldset_tag(legend = nil, options = nil, &block) 链接

file_field_tag(name, options = {}) 链接

选项

示例

form_tag(url_for_options = {}, options = {}, &block) 链接

选项

示例

hidden_field_tag(name, value = nil, options = {}) 链接

选项

示例

image_submit_tag(source, options = {}) 链接

选项

数据属性

示例

label_tag(name = nil, content_or_options = nil, options = nil, &block) 链接

选项

示例

month_field_tag(name, value = nil, options = {}) 链接

选项

示例

number_field_tag(name, value = nil, options = {}) 链接

选项

示例

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

选项

示例

phone_field_tag(name, value = nil, options = {}) 链接

radio_button_tag(name, value, options = {})radio_button_tag(name, value, checked, options = {}) 链接

选项

示例

range_field_tag(name, value = nil, options = {}) 链接

选项

示例

search_field_tag(name, value = nil, options = {}) 链接

选项

示例

select_tag(name, option_tags = nil, options = {}) 链接

选项

示例

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

选项

示例

telephone_field_tag(name, value = nil, options = {}) 链接

选项

示例

text_area_tag(name, content = nil, options = {}) 链接

text_field_tag(name, value = nil, options = {}) 链接

选项

示例

textarea_tag(name, content = nil, options = {}) 链接

选项

示例

time_field_tag(name, value = nil, options = {}) 链接

checkbox_tag(name, options = {})
checkbox_tag(name, value, options = {})
checkbox_tag(name, value, checked, options = {}) 链接

radio_button_tag(name, value, options = {})
radio_button_tag(name, value, checked, options = {}) 链接