listy 0.0.6 → 0.0.7

data/README.md

@@ -39,7 +39,7 @@ Listy also includes some Javascript assets, so be sure to add the following line
 
 If you don't plan on using any of the Hiding/Collapsing of the lists - you don't have to include this.
 
-## Usage
+## Rails Helpers Usage
 
 There are a couple of helper methods including:
 
@@ -53,7 +53,7 @@ This method creates a simple unordered list of links of the elements in the coll
 
 Options you can pass in include
 
-* display_method - Symbol of method to be called on each record to generate what is displayed in the list. If you set is not specified, to_s will be called on the element to generate the display string.
+* :display_method - Symbol of method to be called on each record to generate what is displayed in the list. If you set is not specified, to_s will be called on the element to generate the display string.
 * :css_class - The class that is applied to the resulting ul list element
 * :empty_message - The message that is displayed if the collection is empty
 * :show_more - If set to true, the list will display only the first 10 elements, and hide the rest and create a "Show More" link. Show more functionality requires JQuery and list.js - please read above.
@@ -70,6 +70,8 @@ Options you can pass in include
 	
 	<%= listy_links Product.all, :display_method => :part_number, :show_more => true, :show_more_limit => 100, :css_class => "products-list" %>
 ```
+
+
 ### multi_column_listy_links
 
 	multi_column_listy_links(collection, number_of_columns, options={})
@@ -81,7 +83,7 @@ This does the same thing as listy_links but presents it in the number of columns
 
 Options you can pass in include:
 
-* display_method - Symbol of method to be called on each record to generate what is displayed in the list. If you set is not specified, to_s will be called on the element to generate the display string.
+* :display_method - Symbol of method to be called on each record to generate what is displayed in the list. If you set is not specified, to_s will be called on the element to generate the display string.
 * :css_class - The class that is applied to the resulting ul list elements in each column
 * :empty_message - The message that is displayed if the collection is empty
 
@@ -95,6 +97,7 @@ Options you can pass in include:
 	<%= multi_column_listy_links Product.all, 4, :display_method => :part_number, :css_class => "products-list", :empty_message => "There are no products" %>
 ```
 
+
 ### listy_tree
 
 	listy_tree(collection, spec, options={})
@@ -102,14 +105,32 @@ Options you can pass in include:
 This method is for creating a nested tree of unordered lists for a collection with nested collections. 
 This is suitable for Rails models that have has_many relationships. The lists will be collapsable if you click on the parent elements (requires JQuery and listy.js, please read above).
 
-The spec is basically instructions on how to create the nested tree. It is a nested hash where each child specifies how to create the nested list
+The spec is basically instructions on how to create the nested tree. It is a nested hash where each child specifies how to create the nested list.
+
+* collection - Collection, usually nested, of elements, usually ActiveRecord's with has_many relationships
+* spec - explained below
+
+Options you can pass in include:
+
+* :css_class - The class that is applied to the resulting div tag that surrounds the nested lists
+* :empty_message - The message that is displayed if the collection is empty
+
+#### CSS Classes
+
+Each nested ul element ends up being assigned a class. The upper most ul has a css class of `listy-tree-level-0` and the next one has a css class of `listy-tree-level-1` and so on.
+
+Also, with the collapsing and expanding of the list, the following classes also are applied and taken away to the headers of the lists `listy-list-header-expanded` and `listy-list-header-collapsed`. This way you can style what the header looks like when you expand or collapse the list.
+
+Lastly, the leafs of a listy-tree have the css class `listy-tree-leaf`.
+
+Basically this are all used for custom styling.
 
 
 #### Spec Explanation
 
 The spec is a nested hash that contains the following elements:
 
-* display_method - Symbol of method to be called on each record to generate what is displayed in the list. If you set is not specified, to_s will be called on the element to generate the display string.
+* :display_method - Symbol of method to be called on each record to generate what is displayed in the list. If you set is not specified, to_s will be called on the element to generate the display string.
 * :children - The name of the method (typically the has_many relationship) to call to get the nested collection (leave unspecified or nil if this is the leaf node)
 * :child - The spec for the elements of the children (leave unspecified or nil if this is the leaf node)
 
@@ -148,6 +169,25 @@ Let's say we have the following
 
 Be sure that the inner most child of the spec has :children => nil (or just leave it undefined). This will stop the nesting.
 
+## JQuery based Javascript Functions
+
+Aside from the javascript functions that are used by the generated elements (like the Show More button), there are some javascript functions that might be useful to users described below.
+
+### autoCollapseAllListyBranchesBut
+
+	autoCollapseAllListyBranchesBut(headerName, tree)
+	
+This method is handy to collapse all branches of a listy_tree with the exception of a branch that has a header that matches the passed in headerName.
+
+* headerName - The text to match. If a list in the listy_tree has a header that matches this value, it will be left alone. All other lists will be collapsed.
+* tree - The listy tree element. If using JQuery, you can pass in something like $(".listy-tree listy-tree-level-1")
+
+#### Example Usage:
+
+```javascript
+	autoCollapseAllListyBranchesBut("Products", $(".listy-tree listy-tree-level-1"));
+```
+
 
 ## Contributing
 

data/app/assets/javascripts/listy.js

@@ -6,10 +6,11 @@ $(function(){
 function listyTreeListHeaderClick() {
 	var list = $(this).siblings("ul");
 	toggleListyTreeList(list);
+	return false;
 }
 
 function toggleListyTreeList(list) {
-	toggleListyTreList(200);
+	toggleListyTreeList(list, 200);
 }
 
 function toggleListyTreeList(list, duration) {
@@ -17,20 +18,22 @@ function toggleListyTreeList(list, duration) {
 	var header = list.siblings(".listy-tree-list-header");
 	if(list.is(":visible")) {
 		list.slideUp(duration);
-		header.children(".icon").html("<i class='icon-angle-right'></i>");
+		header.removeClass("listy-list-header-expanded");
+		header.addClass("listy-list-header-collapsed");
 	}
 	else {
 		list.slideDown(duration);
-		header.children(".icon").html("<i class='icon-angle-down'></i>");
+		header.addClass("listy-list-header-expanded");
+		header.removeClass("listy-list-header-collapsed");
 	}
 }
 
-function autoCollapseAllBut(headerName, tree) {
+function autoCollapseAllListyBranchesBut(headerName, tree) {
 	jQuery.each(tree.children("li"), function(){
 		
-		var listHeaderText = $(this).children(".list-header").children(".list-header-text").html();
+		var listHeaderText = $(this).children(".listy-tree-list-header").html();
 		if(headerName != listHeaderText) {
-			toggleList($(this).children(".list-header").siblings("ul"), 0);
+			toggleListyTreeList($(this).children(".listy-tree-list-header").siblings("ul"), 0);
 		}
 		
 	});
@@ -38,15 +41,15 @@ function autoCollapseAllBut(headerName, tree) {
 
 /*********************** LISTY SHOW-MORE LIST ******************************************/
 $(function(){
-	$(".listy-show-more-link").click(toggleMoreList);
+	$(".listy-show-more-link").click(toggleListyShowMoreList);
 });
 
-function toggleMoreList() {
+function toggleListyShowMoreList() {
 	toggleMoreList(200);
 	return false;
 }
 
-function toggleMoreList(duration) {
+function toggleListyShowMoreList(duration) {
 	var showMoreList = $(this).siblings(".listy-show-more-list");
 	if(showMoreList.is(":visible")) {
 		showMoreList.slideUp(duration);

data/lib/listy/version.rb

@@ -1,3 +1,3 @@
 module Listy
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/lib/listy/view_helpers.rb

@@ -2,8 +2,9 @@ module Listy
   module ViewHelpers
  
     def listy_tree(collection, spec, options={})
+      css_class = options[:css_class] || ""
       if collection.present?
-        html = "<div class='listy-tree'>" + create_listy_tree(collection, spec, "", 0) + "</div>"
+        html = "<div class='listy-tree " + css_class + "'>" + create_listy_tree(collection, spec, "", 0) + "</div>"
       else
         html = options[:empty_message] || "There are no entries in this list."
       end
@@ -77,8 +78,14 @@ module Listy
         collection.each do |element|
           html += "<li>"
           display = spec[:display_method].nil? ? element.to_s : element.try(spec[:display_method])
-          html += "<div class='listy-tree-list-header'>#{display}</div>"
-          html = create_listy_tree(element.try(spec[:children]), spec[:child], html, level+1) if !spec[:children].nil?
+          
+          if !spec[:children].nil?
+            html += "<div class='listy-tree-list-header listy-list-header-expanded'>#{display}</div>"
+            html = create_listy_tree(element.try(spec[:children]), spec[:child], html, level+1) 
+          else
+            html += "<div class='listy-tree-leaf'>#{display}</div>"
+          end
+          
           html += "</li>"
         end
 

data/listy.gemspec

@@ -7,7 +7,8 @@ Gem::Specification.new do |gem|
   gem.description   = %q{"A bunch of helpers to create fancy lists"}
   gem.summary       = %q{"Everything for list of links from collections to multi-column lists"}
   gem.homepage      = ""
-
+  gem.license       = 'MIT'
+  
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: listy
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-23 00:00:00.000000000 Z
+date: 2013-07-25 00:00:00.000000000 Z
 dependencies: []
 description: ! '"A bunch of helpers to create fancy lists"'
 email:
@@ -33,7 +33,8 @@ files:
 - lib/listy/view_helpers.rb
 - listy.gemspec
 homepage: ''
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths: