Represents an item in your navigation. Gets generated by the item method in the config-file.
see SimpleNavigation::ItemContainer#item
The subnavigation (if any) is either provided by a block or passed in
directly as items
# File lib/simple_navigation/core/item.rb, line 11 def initialize(container, key, name, url, options, items=nil, &sub_nav_block) @container = container @container.dom_class = options.delete(:container_class) if options[:container_class] @container.dom_id = options.delete(:container_id) if options[:container_id] @key = key @method = options.delete(:method) @name = name @url = url.instance_of?(Proc) ? url.call : url @highlights_on = options.delete(:highlights_on) @html_options = options if sub_nav_block || items @sub_navigation = ItemContainer.new(@container.level + 1) sub_nav_block.call @sub_navigation if sub_nav_block @sub_navigation.items = items if items end end
Returns the configured #active_leaf_class if the item is the selected leaf, nil otherwise
# File lib/simple_navigation/core/item.rb, line 63 def active_leaf_class selected_by_condition? ? SimpleNavigation.config.active_leaf_class : nil end
Returns the html-options hash for the item, i.e. the options specified for this item in the config-file. It also adds the 'selected' class to the list of classes if necessary.
# File lib/simple_navigation/core/item.rb, line 53 def html_options default_options = self.autogenerate_item_ids? ? {:id => autogenerated_item_id} : {} options = default_options.merge(@html_options) options[:class] = [@html_options[:class], self.selected_class, self.active_leaf_class].flatten.compact.join(' ') options.delete(:class) if options[:class].nil? || options[:class] == '' options end
Returns the item's name. If option :apply_generator is set to true (default), the name will be passed to the name_generator specified in the configuration.
# File lib/simple_navigation/core/item.rb, line 31 def name(options = {}) options.reverse_merge!(:apply_generator => true) if (options[:apply_generator]) SimpleNavigation.config.name_generator.call(@name) else @name end end
Returns true if this navigation item should be rendered as 'selected'. An item is selected if
it has been explicitly selected in a controller or
it has a subnavigation and one of its subnavigation items is selected or
its url matches the url of the current request (auto highlighting)
# File lib/simple_navigation/core/item.rb, line 47 def selected? @selected = @selected || selected_by_config? || selected_by_subnav? || selected_by_condition? end
# File lib/simple_navigation/rails_controller_methods.rb, line 128 def selected_by_config? key == SimpleNavigation.current_navigation_for(@container.level) end
Returns the configured #selected_class if the item is selected, nil otherwise
# File lib/simple_navigation/core/item.rb, line 69 def selected_class selected? ? SimpleNavigation.config.selected_class : nil end
Return true if auto_highlight is on for this item.
# File lib/simple_navigation/core/item.rb, line 120 def auto_highlight? SimpleNavigation.config.auto_highlight && @container.auto_highlight end
Returns true if the item's id should be added to the rendered output.
# File lib/simple_navigation/core/item.rb, line 110 def autogenerate_item_ids? SimpleNavigation.config.autogenerate_item_ids end
Returns the item's id which is added to the rendered output.
# File lib/simple_navigation/core/item.rb, line 115 def autogenerated_item_id SimpleNavigation.config.id_generator.call(key) end
Returns true if both the item's url and the request's url are root_path
# File lib/simple_navigation/core/item.rb, line 105 def root_path_match? url == '/' && SimpleNavigation.request_path == '/' end
Returns true if the item's url matches the request's current url.
# File lib/simple_navigation/core/item.rb, line 85 def selected_by_condition? if highlights_on case highlights_on when Regexp SimpleNavigation.request_uri =~ highlights_on when Proc highlights_on.call when :subpath !!(SimpleNavigation.request_uri =~ %r^#{Regexp.escape url_without_anchor}/) else raise ArgumentError, ':highlights_on must be a Regexp, Proc or :subpath' end elsif auto_highlight? !!(root_path_match? || SimpleNavigation.current_page?(url_without_anchor)) else false end end
# File lib/simple_navigation/core/item.rb, line 124 def url_without_anchor url.split('#').first end