BreadCrumb

What is BreadCrumb?

Breadcrumb is a snippet for MODx Revolution, inspired by the Breadcrumbs snippet.

As the original Breadcrumbs, this snippet will create a breadcrumb navigation (no kidding !! ) but also add some new features like template properties or specific resource ID property.

Requirements

• MODx Revolution 2.0.x or later
• PHP5 or later

Public Releases

Download

It can be downloaded from within the MODx Revolution manager via Package Management, or from the MODx Extras Repository, here: http://modx.com/extras/package/breadcrumb

Support, Comments, Development and Bug Reporting

Github : https://github.com/omycode/breadcrumb
Support/Comments : http://forums.modx.com/thread/71902/support-comments-for-breadcrumb

Usage

The BreadCrumb snippet can be called using the tag :

[[BreadCrumb]]

Breadcrumb properties

Templating properties

Examples

Show the breadcrumb of the current resource

[[BreadCrumb]]

Show the breadcrumb of the resource whose ID is 72

[[BreadCrumb? &to=`72`]]

Show the breadcrumb of the resource whose ID is 72 from it's level 2 parent

[[BreadCrumb? &from=`[[UltimateParent? &topLevel=`2`]]` &to=`72`]]

Change the direction of the breadcrumb : rtl (Right To Left) or ltr (Left To Right)

[[BreadCrumb? &direction=`rtl`]]

Use custom templates

[[BreadCrumb? &linkCrumbTpl=`myLinkCrumbTpl`]]

Migrate from Breadcrumbs snippet

Once again, BreadCrumb was inspired by the Breadcrumbs snippet. Some of Breadcrumbs properties have been removed but you still can do the same things with BreadCrumb ... just in a different way.

[[Breadcrumbs? &crumbSeparator=`>`]]

#breadcrumb li + li:before{
  content:  '>';
  margin:   0 2px;
}

[[Breadcrumbs? &currentAsLink=`1`]]

[[BreadCrumb? &currentCrumbTpl=`myCurrentCrumbTpl`]]

<li><a href="[[+link]]">[[+pagetitle]]</a></li>

[[Breadcrumbs? &descField=`longtitle`]]

[[BreadCrumb? &linkCrumbTpl=`myLinkCrumbTpl` &currentCrumbTpl=`myCurrentCrumbTpl`]]

<li><a href="[[+link]]" title="[[+longtitle]]">[[+pagetitle]]</a></li>

[[Breadcrumbs? &homeCrumbDescription=`Home`]]

[[BreadCrumb? &containerTpl=`myContainerTpl`]]

<ul>
  <li><a href="[[++site_url]]">Home</a></li>
  [[+crumbs]]
</ul>

[[Breadcrumbs? &homeCrumbTitle=`Home`]]

[[BreadCrumb? &containerTpl=`myContainerTpl`]]

<ul>
  <li><a href="[[++site_url]]" title="Home">Home</a></li>
  [[+crumbs]]
</ul>

[[Breadcrumbs? &maxDelimiter=`(...)`]] 

[[BreadCrumb? &maxCrumbTpl=`myMaxCrumbTpl`]]

<li>(...)</li>

[[Breadcrumbs? &titleField=`menutitle`]]

[[BreadCrumb? &linkCrumbTpl=`myLinkCrumbTpl` &currentCrumbTpl=`myCurrentCrumbTpl`]]

<li><a href="[[+link]]">[[+menutitle]]</a></li>

See Also

bdListings

Home

Breadcrumbs