Module: Nestive::LayoutHelper
- Defined in:
- lib/nestive/layout_helper.rb
Overview
The Nestive LayoutHelper provides a handful of helper methods for use in your layouts and views.
See the documentation for each individual method for detailed information, but at a high level, your parent layouts define ‘area`s of content. You can define an area and optionally add content to it at the same time using either a String, or a block:
# app/views/layouts/global.html.erb
<html>
<head>
<title><%= area :title, "MySite.com" %></title>
</head>
<body>
<div id="content">
<%= area :content %>
</div>
<div id="sidebar">
<%= area :sidebar do %>
<h2>About MySite.com</h2>
<p>...</p>
<% end %>
</div>
</body>
</html>
Your child layouts (or views) inherit and modify the parent by wrapping in an ‘extends` block helper. You can then either `append`, `prepend` or `replace` the content that has previously been assigned to each area by parent layouts.
The ‘append`, `prepend` or `replace` helpers are similar to Rails’ own ‘content_for`, which accepts content for the named area with either a String or with a block). They’re different to ‘content_for` because they’re only used modify the content assigned to the area, not retrieve it:
# app/views/layouts/admin.html.erb
<%= extends :global do %>
<% prepend :title, "Admin :: " %>
<% replace :sidebar do %>
<h2>Quick Links</h2>
<ul>
<li>...</li>
</ul>
<% end %>
<% end %>
# app/views/admin/posts/index.html.erb
<%= extends :admin do %>
<% prepend :title, "Posts ::" %>
<% replace :content do %>
Normal view stuff goes here.
<% end %>
<% end %>
Instance Method Summary collapse
-
#append(name, content = nil, &block) ⇒ Object
Appends content to an area previously defined or modified in parent layout(s).
-
#area(name, content = nil, &block) ⇒ Object
Defines an area of content in your layout that can be modified or replaced by child layouts that extend it.
-
#extends(layout, &block) ⇒ Object
Declares that the current layour (or view) is inheriting from and extending another layout.
-
#prepend(name, content = nil, &block) ⇒ Object
Prepends content to an area previously declared or modified in parent layout(s).
-
#purge(*names) ⇒ Object
Purge the content of an area previously declared or modified in parent layout(s).
-
#replace(name, content = nil, &block) ⇒ Object
Replaces the content of an area previously declared or modified in parent layout(s).
Instance Method Details
#append(name, content = nil, &block) ⇒ Object
Appends content to an area previously defined or modified in parent layout(s). You can provide the content using either a String, or a block.
149 150 151 152 |
# File 'lib/nestive/layout_helper.rb', line 149 def append(name, content=nil, &block) content = capture(&block) if block_given? add_instruction_to_area name, :push, content end |
#area(name, content = nil, &block) ⇒ Object
Defines an area of content in your layout that can be modified or replaced by child layouts that extend it. You can optionally add content to an area using either a String, or a block.
Areas are declared in a parent layout and modified by a child layout, but since Nestive allows for multiple levels of inheritance, a child layout can also declare an area for it’s children to modify.
127 128 129 130 131 |
# File 'lib/nestive/layout_helper.rb', line 127 def area(name, content=nil, &block) content = capture(&block) if block_given? append name, content render_area name end |
#extends(layout, &block) ⇒ Object
Declares that the current layour (or view) is inheriting from and extending another layout.
84 85 86 87 88 89 90 91 92 93 94 95 |
# File 'lib/nestive/layout_helper.rb', line 84 def extends(layout, &block) # Make sure it's a string layout = layout.to_s # If there's no directory component, presume a plain layout name layout = "layouts/#{layout}" unless layout.include?('/') # Capture the content to be placed inside the extended layout @view_flow.get(:layout).replace capture(&block) render file: layout end |
#prepend(name, content = nil, &block) ⇒ Object
Prepends content to an area previously declared or modified in parent layout(s). You can provide the content using either a String, or a block.
170 171 172 173 |
# File 'lib/nestive/layout_helper.rb', line 170 def prepend(name, content=nil, &block) content = capture(&block) if block_given? add_instruction_to_area name, :unshift, content end |
#purge(*names) ⇒ Object
Purge the content of an area previously declared or modified in parent layout(s).
203 204 205 |
# File 'lib/nestive/layout_helper.rb', line 203 def purge(*names) names.each{ |name| replace(name, nil)} end |
#replace(name, content = nil, &block) ⇒ Object
Replaces the content of an area previously declared or modified in parent layout(s). You can provide the content using either a String, or a block.
191 192 193 194 |
# File 'lib/nestive/layout_helper.rb', line 191 def replace(name, content=nil, &block) content = capture(&block) if block_given? add_instruction_to_area name, :replace, [content] end |