Spec-Zone.ru › Ruby on Rails 5.1

модуль ActionView::Helpers::TagHelper

Включенные модули:
ActionView::Helpers::CaptureHelper, ActionView::Helpers::OutputSafetyHelper

Предоставляет методы для генерации HTML-тегов программно в стиле современного HTML5 и устаревшего XHTML.

Константы

BOOLEAN_ATTRIBUTES
PRE_CONTENT_STRINGS
TAG_PREFIXES

Публичные методы экземпляров

cdata_section(content) Показать исходный код
# File actionview/lib/action_view/helpers/tag_helper.rb, line 290
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]]>
content_tag(name, content_or_options_with_block = nil, options = nil, escape = true, &block) Показать исходный код
# File actionview/lib/action_view/helpers/tag_helper.rb, line 268
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("select", options, multiple: true)
 # => <select multiple="multiple">...options...</select>

<%= content_tag :div, class: "strong" do -%>
  Hello world!
<% end -%>
 # => <div class="strong">Hello world!</div>
escape_once(html) Показать исходный код
# File actionview/lib/action_view/helpers/tag_helper.rb, line 302
def escape_once(html)
  ERB::Util.html_escape_once(html)
end

Возвращает экранированную версию html без изменения существующих экранированных сущностей.

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

escape_once("&lt;&lt; Accept & Checkout")
# => "&lt;&lt; Accept &amp; Checkout"
tag(name = nil, options = nil, open = false, escape = true) Показать исходный код
# File actionview/lib/action_view/helpers/tag_helper.rb, line 234
def tag(name = nil, options = nil, open = false, escape = true)
  if name.nil?
    tag_builder
  else
    "<#{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 или любой другой тег.

Передача содержимого

Теги могут передавать содержимое для встраивания в него:

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-* могут быть установлены с помощью единственного ключа data, указывающего на хеш под-атрибутов.

Для соответствия соглашениям JavaScript, под-атрибуты форматируются с дефисами.

tag.article data: { user_id: 123 }
# => <article data-user-id="123"></article>

Таким образом, data-user-id можно получить как dataset.userId.

Значения атрибутов данных кодируются в JSON, за исключением строк, символов и BigDecimals. Это может быть полезно при использовании HTML5-ориентированного .data() jQuery с версии 1.4.3.

tag.div data: { city_state: %w( Chigaco IL ) }
# => <div data-city-state="[&quot;Chicago&quot;,&quot;IL&quot;]"></div>

Сгенерированные атрибуты экранируются по умолчанию. Это можно отключить, используя escape_attributes.

tag.img src: 'open & shut.png'
# => <img src="open &amp; shut.png">

tag.img src: 'open & shut.png', escape_attributes: false
# => <img src="open & shut.png">

Генератор тегов учитывает HTML5 пустые теги, если содержимое не передано, и опускает закрывающие теги для этих тегов.

# A standard element:
tag.div # => <div></div>

# A void element:
tag.br  # => <br>

Устаревшая синтаксическая конструкция

Следующий формат предназначен для поддержки устаревшей синтаксической конструкции. Он будет устаревшим в будущих версиях 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 &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;]" />

© 2004–2018 David Heinemeier Hansson
Licensed under the MIT License.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API