Skip to main content

A simple Django navigation template tag

Project description

A simple Django template tag to handle navigation item selection.

Example

Add the app to your INSTALLED_APPS setting:

INSTALLED_APPS = (
        # ...
        'django_navtag',
)

Give your base template a navigation block something like this:

{% block nav %}
<ul class="nav">
    <li{% if nav.home %} class="selected"{% endif %}>
        <a href="/">Home</a>
    </li>
    <li{% if nav.about %} class="selected"{% endif %}>
        <a href="/about/">About</a>
    </li>
</ul>
{% endblock %}

In your templates, extend the base and set the navigation location:

{% extends "base.html" %}

{% block nav %}
{% nav "home" %}
{{ block.super }}
{% endblock %}

Hierarchical navigation

To create a sub-menu you can check against, simply dot-separate the item:

{% nav "about_menu.info" %}

This will be pass for both {% if nav.about_menu %} and {% if nav.about_menu.info %}.

Using a different context variable

By default, this tag creates a nav context variable. To use an alternate context variable name, call {% nav [item] for [var_name] %}:

{% block nav %}
{% nav "home" for sidenav %}
{{ block.super }}
{% endblock %}

Using {% nav %} across multiple tags

To use this tag across {% block %} tags (or other context-stacking template tags such as {% for %}), initialize the tag at the start of your base template:

{# Set up the variable for use across context-stacking tags #}
{% nav %} or {% nav for sidenav %}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-navtag-1.0.tar.gz (5.8 kB view details)

Uploaded Source

File details

Details for the file django-navtag-1.0.tar.gz.

File metadata

  • Download URL: django-navtag-1.0.tar.gz
  • Upload date:
  • Size: 5.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for django-navtag-1.0.tar.gz
Algorithm Hash digest
SHA256 56175338fd4d6bae34b61cc183e2fec716c55b3c805bc788ff0fa744b23d57b5
MD5 19f17485c7b0295013e9fd7abae48d9c
BLAKE2b-256 23bef8ff92d444cd63bc8e134f08bf3aa14d4be40489563603a4103e935e97bc

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page