Class: BreadcrumbsOnRails::Breadcrumbs::Builder

Inherits:

Object

• Object
• BreadcrumbsOnRails::Breadcrumbs::Builder

Defined in:

lib/breadcrumbs_on_rails/breadcrumbs.rb

Overview

The Builder class represents the abstract class for any custom Builder.

To create a custom Builder, just extend this class and implement the following abstract methods:

• #render: Renders and returns the collection of navigation elements

Direct Known Subclasses

SimpleBuilder

Instance Method Summary

• #initialize(context, elements, options = {}) ⇒ Builder constructor

  Initializes a new Builder with context, element and options.

• #render ⇒ String abstract

  Renders Elements and returns the Breadcrumb navigation for the view.

Constructor Details

#initialize(context, elements, options = {}) ⇒ Builder

Initializes a new Builder with context, element and options.

Parameters:

• context (ActionView::Base) —

  The view context.

• elements (Array<Element>) —

  The collection of Elements.

• options (Hash) (defaults to: {}) —

  Hash of options to customize the rendering behavior.

# File 'lib/breadcrumbs_on_rails/breadcrumbs.rb', line 29

def initialize(context, elements, options = {})
  @context  = context
  @elements = elements
  @options  = options
end

Instance Method Details

#render ⇒ String

This method is abstract.

You must implement this method in your custom Builder.

Renders Elements and returns the Breadcrumb navigation for the view.

Returns:

• (String) —

  The result of the breadcrumb rendering.

Raises:

• (NotImplementedError)

# File 'lib/breadcrumbs_on_rails/breadcrumbs.rb', line 40

def render
  raise NotImplementedError
end