123456789_123456789_123456789_123456789_123456789_

Module: ActionView::Helpers::RecordTagHelper

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Included In:
Super Chains via Extension / Inclusion / Inheritance
Instance Chain:
Defined in: actionview/lib/action_view/helpers/record_tag_helper.rb

Constant Summary

::ActionView::RecordIdentifier - Included

JOIN, NEW

Instance Method Summary

::ActionView::RecordIdentifier - Included

#dom_class

The DOM class convention is to use the singular form of an object or class.

#dom_id

The DOM id convention is to use the singular form of an object or class with the id following an underscore.

::ActionView::ModelNaming - Included

#convert_to_model

Converts the given object to an ::ActiveModel compliant one.

#model_name_from_record_or_class

Instance Method Details

#content_tag_for(tag_name, single_or_multiple_records, prefix = nil, options = nil, &block)

content_tag_for creates an HTML element with id and class parameters that relate to the specified Active Record object. For example:

<%= content_tag_for(:tr, @person) do %>
  <td><%= @person.first_name %></td>
  <td><%= @person.last_name %></td>
<% end %>

would produce the following HTML (assuming @person is an instance of a Person object, with an id value of 123):

<tr id="person_123" class="person">....</tr>

If you require the HTML id attribute to have a prefix, you can specify it:

<%= content_tag_for(:tr, @person, :foo) do %> ...

produces:

<tr id="foo_person_123" class="person">...

You can also pass an array of objects which this method will loop through and yield the current object to the supplied block, reducing the need for having to iterate through the object (using each) beforehand. For example (assuming @people is an array of Person objects):

<%= content_tag_for(:tr, @people) do |person| %>
  <td><%= person.first_name %></td>
  <td><%= person.last_name %></td>
<% end %>

produces:

<tr id="person_123" class="person">...</tr>
<tr id="person_124" class="person">...</tr>

content_tag_for also accepts a hash of options, which will be converted to additional HTML attributes. If you specify a :class value, it will be combined with the default class name for your object. For example:

<%= content_tag_for(:li, @person, class: "bar") %>...

produces:

<li id="person_123" class="person bar">...
[ GitHub ]

  
# File 'actionview/lib/action_view/helpers/record_tag_helper.rb', line 83

def (tag_name, single_or_multiple_records, prefix = nil, options = nil, &block)
  options, prefix = prefix, nil if prefix.is_a?(Hash)

  Array(single_or_multiple_records).map do |single_record|
    (tag_name, single_record, prefix, options, &block)
  end.join("\n").html_safe
end

#div_for(record, *args, &block)

Produces a wrapper DIV element with id and class parameters that relate to the specified Active Record object. Usage example:

<%= div_for(@person, class: "foo") do %>
   <%= @person.name %>
<% end %>

produces:

<div id="person_123" class="person foo"> Joe Bloggs </div>

You can also pass an array of Active Record objects, which will then get iterated over and yield each record as an argument for the block. For example:

<%= div_for(@people, class: "foo") do |person| %>
  <%= person.name %>
<% end %>

produces:

<div id="person_123" class="person foo"> Joe Bloggs </div>
<div id="person_124" class="person foo"> Jane Bloggs </div>
[ GitHub ]

  
# File 'actionview/lib/action_view/helpers/record_tag_helper.rb', line 33

def div_for(record, *args, &block)
  (:div, record, *args, &block)
end