instance method `dom_id`

Ruby on Rails 8.1.2

Since v4.0.13

Available in: v4.0.13 v4.1.16 v4.2.9 v5.2.8.1 v6.0.6 v6.1.7.10 v7.0.10 v7.1.6 v7.2.3 v8.0.4 v8.1.2

Compare with:

dom_id(record_or_class, prefix = nil)

The DOM id convention is to use the singular form of an object or class with the id following an underscore. If no id is found, prefix with “new_” instead.

dom_id(Post.find(45)) # => "post_45"
dom_id(Post)          # => "new_post"

If you need to address multiple instances of the same class in the same view, you can prefix the dom_id:

dom_id(Post.find(45), :edit) # => "edit_post_45"
dom_id(Post, :custom)        # => "custom_post"

Parameters

record_or_class req
prefix opt = nil

Source

# File actionview/lib/action_view/record_identifier.rb, line 93
    def dom_id(record_or_class, prefix = nil)
      raise ArgumentError, "dom_id must be passed a record_or_class as the first argument, you passed #{record_or_class.inspect}" unless record_or_class

      record_id = record_key_for_dom_id(record_or_class) unless record_or_class.is_a?(Class)
      if record_id
        "#{dom_class(record_or_class, prefix)}#{JOIN}#{record_id}"
      else
        dom_class(record_or_class, prefix || NEW)
      end
    end

Defined in actionview/lib/action_view/record_identifier.rb line 93 · View on GitHub · Improve this page · Find usages on GitHub

Defined in ActionView::RecordIdentifier

Signature

Parameters