1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
|
Django Menu Generator - next generation
=======================================
A menu generating application for Django
Forked from the original at https://github.com/LaLogiaDePython/django-menu-generator
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.7, 3.8, 3.9
- Tested support to Django 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-generator``
- ``pip install django-menu-generator``
- ``git clone https://github.com/LaLogiaDePython/django-menu-generator``
1. ``cd django-menu-generator``
2. run python setup.py
- ``wget https://github.com/LaLogiaDePython/django-menu-generator/zipball/master``
1. unzip the downloaded file
2. cd into django-menu-generator-\* directory
3. run python setup.py
Usage:
------
1. Once installed, add ``'menu_generator'`` to your INSTALLED\_APPS.
2. Add ``{% load menu_generator %}`` to templates that will handle the
menus.
3. Add the list dictionaries containing the menu items to the settings
.. code:: python
####################################################################################
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.
4. 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>
5. 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>`__) license.
Author and mantainers:
----------------------
This fork is maintained by the AlekSIS team.
Original authors and maintainers
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The following people maintained django-menu-generator for a long time:
`Milton Lenis <https://github.com/MiltonLn>`__ - miltonln04@gmail.com
`Juan Diego García <https://github.com/yamijuan>`__ - juandgoc@gmail.com
Credits:
--------
We would like to thank `Val Kneeman <https://github.com/un33k>`__, the
original author of this project under the name 'menuware'
https://github.com/un33k/django-menuware
|
