-
-
Notifications
You must be signed in to change notification settings - Fork 139
/
menu_tags.py
190 lines (160 loc) · 6.49 KB
/
menu_tags.py
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
from django.template import Library
from wagtail.core.models import Page
from wagtailmenus.conf import constants, settings
from wagtailmenus.errors import SubMenuUsageError
from wagtailmenus.utils.misc import validate_supplied_values
register = Library()
def split_if_string(val, separator=','):
if isinstance(val, str):
return tuple(item.strip() for item in val.split(separator))
return val
@register.simple_tag(takes_context=True)
def main_menu(
context, max_levels=None, apply_active_classes=True,
allow_repeating_parents=True, show_multiple_levels=True,
template='', sub_menu_template='', sub_menu_templates=None,
use_absolute_page_urls=False, add_sub_menus_inline=None,
**kwargs
):
validate_supplied_values('main_menu', max_levels=max_levels)
if not show_multiple_levels:
max_levels = 1
menu_class = settings.models.MAIN_MENU_MODEL
return menu_class.render_from_tag(
context=context,
max_levels=max_levels,
apply_active_classes=apply_active_classes,
allow_repeating_parents=allow_repeating_parents,
use_absolute_page_urls=use_absolute_page_urls,
add_sub_menus_inline=add_sub_menus_inline,
template_name=template,
sub_menu_template_name=sub_menu_template,
sub_menu_template_names=split_if_string(sub_menu_templates),
**kwargs
)
@register.simple_tag(takes_context=True)
def flat_menu(
context, handle, max_levels=None, show_menu_heading=False,
apply_active_classes=False, allow_repeating_parents=True,
show_multiple_levels=True, template='', sub_menu_template='',
sub_menu_templates=None, fall_back_to_default_site_menus=None,
use_absolute_page_urls=False, add_sub_menus_inline=None,
**kwargs
):
validate_supplied_values('flat_menu', max_levels=max_levels)
if fall_back_to_default_site_menus is None:
fall_back_to_default_site_menus = settings.FLAT_MENUS_FALL_BACK_TO_DEFAULT_SITE_MENUS
if not show_multiple_levels:
max_levels = 1
menu_class = settings.models.FLAT_MENU_MODEL
return menu_class.render_from_tag(
context=context,
handle=handle,
fall_back_to_default_site_menus=fall_back_to_default_site_menus,
max_levels=max_levels,
apply_active_classes=apply_active_classes,
allow_repeating_parents=allow_repeating_parents,
use_absolute_page_urls=use_absolute_page_urls,
add_sub_menus_inline=add_sub_menus_inline,
template_name=template,
sub_menu_template_name=sub_menu_template,
sub_menu_template_names=split_if_string(sub_menu_templates),
show_menu_heading=show_menu_heading,
**kwargs
)
@register.simple_tag(takes_context=True)
def section_menu(
context, show_section_root=True, show_multiple_levels=True,
apply_active_classes=True, allow_repeating_parents=True,
max_levels=settings.DEFAULT_SECTION_MENU_MAX_LEVELS,
template='', sub_menu_template='', sub_menu_templates=None,
use_absolute_page_urls=False, add_sub_menus_inline=None,
**kwargs
):
"""Render a section menu for the current section."""
validate_supplied_values('section_menu', max_levels=max_levels)
if not show_multiple_levels:
max_levels = 1
menu_class = settings.objects.SECTION_MENU_CLASS
return menu_class.render_from_tag(
context=context,
max_levels=max_levels,
apply_active_classes=apply_active_classes,
allow_repeating_parents=allow_repeating_parents,
use_absolute_page_urls=use_absolute_page_urls,
add_sub_menus_inline=add_sub_menus_inline,
template_name=template,
sub_menu_template_name=sub_menu_template,
sub_menu_template_names=split_if_string(sub_menu_templates),
show_section_root=show_section_root,
**kwargs
)
@register.simple_tag(takes_context=True)
def children_menu(
context, parent_page=None, allow_repeating_parents=True,
apply_active_classes=False,
max_levels=settings.DEFAULT_CHILDREN_MENU_MAX_LEVELS,
template='', sub_menu_template='', sub_menu_templates=None,
use_absolute_page_urls=False, add_sub_menus_inline=None,
**kwargs
):
validate_supplied_values(
'children_menu',
max_levels=max_levels,
parent_page=parent_page,
)
menu_class = settings.objects.CHILDREN_MENU_CLASS
return menu_class.render_from_tag(
context=context,
parent_page=parent_page,
max_levels=max_levels,
apply_active_classes=apply_active_classes,
allow_repeating_parents=allow_repeating_parents,
use_absolute_page_urls=use_absolute_page_urls,
add_sub_menus_inline=add_sub_menus_inline,
template_name=template,
sub_menu_template_name=sub_menu_template,
sub_menu_template_names=split_if_string(sub_menu_templates),
**kwargs
)
@register.simple_tag(takes_context=True)
def sub_menu(
context, menuitem_or_page, allow_repeating_parents=None,
apply_active_classes=None, template='', use_absolute_page_urls=None,
add_sub_menus_inline=None, **kwargs
):
"""
Retrieve the children pages for the `menuitem_or_page` provided, turn them
into menu items, and render them to a template.
"""
validate_supplied_values('sub_menu', menuitem_or_page=menuitem_or_page)
max_levels = context.get(
'max_levels', settings.DEFAULT_CHILDREN_MENU_MAX_LEVELS
)
if apply_active_classes is None:
apply_active_classes = context.get('apply_active_classes', True)
if allow_repeating_parents is None:
allow_repeating_parents = context.get('allow_repeating_parents', True)
if use_absolute_page_urls is None:
use_absolute_page_urls = context.get('use_absolute_page_urls', False)
if add_sub_menus_inline is None:
add_sub_menus_inline = context.get('add_sub_menus_inline', False)
if isinstance(menuitem_or_page, Page):
parent_page = menuitem_or_page
else:
parent_page = menuitem_or_page.link_page
original_menu = context.get('original_menu_instance')
if original_menu is None:
raise SubMenuUsageError()
menu_class = original_menu.get_sub_menu_class()
return menu_class.render_from_tag(
context=context,
parent_page=parent_page,
max_levels=max_levels,
apply_active_classes=apply_active_classes,
allow_repeating_parents=allow_repeating_parents,
use_absolute_page_urls=use_absolute_page_urls,
add_sub_menus_inline=add_sub_menus_inline,
template_name=template,
**kwargs
)