Skip to main content

Templatetag to render an application menu in the Django admin.

Project description

django-admin-appmenu provides a templatetag that renders an application menu in the Django admin.

https://img.shields.io/pypi/v/django-admin-appmenu.svg https://img.shields.io/pypi/pyversions/django-admin-appmenu.svg https://travis-ci.org/collab-project/django-admin-appmenu.svg?branch=master https://coveralls.io/repos/collab-project/django-admin-appmenu/badge.svg https://img.shields.io/badge/license-MIT-blue.svg

Installation

Use pip to install the download and install the package from PyPi:

pip install django-admin-appmenu

Or checkout the source code from Github:

git clone https://github.com/collab-project/django-admin-appmenu.git
cd django-admin-appmenu
pip install -e .

Add admin_appmenu to INSTALLED_APPS in your Django project settings:

INSTALLED_APPS = (
    ...

    'admin_appmenu',
)

Usage

Override the admin/base.html template and make the tag available in the template:

{% load navigation %}

Now add the admin_navigation tag to the template:

{% admin_navigation %}

After reloading the admin you will see the new menu.

To customize the output of the tag create and customize a copy of the admin_appmenu/navigation.html template.

Custom admin site

By default the standard Django admin site (django.contrib.admin.site) is used to build the menu tree. If your project uses a customized admin site set the ADMIN_APPMENU_CLASS setting to the path of the custom admin site instance.

For example in settings.py:

ADMIN_APPMENU_CLASS = 'myapp.admin.admin_site'

This also allows you to sort and format the applications list used to render the menu.

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-admin-appmenu-1.0.0.tar.gz (8.5 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page