instance method `layout`

Ruby on Rails 5.2.8.1

Since v4.1.16

Available in: 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:

layout(layout, conditions = {})

Specify the layout to use for this class.

If the specified layout is a:

String: the String is the template name
Symbol: call the method specified by the symbol
Proc: call the passed Proc
false: There is no layout
true: raise an ArgumentError
nil: Force default layout behavior with inheritance

Return value of Proc and Symbol arguments should be String, false, true or nil with the same meaning as described above.

Parameters

layout - The layout to use.

Options (conditions)

:only - A list of actions to apply this layout to.
:except - Apply this layout to all actions but this one.

Parameters

layout req
conditions opt = {}

Source

# File actionview/lib/action_view/layouts.rb, line 267
      def layout(layout, conditions = {})
        include LayoutConditions unless conditions.empty?

        conditions.each { |k, v| conditions[k] = Array(v).map(&:to_s) }
        self._layout_conditions = conditions

        self._layout = layout
        _write_layout_method
      end

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

Defined in ActionView::Layouts::ClassMethods

Signature

Parameters

Options (conditions)

Parameters