instance method
tag
Ruby on Rails edge
Signature
tag(name = nil, options = nil, open = false, escape = true)Modern syntax
Builds HTML5 compliant tags with a tag proxy. Every tag can be built with:
tag.<tag name>(optional content, options)
where tag name can be e.g. br, div, section, article, or any tag really.
Returns an instance of TagBuilder when invoked without positional, keyword, or block arguments.
Legacy syntax
Returns an HTML tag.
The following format is for legacy syntax support. It will be deprecated in future versions of Rails.
tag(name, options = nil, open = false, escape = true)
It returns an empty HTML tag of type name which by default is XHTML compliant. Set open to true to create an open tag compatible with HTML 4.0 and below. Add HTML attributes by passing an attributes hash to options. Set escape to false to disable attribute value escaping.
Options
You can use symbols or strings for the attribute names.
Use true with boolean attributes that can render with no value, like disabled and readonly.
HTML5 data-* attributes can be set with a single data key pointing to a hash of sub-attributes.
Examples
tag("br")
# => <br />
tag("br", nil, true)
# => <br>
tag("input", type: 'text', disabled: true)
# => <input type="text" disabled="disabled" />
tag("input", type: 'text', class: ["strong", "highlight"])
# => <input class="strong highlight" type="text" />
tag("img", src: "open & shut.png")
# => <img src="open & shut.png" />
tag("img", { src: "open & shut.png" }, false, false)
# => <img src="open & shut.png" />
tag("div", data: { name: 'Stephen', city_state: %w(Chicago IL) })
# => <div data-name="Stephen" data-city-state="["Chicago","IL"]" />
tag("div", class: { highlight: current_user.admin? })
# => <div class="highlight" />
Parameters
-
nameopt = nil -
optionsopt = nil -
openopt = false -
escapeopt = true
Source
# File actionview/lib/action_view/helpers/tag_helper.rb, line 1671
def tag(name = nil, options = nil, open = false, escape = true)
if name.nil?
tag_builder
else
ensure_valid_html5_tag_name(name)
"<#{name}#{tag_builder.tag_options(options, escape) if options}#{open ? ">" : " />"}".html_safe
end
end
Defined in actionview/lib/action_view/helpers/tag_helper.rb line 1671
· View on GitHub
· Improve this page
· Find usages on GitHub
Defined in ActionView::Helpers::TagHelper