Class: Spree::BackendConfiguration::MenuItem

Inherits:
Object
  • Object
show all
Defined in:
app/models/spree/backend_configuration.rb

Overview

An item which should be drawn in the admin menu

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(sections, icon, condition: nil, label: nil, partial: nil, url: nil) ⇒ MenuItem

Returns a new instance of MenuItem.

Parameters:

  • sections (Array<Symbol>) —

    The sections which are contained within this admin menu section.

  • icon (String) —

    The icon to draw for this menu item

  • condition (Proc) (defaults to: nil) —

    A proc which returns true if this menu item should be drawn. If nil, it will be replaced with a proc which always returns true.

  • label (Symbol) (defaults to: nil) —

    The translation key for a label to use for this menu item.

  • partial (String) (defaults to: nil) —

    A partial to draw within this menu item for use in declaring a submenu

  • url (String) (defaults to: nil) —

    A url where this link should send the user to



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'app/models/spree/backend_configuration.rb', line 36

def initialize(
  sections,
  icon,
  condition: nil,
  label: nil,
  partial: nil,
  url: nil
)

  @condition = condition || -> { true }
  @sections = sections
  @icon = icon
  @label = label || sections.first
  @partial = partial
  @url = url
end

Instance Attribute Details

#condition ⇒ Object (readonly)

Returns the value of attribute condition.



23
24
25
 
# File 'app/models/spree/backend_configuration.rb', line 23

def condition
  @condition
end

#icon ⇒ Object (readonly)

Returns the value of attribute icon.



23
24
25
 
# File 'app/models/spree/backend_configuration.rb', line 23

def icon
  @icon
end

#label ⇒ Object (readonly)

Returns the value of attribute label.



23
24
25
 
# File 'app/models/spree/backend_configuration.rb', line 23

def label
  @label
end

#partial ⇒ Object (readonly)

Returns the value of attribute partial.



23
24
25
 
# File 'app/models/spree/backend_configuration.rb', line 23

def partial
  @partial
end

#sections ⇒ Object (readonly)

Returns the value of attribute sections.



23
24
25
 
# File 'app/models/spree/backend_configuration.rb', line 23

def sections
  @sections
end

#url ⇒ Object (readonly)

Returns the value of attribute url.



23
24
25
 
# File 'app/models/spree/backend_configuration.rb', line 23

def url
  @url
end