@@ -25,6 +25,15 @@ To generate your NavigationHelper, run: The generated helper is documented with the method stubs for the above 3 parts +Namespaces +========== +Every nav helper method takes a "namespace" parameter as its last or only parameter. +The namespace parameter can be used to differentiate between different sets of +navigation links. (i.e. main nav, and sub nav) +If you only have 1 set of nav links, ignore the namespace parameter. +If you have multiple sets of links, you can pass the namespace to +the "nav_links" method to get the appropriate links for that namespace. +Namespaces should be symbols or strings, just be consistent. Example ======= README @@ -1,6 +1,18 @@ module <%= helper_name.camelcase %> include SimpleNavHelper + + # NAMESPACES + # ========== + # Every nav helper method takes a "namespace" parameter as its last or only parameter. + # The namespace parameter can be used to differentiate between different sets of + # navigation links. (i.e. main nav, and sub nav) + # If you only have 1 set of nav links, ignore the namespace parameter. + # If you have multiple sets of links, you can pass the namespace to + # the "nav_links" method to get the appropriate links for that namespace. + # Namespaces should be symbols or strings, just be consistent. + + # the nav_list method defines the navigation links as a hash with its options # order does not matter, and note that they will only appear once listed # in the nav_order method @@ -12,7 +24,7 @@ module <%= helper_name.camelcase %> # :signup => {:text => "Sign Up", :href => signup_path}, # :settings => {:text => "Settings", :href => settings_path} # } - def nav_list + def nav_list(namespace) {} end @@ -26,7 +38,7 @@ module <%= helper_name.camelcase %> # else # [:home, :signup, :login] # end - def nav_order + def nav_order(namespace) [] end @@ -57,7 +69,7 @@ module <%= helper_name.camelcase %> # use those two variables in this method # Note: Use the nav_selection_advanced method below for advanced logic that can't # be boiled down to the simple logic here - def nav_selection_hash + def nav_selection_hash(namespace) {:else => :false} end @@ -67,7 +79,7 @@ module <%= helper_name.camelcase %> # it can do anything you want, if it returns a value, it should be the key # of the nav link you want selected. if it returns nil or false, it will try # to determine the selected tab from the nav_selection_hash above - def nav_selection_advanced + def nav_selection_advanced(namespace) nil end end \ No newline at end of file generators/nav_helper/templates/helper.rb @@ -1,30 +1,30 @@ module SimpleNavHelper - def nav_list + def nav_list(namespace) {} end - def nav_order + def nav_order(namespace) [] end - def nav_selection_hash + def nav_selection_hash(namespace) {:else => :false} end - def nav_selection_advanced + def nav_selection_advanced(namespace) nil end - def nav_links - list = nav_list.merge(:false => {}) - + def nav_links(namespace = nil) controller = params[:controller].intern - action = params[:action].intern + action = params[:action].intern - selected = (method(:nav_selection_advanced).arity == 2 ? nav_selection_advanced(controller, action) : nav_selection_advanced) + list = nav_list(namespace).merge(:false => {}) + + selected = method(:nav_selection_advanced).arity == 3 ? nav_selection_advanced(controller, action, namespace) : nav_selection_advanced(namespace) unless selected - selection_hash = method(:nav_selection_hash).arity == 2 ? nav_selection_hash(controller, action) : nav_selection_hash + selection_hash = method(:nav_selection_hash).arity == 3 ? nav_selection_hash(controller, action, namespace) : nav_selection_hash(namespace) ckey = selection_hash.keys.detect {|cs| cs.is_a?(Array) ? cs.include?(controller) : cs == controller } || :else if selection_hash[ckey].is_a?(Hash) @@ -38,7 +38,7 @@ module SimpleNavHelper (list[selected || :false][:class] ||= [] ) << "selected" content_tag :ul, :id => "simple_nav" do - nav_order.collect do |key| + nav_order(namespace).collect do |key| css_class = (list[key][:class] || []).join(" ") css_class = nil if css_class.empty? content_tag(:li, link_to(list[key][:text], list[key][:href]), :class => css_class) lib/simple_nav_helper.rb 17c43d0520882f0fe44a627e8a4c9772bad3376e Arya Asemanfar arya.asemanfar@gmail.com http://github.com/arya/simple_nav/commit/873c1227dfee38dc05835d3a00346f36aef3a1f2 873c1227dfee38dc05835d3a00346f36aef3a1f2 2008-05-27T21:35:16-07:00 2008-05-27T21:35:16-07:00 * added support for namespaces 6e89e7e730d3aaf0048692ce94e22d3085ffe27a Arya Asemanfar arya.asemanfar@gmail.com