Module: ActionView::Helpers::TagHelper
Relationships & Source Files | |
Extension / Inclusion / Inheritance Descendants | |
Included In:
ActionDispatch::DebugView,
::ActionView::Base ,
::ActionView::Helpers ,
AssetTagHelper ,
ActionView::Helpers::DateTimeSelector,
DebugHelper ,
FormHelper ,
FormOptionsHelper ,
FormTagHelper ,
ActionView::Helpers::Tags::Base,
ActionView::Helpers::Tags::CheckBox,
ActionView::Helpers::Tags::CollectionCheckBoxes,
ActionView::Helpers::Tags::CollectionRadioButtons,
ActionView::Helpers::Tags::CollectionSelect,
ActionView::Helpers::Tags::ColorField,
ActionView::Helpers::Tags::DateField,
ActionView::Helpers::Tags::DateSelect,
ActionView::Helpers::Tags::DatetimeField,
ActionView::Helpers::Tags::DatetimeLocalField,
ActionView::Helpers::Tags::DatetimeSelect,
ActionView::Helpers::Tags::EmailField,
ActionView::Helpers::Tags::FileField,
ActionView::Helpers::Tags::GroupedCollectionSelect,
ActionView::Helpers::Tags::HiddenField,
ActionView::Helpers::Tags::Label,
ActionView::Helpers::Tags::MonthField,
ActionView::Helpers::Tags::NumberField,
ActionView::Helpers::Tags::PasswordField,
ActionView::Helpers::Tags::RadioButton,
ActionView::Helpers::Tags::RangeField,
ActionView::Helpers::Tags::SearchField,
ActionView::Helpers::Tags::Select,
ActionView::Helpers::Tags::TelField,
ActionView::Helpers::Tags::TextArea,
ActionView::Helpers::Tags::TextField,
ActionView::Helpers::Tags::TimeField,
ActionView::Helpers::Tags::TimeSelect,
ActionView::Helpers::Tags::TimeZoneSelect,
ActionView::Helpers::Tags::UrlField,
ActionView::Helpers::Tags::WeekField,
ActionView::Helpers::Tags::WeekdaySelect,
TextHelper ,
TranslationHelper ,
UrlHelper ,
::ActionView::TestCase ,
::ActionView::TestCase::Behavior
| |
Super Chains via Extension / Inclusion / Inheritance | |
Instance Chain:
self,
OutputSafetyHelper ,
CaptureHelper
|
|
Defined in: | actionview/lib/action_view/helpers/tag_helper.rb |
Overview
Action View Tag Helpers
Provides methods to generate HTML tags programmatically both as a modern HTML5 compliant builder style and legacy XHTML compliant tags.
Constant Summary
-
ARIA_PREFIXES =
# File 'actionview/lib/action_view/helpers/tag_helper.rb', line 32["aria", :aria].to_set.freeze
-
BOOLEAN_ATTRIBUTES =
# File 'actionview/lib/action_view/helpers/tag_helper.rb', line 19%w(allowfullscreen allowpaymentrequest async autofocus autoplay checked compact controls declare default defaultchecked defaultmuted defaultselected defer disabled enabled formnovalidate hidden indeterminate inert ismap itemscope loop multiple muted nohref nomodule noresize noshade novalidate nowrap open pauseonexit playsinline readonly required reversed scoped seamless selected sortable truespeed typemustmatch visible).to_set
-
DATA_PREFIXES =
# File 'actionview/lib/action_view/helpers/tag_helper.rb', line 33["data", :data].to_set.freeze
-
PRE_CONTENT_STRINGS =
# File 'actionview/lib/action_view/helpers/tag_helper.rb', line 41Hash.new { "" }
-
TAG_TYPES =
# File 'actionview/lib/action_view/helpers/tag_helper.rb', line 35{}
Class Method Summary
- .build_tag_values(*args) mod_func
Instance Method Summary
-
#cdata_section(content)
Returns a CDATA section with the given
content
. -
#class_names(*args)
Alias for #token_list.
-
#content_tag(name, content_or_options_with_block = nil, options = nil, escape = true, &block)
Returns an HTML block tag of type
name
surrounding thecontent
. -
#escape_once(html)
Returns an escaped version of
html
without affecting existing escaped entities. -
#tag(name = nil, options = nil, open = false, escape = true)
Returns an HTML tag.
-
#token_list(*args)
(also: #class_names)
Returns a string of tokens built from
args
.
OutputSafetyHelper
- Included
#raw | This method outputs without escaping a string. |
#safe_join | This method returns an HTML safe string similar to what |
#to_sentence | Converts the array to a comma-separated sentence where the last element is joined by the connector word. |
CaptureHelper
- Included
#capture | The capture method extracts part of a template as a string object. |
#content_for | Calling |
#content_for? |
|
#provide | The same as |
Class Method Details
.build_tag_values(*args) (mod_func)
[ GitHub ]# File 'actionview/lib/action_view/helpers/tag_helper.rb', line 403
def build_tag_values(*args) tag_values = [] args.each do |tag_value| case tag_value when Hash tag_value.each do |key, val| tag_values << key.to_s if val && key.present? end when Array tag_values.concat build_tag_values(*tag_value) else tag_values << tag_value.to_s if tag_value.present? end end tag_values end
Instance Method Details
#cdata_section(content)
Returns a CDATA section with the given content
. CDATA sections are used to escape blocks of text containing characters which would otherwise be recognized as markup. CDATA sections begin with the string <![CDATA[
and end with (and may not contain) the string ]]>
.
cdata_section("<hello world>")
# => <![CDATA[<hello world>]]>
cdata_section(File.read("hello_world.txt"))
# => <![CDATA[<hello from a text file]]>
cdata_section("hello]]>world")
# => <![CDATA[hello]]]]><![CDATA[>world]]>
# File 'actionview/lib/action_view/helpers/tag_helper.rb', line 386
def cdata_section(content) splitted = content.to_s.gsub(/\]\]>/, "]]]]><![CDATA[>") "<![CDATA[#{splitted}]]>".html_safe end
#class_names(*args)
Alias for #token_list.
# File 'actionview/lib/action_view/helpers/tag_helper.rb', line 371
alias_method :class_names, :token_list
#content_tag(name, content_or_options_with_block = nil, options = nil, escape = true, &block)
Returns an HTML block tag of type name
surrounding the content
. Add HTML attributes by passing an attributes hash to options
. Instead of passing the content as an argument, you can also use a block in which case, you pass your options
as the second parameter. Set escape to false to disable escaping. Note: this is legacy syntax, see #tag method description for details.
Options
The options
hash can be used with attributes with no value like (disabled
and readonly
), which you can give a value of true in the options
hash. You can use symbols or strings for the attribute names.
Examples
content_tag(:p, "Hello world!")
# => <p>Hello world!</p>
content_tag(:div, content_tag(:p, "Hello world!"), class: "strong")
# => <div class="strong"><p>Hello world!</p></div>
content_tag(:div, "Hello world!", class: ["strong", "highlight"])
# => <div class="strong highlight">Hello world!</div>
content_tag(:div, "Hello world!", class: ["strong", { highlight: current_user.admin? }])
# => <div class="strong highlight">Hello world!</div>
content_tag("select", , multiple: true)
# => <select multiple="multiple">...options...</select>
<%= content_tag :div, class: "strong" do -%>
Hello world!
<% end -%>
# => <div class="strong">Hello world!</div>
# File 'actionview/lib/action_view/helpers/tag_helper.rb', line 346
def content_tag(name, = nil, = nil, escape = true, &block) if block_given? = if .is_a?(Hash) tag_builder.content_tag_string(name, capture(&block), , escape) else tag_builder.content_tag_string(name, , , escape) end end
#escape_once(html)
Returns an escaped version of html
without affecting existing escaped entities.
escape_once("1 < 2 & 3")
# => "1 < 2 & 3"
escape_once("<< Accept & Checkout")
# => "<< Accept & Checkout"
# File 'actionview/lib/action_view/helpers/tag_helper.rb', line 398
def escape_once(html) ERB::Util.html_escape_once(html) end
#tag(name = nil, options = nil, open = false, escape = true)
Returns an HTML tag.
Building HTML tags
Builds HTML5 compliant tags with a tag proxy. Every tag can be built with:
tag.<tag name>(optional content, )
where tag name can be e.g. br, div, section, article, or any tag really.
Passing content
Tags
can pass content to embed within it:
tag.h1 'All titles fit to print' # => <h1>All titles fit to print</h1>
tag.div tag.p('Hello world!') # => <div><p>Hello world!</p></div>
Content can also be captured with a block, which is useful in templates:
<%= tag.p do %>
The next great American novel starts here.
<% end %>
# => <p>The next great American novel starts here.</p>
Options
Use symbol keyed options to add attributes to the generated tag.
tag.section class: %w( kitties puppies )
# => <section class="kitties puppies"></section>
tag.section id: dom_id(@post)
# => <section id="<generated dom id>"></section>
Pass true
for any attributes that can render with no values, like disabled
and readonly
.
tag.input type: 'text', disabled: true
# => <input type="text" disabled="disabled">
HTML5 data-*
and aria-*
attributes can be set with a single data
or aria
key pointing to a hash of sub-attributes.
To play nicely with JavaScript conventions, sub-attributes are dasherized.
tag.article data: { user_id: 123 }
# => <article data-user-id="123"></article>
Thus data-user-id
can be accessed as dataset.userId
.
::Data
attribute values are encoded to JSON, with the exception of strings, symbols, and BigDecimals. This may come in handy when using jQuery’s HTML5-aware .data()
from 1.4.3.
tag.div data: { city_state: %w( Chicago IL ) }
# => <div data-city-state="["Chicago","IL"]"></div>
The generated tag names and attributes are escaped by default. This can be disabled using escape
.
tag.img src: 'open & shut.png'
# => <img src="open & shut.png">
tag.img src: 'open & shut.png', escape: false
# => <img src="open & shut.png">
The tag builder respects HTML5 void elements if no content is passed, and omits closing tags for those elements.
# A standard element:
tag.div # => <div></div>
# A void element:
tag.br # => <br>
Building HTML attributes
Transforms a ::Hash
into HTML attributes, ready to be interpolated into ::ERB
. Includes or omits boolean attributes based on their truthiness. Transforms keys nested within aria:
or data:
objects into aria-
and data-
prefixed attributes:
<input <%= tag.attributes(type: :text, aria: { label: "Search" }) %>>
# => <input type="text" aria-label="Search">
<button <%= tag.attributes id: "call-to-action", disabled: false, aria: { expanded: false } %> class="primary">Get Started!</button>
# => <button id="call-to-action" aria-expanded="false" class="primary">Get Started!</button>
Legacy syntax
The following format is for legacy syntax support. It will be deprecated in future versions of Rails.
tag(name, = 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" />
# File 'actionview/lib/action_view/helpers/tag_helper.rb', line 309
def tag(name = nil, = nil, open = false, escape = true) if name.nil? tag_builder else name = ERB::Util.xml_name_escape(name) if escape "<#{name}#{tag_builder. (, escape) if }#{open ? ">" : " />"}".html_safe end end
#token_list(*args) Also known as: #class_names
Returns a string of tokens built from args
.
Examples
token_list("foo", "bar")
# => "foo bar"
token_list("foo", "foo bar")
# => "foo bar"
token_list({ foo: true, bar: false })
# => "foo"
token_list(nil, false, 123, "", "foo", { bar: true })
# => "123 foo bar"
# File 'actionview/lib/action_view/helpers/tag_helper.rb', line 366
def token_list(*args) tokens = build_tag_values(*args).flat_map { |value| CGI.unescape_html(value.to_s).split(/\s+/) }.uniq safe_join(tokens, " ") end