Included Modules

Class Index [+]

Quicksearch

ActionView::Helpers::TagHelper

Provides methods to generate HTML tags programmatically when you can’t use a Builder. By default, they output XHTML compliant tags.

Constants

BOOLEAN_ATTRIBUTES
PRE_CONTENT_STRINGS

Public Instance Methods

cdata_section(content) click to toggle source

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]]>
     # File lib/action_view/helpers/tag_helper.rb, line 112
112:       def cdata_section(content)
113:         "<![CDATA[#{content}]]>".html_safe
114:       end
content_tag(name, content_or_options_with_block = nil, options = nil, escape = true, &block) click to toggle source

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">Hello world!</div>
    # File lib/action_view/helpers/tag_helper.rb, line 92
92:       def content_tag(name, content_or_options_with_block = nil, options = nil, escape = true, &block)
93:         if block_given?
94:           options = content_or_options_with_block if content_or_options_with_block.is_a?(Hash)
95:           content_tag_string(name, capture(&block), options, escape)
96:         else
97:           content_tag_string(name, content_or_options_with_block, options, escape)
98:         end
99:       end
escape_once(html) click to toggle source

Returns an escaped version of html without affecting existing escaped entities.

Examples

  escape_once("1 < 2 &amp; 3")
  # => "1 &lt; 2 &amp; 3"

  escape_once("&lt;&lt; Accept & Checkout")
  # => "&lt;&lt; Accept &amp; Checkout"
     # File lib/action_view/helpers/tag_helper.rb, line 124
124:       def escape_once(html)
125:         ActiveSupport::Multibyte.clean(html.to_s).gsub(/[\"><]|&(?!([a-zA-Z]+|(#\d+));)/) { |special| ERB::Util::HTML_ESCAPE[special] }
126:       end
tag(name, options = nil, open = false, escape = true) click to toggle source

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.

To play nicely with JavaScript conventions sub-attributes are dasherized. For example, a key user_id would render as data-user-id and thus accessed as dataset.userId.

Values are encoded to JSON, with the exception of strings and symbols. This may come in handy when using jQuery’s HTML5-aware .data() from 1.4.3.

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 &amp; shut.png" />

  tag("img", {:src => "open &amp; shut.png"}, false, false)
  # => <img src="open &amp; shut.png" />

  tag("div", :data => {:name => 'Stephen', :city_state => %w(Chicago IL)})
  # => <div data-name="Stephen" data-city-state="[&quot;Chicago&quot;,&quot;IL&quot;]" />
    # File lib/action_view/helpers/tag_helper.rb, line 65
65:       def tag(name, options = nil, open = false, escape = true)
66:         "<#{name}#{tag_options(options, escape) if options}#{open ? ">" : " />"}".html_safe
67:       end

Private Instance Methods

content_tag_string(name, content, options, escape = true) click to toggle source
     # File lib/action_view/helpers/tag_helper.rb, line 130
130:         def content_tag_string(name, content, options, escape = true)
131:           tag_options = tag_options(options, escape) if options
132:           "<#{name}#{tag_options}>#{PRE_CONTENT_STRINGS[name.to_sym]}#{escape ? ERB::Util.h(content) : content}</#{name}>".html_safe
133:         end
tag_options(options, escape = true) click to toggle source
     # File lib/action_view/helpers/tag_helper.rb, line 135
135:         def tag_options(options, escape = true)
136:           unless options.blank?
137:             attrs = []
138:             options.each_pair do |key, value|
139:               if key.to_s == 'data' && value.is_a?(Hash)
140:                 value.each do |k, v|
141:                   unless v.is_a?(String) || v.is_a?(Symbol) || v.is_a?(BigDecimal)
142:                     v = v.to_json
143:                   end
144:                   v = ERB::Util.html_escape(v) if escape
145:                   attrs << %(data-#{k.to_s.dasherize}="#{v}")
146:                 end
147:               elsif BOOLEAN_ATTRIBUTES.include?(key)
148:                 attrs << %(#{key}="#{key}") if value
149:               elsif !value.nil?
150:                 final_value = value.is_a?(Array) ? value.join(" ") : value
151:                 final_value = ERB::Util.html_escape(final_value) if escape
152:                 attrs << %(#{key}="#{final_value}")
153:               end
154:             end
155:             " #{attrs.sort * ' '}".html_safe unless attrs.empty?
156:           end
157:         end

Disabled; run with --debug to generate this.

[Validate]

Generated with the Darkfish Rdoc Generator 1.1.6.