Skip to main content

Simple, yet powerful, code-based menus for Django applications

Project description

Jazzband Build Status Test coverage status Documentation status Supported Python versions Supported Django versions

django-simple-menu is an entirely code based menu system, because, who really wants to define their menus inside Django Admin?..

It’s simple to use, yet provides enough flexibility to provide unlimited children menus, per-request generation and checking of menu items, badges, and more.

Quickstart

Requirements: Python 3.6+, Django 3.2+

  1. Install the django-simple-menu package.

  2. Add simple_menu to your INSTALLED_APPS.

    • please ensure that you have django.template.context_processors.request listed under TEMPLATES[...]["OPTIONS"]["context_processors"].

  3. Create menus.py inside each app you want to create a menu for and define said menus using the Menu and MenuItem classes you can import from the simple_menu package.

  4. In your templates, load the template tags ({% load simple_menu %}) and call {% generate_menu %} inside a block. Your context will be populated with a new object named menus. You can now iterate over it to render your menus.

To quickly see django-simple-menu in action, check out the example project.

More

Full documentation, including installation and configuration instructions, is available at https://django-simple-menu.readthedocs.io/.

django-simple-menu is released under the BSD 2-Clause “Simplified” License. If you like it, please consider contributing!

django-simple-menu was originally created by Evan Borgstom <evan@borgstrom.ca> and was further developed by many contributors.

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-simple-menu-2.1.0.tar.gz (184.2 kB view details)

Uploaded Source

Built Distribution

django_simple_menu-2.1.0-py3-none-any.whl (14.0 kB view details)

Uploaded Python 3

File details

Details for the file django-simple-menu-2.1.0.tar.gz.

File metadata

  • Download URL: django-simple-menu-2.1.0.tar.gz
  • Upload date:
  • Size: 184.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.6

File hashes

Hashes for django-simple-menu-2.1.0.tar.gz
Algorithm Hash digest
SHA256 387f74b28a5fcf9432a27a7374aaf6191bee0e329d1aa2b8914145e93436afd2
MD5 a0f7a47d053c52a1bfb6d6d8212ce0a3
BLAKE2b-256 6c1512df0c6f576f995aeab4ce1820ee953a095ddb41c7bccdd8a63287e01010

See more details on using hashes here.

File details

Details for the file django_simple_menu-2.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for django_simple_menu-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4edba83df6e018a1fc23ea5f4d0d9509da792c7f2aa45f03ff07d853b7b083af
MD5 8858b57109afb7af3561ffa723fc88aa
BLAKE2b-256 bac7bc1617a82aa666e3922b64768ccff3c18181295bc09d811931253fb3d2d3

See more details on using hashes here.

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