Django Menu Generator
A menu generating application for Django
A productivity tool that enables the generation of full featured menus through python dictionaries list, you only need to setup the HTML structure once for each menu you like to build and then use the dictionaries to generate menu items
Features:
- Tested support to Python 3.4, 3.5, 3.6, 3.7, 3.8
- Tested support to Django 1.8, 1.9, 1.10, 1.11, 2.0, 2.2, 3.0, 3.1
- No database
- Support unlimited menus
- Icons support
- Semi-Automatically identifies the selected item and his breadcrums
- Conditional menu items display through validators (Permissions, Authentications or whatever you want)
Documentation:
The full documentation for Django Menu Generator is allowed here:
http://django-menu-generator.readthedocs.io/en/latest/index.html
Installation:
You can install it with one of these options:
easy_install django-menu-generatorpip install django-menu-generatorgit clone https://github.com/LaLogiaDePython/django-menu-generatorcd django-menu-generator- run python setup.py
wget https://github.com/LaLogiaDePython/django-menu-generator/zipball/master- unzip the downloaded file
- cd into django-menu-generator-* directory
- run python setup.py
Usage:
- Once installed, add
'menu_generator'to your INSTALLED_APPS. - Add
{% load menu_generator %}to templates that will handle the menus. - Add the list dictionaries containing the menu items to the settings
####################################################################################
Example: settings.py
####################################################################################
NAV_MENU_LEFT = [
{
"name": "Home",
"url": "/",
},
{
"name": "About",
"url": "/about",
},
]
NAV_MENU_RIGHT = [
{
"name": "Login",
"url": "login_url_view", # reversible
"validators": ["menu_generator.validators.is_anonymous"],
},
{
"name": "Register",
"url": "register_view_url", # reversible
"validators": ["menu_generator.validators.is_anonymous"],
},
{
"name": "Account",
"url": "/acount",
"validators": ["menu_generator.validators.is_authenticated"],
"submenu": [
{
"name": "Profile",
"url": "/account/profile",
},
{
"name": "Account Balance",
"url": "/account/balance",
"validators": ["myapp.profiles.is_paid_user"],
},
{
"name": "Account Secrets",
"url": "/account/secrets",
"validators": ["menu_generator.validators.is_superuser"],
}
],
},
]
FOOTER_MENU_LEFT = [
{
"name": "Facebook",
"url": "facebook.com/foobar",
},
{
"name": "Contact US",
"url": "/contact",
},
]
FOOTER_MENU_RIGHT = [
{
"name": "Address",
"url": "/address",
},
]Or you can build the menu dictionaries list inside the project apps with
menus.py files, see docs for more.
- In your template, load the template tag to generate your menu.
{% load menu_generator %}
<!DOCTYPE html>
<html>
<head><title>Django Menu Generator</title></head>
<body>
<!-- NAV BAR Start -->
{% get_menu "NAV_MENU_LEFT" as left_menu %}
<div style="float:left;">
{% for item in left_menu %}
<li class="{% if item.selected %} active {% endif %}">
<a href="{{ item.url }}"> <i class="{{ item.icon_class }}"></i> {{ item.name }}</a>
</li>
{% if item.submenu %}
<ul>
{% for menu in item.submenu %}
<li class="{% if menu.selected %} active {% endif %}">
<a href="{{ menu.url }}">{{ menu.name }}</a>
</li>
{% endfor %}
</ul>
{% endif %}
{% endfor %}
</div>
{% get_menu "NAV_MENU_RIGHT" as right_menu %}
<div style="float:right;">
{% for item in right_menu %}
<li class="{% if item.selected %} active {% endif %}">
<a href="{{ item.url }}">{{ item.name }}</a>
</li>
{% if item.submenu %}
<ul>
{% for menu in item.submenu %}
<li class="{% if menu.selected %} active {% endif %}">
<a href="{{ menu.url }}">{{ menu.name }}</a>
</li>
{% endfor %}
</ul>
{% endif %}
{% endfor %}
</div>
<!-- NAV BAR End -->
<!-- Footer Start -->
{% get_menu "FOOTER_MENU_LEFT" as left_footer_menu %}
<div style="float:left;">
<!-- loop through your left footer menus -->
</div>
{% get_menu "FOOTER_MENU_RIGHT" as right_footer_menu %}
<div style="float:right;">
<!-- loop through your right footer menus -->
</div>
<!-- Footer End -->
</body>
</html>
- Now you must to see your menus generated when you run your project
Running the tests:
To run the tests against configured environments:
tox
License:
Released under a (MIT) license.
Author and mantainers:
Milton Lenis - [email protected]
Juan Diego García - [email protected]
Credits:
We would like to thank Val Kneeman, the original author of this project under the name 'menuware' https://github.com/un33k/django-menuware