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: https://modx.com/extras/package/breadcrumb

Support, Comments, Development and Bug Reporting¶

• Github: BreadCrumb
• Support: MODX Community

Usage¶

The BreadCrumb snippet can be called using the tag :

[[BreadCrumb]]

Breadcrumb properties¶

Valid scheme values:

• -1 : (default value) URL is relative to site_url
• 0 : see http
• 1 : see https
• full : URL is absolute, prepended with site_url from config
• abs : URL is absolute, prepended with base_url from config
• http : URL is absolute, forced to http scheme
• https : URL is absolute, forced to https scheme

Templating properties¶

@CODE no longer supported since 1.4.0-pl. Use @INLINE instead.

Examples¶

Show the breadcrumb of the current resource

[[BreadCrumb]]

Show the breadcrumb of the resource whose ID is 72

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

Show home crumb at the start of breadcrumb

[[BreadCrumb? &showHomeCrumb=`1`]]

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`]]

Exclude some resources

[[BreadCrumb? &exclude=`23,135`]]

Use custom templates

[[BreadCrumb? &linkCrumbTpl=`myLinkCrumbTpl`]]
[[BreadCrumb? &linkCrumbTpl=`@INLINE <li><a href="[[+link]]">[[+pagetitle]]</a></li>`]]
[[BreadCrumb? &linkCrumbTpl=`@FILE [[++assets_path]]my_link_crumb_tpl.html`]]

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.

crumbSeparator¶

Before:

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

Use CSS instead:

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

currentAsLink¶

Before:

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

New:

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

Chunk myCurrentCrumbTpl:

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

descField¶

Before:

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

New:

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

Chunks myLinkCrumbTpl and myCurrentCrumbTpl:

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

homeCrumbDescription¶

Before:

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

After:

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

Chunk myContainerTpl:

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

homeCrumbTitle¶

Before:

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

After:

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

Chunks myContainerTpl:

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

maxDelimiter¶

Before:

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

After:

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

Chunk myMaxCrumbTpl:

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

titleField¶

Before:

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

After:

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

Chunk myLinkCrumbTpl and myCurrentCrumbTpl:

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