API reference

Decorators

navigation.decorators.breadcrumb(crumb, coerce_to=None)

Usage:

from navigation.decorators import breadcrumb

@breadcrumb('greeting')
def some_view(request):
    return 'Hello world!'

@breadcrumb(lambda request: u'greeting for %s' % request.user.username)
def some_view(request):
    return 'Hello %s!' % request.user.username

Note

By default the value returned by a callable is required to be a unicode object. If the function returns a model instance, its __unicode__ method is not called. Use coerce_to=unicode.

Parameters:

• crumb – A unicode string or a callable that returns it.
• coerce_to – Coerces crumb to given type. The value can be unicode or any callable that returns a unicode object.

Template tags and filters

Loading:

{% load navigation_tags %}

navigation.templatetags.navigation_tags.named_crumb(parser, tokens)

Resolves given named URL and returns the relevant breadcrumb label (if available). Usage:

<a href="{% url project-detail project.slug %}">
    {% named_crumb project-detail project.slug %}
</a>

navigation.templatetags.navigation_tags.crumb_link(parser, tokens)

Acts like named_crumb() but also wraps the result into a link tag. Usage:

<ul>
    <li>{% crumb_link 'auth_login' %}</li>
    <li>{% crumb_link 'project-index' %}</li>
</ul>

The result:

<ul>
    <li><a href="/accounts/login/">Log in</a></li>
    <li><a href="/projects/">Projects</a></li>
</ul>

Please note that you have to use quotes, otherwise the arguments are considered variable names.

navigation.templatetags.navigation_tags.get_breadcrumb_sections(parser, tokens)

Returns a list of sections. Usage:

{% get_breadcrumb_sections as sections %}
{% for section in sections %}
    ...
{% endfor %}

navigation.templatetags.navigation_tags.get_breadcrumb_trail(parser, tokens)

Returns the trail of breadcrumbs. Each breadcrumb is represented by a navigation.helpers.Crumb instance.

navigation.templatetags.navigation_tags.get_navigation(request)

Returns the rendered navigation block. Requires that the navigation.html template exists. Two context variables are passed to it:

• sections (see get_breadcrumb_sections())
• trail (see get_breadcrumb_trail())

Helpers

class navigation.helpers.Crumb(url, title, is_current=False, is_active=False, is_dummy=False)

A navigation node.

url

this breadcrumb’s URL.

title

this breadcrumb’s title, as determined by the first successful crumb resolver.

is_current

True if this breadcrumb’s URL corresponds to the current request path.

is_active

True if current request path begins with this breadcrumb’s URL.

is_dummy

True if this breadcrumb is a stub, i.e. its URL could not be resolved by a crumb resolver.