README.textile in crummy-1.1.1 vs README.textile in crummy-1.2
- old
+ new
@@ -71,32 +71,38 @@
render_crumbs renders the list of crumbs as either html or xml
It takes 3 options
-The output format. Can either be :xml or :html. Defaults to :html
+The output format. Can either be :xml or :html or :html_list. Defaults to :html
-<code>:format => (:html|:xml)</code>
+<code>:format => (:html|:html_list|:xml)</code>
The separator text. It does not assume you want spaces on either side so you must specify. Defaults to <code>»</code> for :html and <code><crumb></code> for :xml
<code>:separator => string</code>
Render links in the output. Defaults to +true+
<code>:links => boolean</code>
+<code>:skip_if_blank => true</code>
+
+With this option, output will be blank if there are no breadcrumps.
+
h3. Examples
<pre>
<code>
- render_crumbs #=> <a href="/">Home</a> » <a href="/businesses">Businesses</a>
- render_crumbs :separator => ' | ' #=> <a href="/">Home</a> | <a href="/businesses">Businesses</a>
- render_crumbs :format => :xml #=> <crumb href="/">Home</crumb><crumb href="/businesses">Businesses</crumb>
+ render_crumbs #=> <a href="/">Home</a> » <a href="/businesses">Businesses</a>
+ render_crumbs :separator => ' | ' #=> <a href="/">Home</a> | <a href="/businesses">Businesses</a>
+ render_crumbs :format => :xml #=> <crumb href="/">Home</crumb><crumb href="/businesses">Businesses</crumb>
+ render_crumbs :format => :html_list #=> <ul class="" id=""><li class=""><a href="/">Home</a></li><li class=""><a href="/">Businesses</a></li></ul>
</code>
</pre>
A crumb with a nil link will just output plain text.
+With :format => :html_list you can specify additional params: :active_li_class, :li_class, :ul_class, :ul_id
h2. Notes
The variable set is set to @_crumbs as to not conflict with your code.
@@ -115,7 +121,8 @@
* "Przemysław Kowalczyk":http://szeryf.wordpress.com/2008/06/13/easy-and-flexible-breadcrumbs-for-rails/ - feature ideas
* "Sharad Jain":http://github.com/sjain
* "Max Riveiro":http://github.com/kavu
* "Kamil K. Lemański":http://kml.jogger.pl
* "Brian Cobb":http://bcobb.net/
+* "Kir Shatrov":http://shatrov.tk/
*Copyright (c) 2011 Zach Inglis, released under the MIT license*