Module | ActionView::Helpers::TagHelper |
In: |
vendor/rails/actionpack/lib/action_view/helpers/tag_helper.rb
|
Provides methods to generate HTML tags programmatically when you can‘t use a Builder. By default, they output XHTML compliant tags.
BOOLEAN_ATTRIBUTES | = | Set.new(%w(disabled readonly multiple)) |
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]]>
# File vendor/rails/actionpack/lib/action_view/helpers/tag_helper.rb, line 89 89: def cdata_section(content) 90: "<![CDATA[#{content}]]>" 91: end
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.
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.
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>
# File vendor/rails/actionpack/lib/action_view/helpers/tag_helper.rb, line 66 66: def content_tag(name, content_or_options_with_block = nil, options = nil, escape = true, &block) 67: if block_given? 68: options = content_or_options_with_block if content_or_options_with_block.is_a?(Hash) 69: content = capture(&block) 70: content_tag = content_tag_string(name, content, options, escape) 71: block_is_within_action_view?(block) ? concat(content_tag, block.binding) : content_tag 72: else 73: content = content_or_options_with_block 74: content_tag_string(name, content, options, escape) 75: end 76: end
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 vendor/rails/actionpack/lib/action_view/helpers/tag_helper.rb, line 101 101: def escape_once(html) 102: ActiveSupport::Multibyte.clean(html.to_s).gsub(/[\"><]|&(?!([a-zA-Z]+|(#\d+));)/) { |special| ERB::Util::HTML_ESCAPE[special] } 103: end
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.
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.
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" />
# File vendor/rails/actionpack/lib/action_view/helpers/tag_helper.rb, line 39 39: def tag(name, options = nil, open = false, escape = true) 40: "<#{name}#{tag_options(options, escape) if options}" + (open ? ">" : " />") 41: end