Module: ActionView::Helpers::TagHelper
- Includes:
- ERB::Util
- Included in:
- DateHelper, InstanceTag
- Defined in:
- lib/action_view/helpers/tag_helper.rb
Overview
Provides methods to generate HTML tags programmatically when you can’t use a Builder. By default, they output XHTML compliant tags.
Constant Summary collapse
- BOOLEAN_ATTRIBUTES =
%w(disabled readonly multiple).to_set
Constants included from ERB::Util
ERB::Util::HTML_ESCAPE, ERB::Util::JSON_ESCAPE
Instance Method Summary collapse
-
#cdata_section(content) ⇒ Object
Returns a CDATA section with the given
content
. -
#content_tag(name, content_or_options_with_block = nil, options = nil, escape = true, &block) ⇒ Object
Returns an HTML block tag of type
name
surrounding thecontent
. -
#escape_once(html) ⇒ Object
Returns an escaped version of
html
without affecting existing escaped entities. -
#tag(name, options = nil, open = false, escape = true) ⇒ Object
Returns an empty HTML tag of type
name
which by default is XHTML compliant.
Methods included from ERB::Util
Instance Method Details
#cdata_section(content) ⇒ Object
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 ]]>
.
Examples
cdata_section("<hello world>")
# => <![CDATA[<hello world>]]>
cdata_section(File.read("hello_world.txt"))
# => <![CDATA[<hello from a text file]]>
91 92 93 |
# File 'lib/action_view/helpers/tag_helper.rb', line 91 def cdata_section(content) "<![CDATA[#{content}]]>" end |
#content_tag(name, content_or_options_with_block = nil, options = nil, escape = true, &block) ⇒ Object
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 attribute value escaping.
Options
The options
hash is 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("select", options, :multiple => true)
# => <select multiple="multiple">...options...</select>
<% content_tag :div, :class => "strong" do -%>
Hello world!
<% end -%>
# => <div class="strong"><p>Hello world!</p></div>
68 69 70 71 72 73 74 75 76 77 78 |
# File 'lib/action_view/helpers/tag_helper.rb', line 68 def content_tag(name, = nil, = nil, escape = true, &block) if block_given? = if .is_a?(Hash) content = capture(&block) content_tag = content_tag_string(name, content, , escape) block_is_within_action_view?(block) ? concat(content_tag, block.binding) : content_tag else content = content_tag_string(name, content, , escape) end end |
#escape_once(html) ⇒ Object
Returns an escaped version of html
without affecting existing escaped entities.
Examples
escape_once("1 > 2 & 3")
# => "1 < 2 & 3"
escape_once("<< Accept & Checkout")
# => "<< Accept & Checkout"
103 104 105 |
# File 'lib/action_view/helpers/tag_helper.rb', line 103 def escape_once(html) html.to_s.gsub(/[\"><]|&(?!([a-zA-Z]+|(#\d+));)/) { |special| ERB::Util::HTML_ESCAPE[special] } end |
#tag(name, options = nil, open = false, escape = true) ⇒ Object
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
The options
hash is 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
tag("br")
# => <br />
tag("br", nil, true)
# => <br>
tag("input", { :type => 'text', :disabled => true })
# => <input type="text" disabled="disabled" />
tag("img", { :src => "open & shut.png" })
# => <img src="open & shut.png" />
tag("img", { :src => "open & shut.png" }, false, false)
# => <img src="open & shut.png" />
41 42 43 |
# File 'lib/action_view/helpers/tag_helper.rb', line 41 def tag(name, = nil, open = false, escape = true) "<#{name}#{(, escape) if }#{open ? ">" : " />"}" end |