модуль ActionView::Helpers::TagHelper
Action View Теги Помощники
Предоставляет методы для генерации HTML-тегов программно как в современном стиле построения, совместимом с HTML5, так и в устаревшем стиле XHTML.
Константы
- ARIA_PREFIXES
- ЛОГИЧЕСКИЕ_АТРИБУТЫ
- DATA_PREFIXES
- PRE_CONTENT_STRINGS
- ТИПЫ_ТЕГОВ
Публичные методы класса
# 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 Публичные методы экземпляра
# 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 Возвращает раздел CDATA с заданным content. Разделы CDATA используются для экранирования блоков текста, содержащих символы, которые в противном случае распознавались бы как разметка. Разделы CDATA начинаются со строки <![CDATA[ и заканчиваются (и не могут содержать) строкой ]]>.
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 346
def content_tag(name, content_or_options_with_block = nil, options = nil, escape = true, &block)
if block_given?
options = content_or_options_with_block if content_or_options_with_block.is_a?(Hash)
tag_builder.content_tag_string(name, capture(&block), options, escape)
else
tag_builder.content_tag_string(name, content_or_options_with_block, options, escape)
end
end Возвращает HTML-тег блока типа name , окружающий content. Добавить HTML-атрибуты, передав хеш атрибутов в options. Вместо передачи содержимого в качестве аргумента, вы также можете использовать блок, в этом случае вы передаете свой options в качестве второго параметра. Установите escape в false, чтобы отключить экранирование. Примечание: это устаревший синтаксис, см. описание метода tag для получения подробностей.
Параметры
Хеш options может использоваться с атрибутами без значения, такими как (disabled и readonly), которые вы можете присвоить значение true в хеше options. Вы можете использовать символы или строки в качестве имен атрибутов.
Примеры
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", options, 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 398 def escape_once(html) ERB::Util.html_escape_once(html) end
Возвращает экранированную версию html без влияния на существующие экранированные сущности.
escape_once("1 < 2 & 3")
# => "1 < 2 & 3"
escape_once("<< Accept & Checkout")
# => "<< Accept & Checkout"
# File actionview/lib/action_view/helpers/tag_helper.rb, line 309
def tag(name = nil, options = nil, open = false, escape = true)
if name.nil?
tag_builder
else
name = ERB::Util.xml_name_escape(name) if escape
"<#{name}#{tag_builder.tag_options(options, escape) if options}#{open ? ">" : " />"}".html_safe
end
end Возвращает HTML-тег.
Создание HTML-тегов
Создает совместимые с HTML5 теги с помощью прокси-тега. Каждый тег можно создать с помощью:
tag.<tag name>(optional content, options)
где имя тега может быть, например, br, div, section, article или любой другой тег.
Передача содержимого
Tags можно передать содержимое для вставки в него:
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>
Содержимое также можно захватить с помощью блока, что полезно в шаблонах:
<%= tag.p do %> The next great American novel starts here. <% end %> # => <p>The next great American novel starts here.</p>
Параметры
Используйте параметры с символическими ключами для добавления атрибутов в сгенерированный тег.
tag.section class: %w( kitties puppies ) # => <section class="kitties puppies"></section> tag.section id: dom_id(@post) # => <section id="<generated dom id>"></section>
Передайте true для любых атрибутов, которые могут отображаться без значений, таких как disabled и readonly.
tag.input type: 'text', disabled: true # => <input type="text" disabled="disabled">
Атрибуты HTML5 data-* и aria-* могут быть установлены с помощью одного data или aria ключа, указывающего на хеш под-атрибутов.
Для работы с соглашениями JavaScript под-атрибуты дефисируются.
tag.article data: { user_id: 123 }
# => <article data-user-id="123"></article>
Таким образом, data-user-id можно получить как dataset.userId.
Значения атрибутов данных кодируются в JSON, за исключением строк, символов и BigDecimals. Это может быть полезно при использовании jQuery's HTML5-совместимого .data() от 1.4.3.
tag.div data: { city_state: %w( Chicago IL ) }
# => <div data-city-state="["Chicago","IL"]"></div>
Сгенерированные имена тегов и атрибуты экранируются по умолчанию. Это можно отключить, используя 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">
Генератор тегов учитывает HTML5 пустые элементы, если содержимое не передается, и опускает закрывающие теги для этих элементов.
# A standard element: tag.div # => <div></div> # A void element: tag.br # => <br>
Создание HTML атрибутов
Преобразует Hash в HTML-атрибуты, готовые для интерполяции в ERB. Включает или исключает логические атрибуты в зависимости от их истинности. Преобразует ключи, вложенные в aria: или data: объекты в aria- и data- префиксные атрибуты:
<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> Устаревший синтаксис
Следующий формат предназначен для поддержки устаревшего синтаксиса. Он будет устаревать в будущих версиях Rails.
tag(name, options = nil, open = false, escape = true)
Возвращает пустой HTML-тег типа name , который по умолчанию соответствует XHTML. Установите open в true, чтобы создать открывающий тег, совместимый с HTML 4.0 и ниже. Добавьте HTML-атрибуты, передав хеш атрибутов в options. Установите escape в false, чтобы отключить экранирование значений атрибутов.
Параметры
Вы можете использовать символы или строки в качестве имен атрибутов.
Используйте true с логическими атрибутами, которые могут отображаться без значения, такими как disabled и readonly.
Атрибуты HTML5 data-* могут быть установлены с помощью одного data ключа, указывающего на хеш под-атрибутов.
Примеры
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 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 Возвращает строку токенов, созданных из args.
Примеры
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"
© 2004–2021 David Heinemeier Hansson
Licensed under the MIT License.