def sidebar_props(context):
request = context["request"]
search_areas = admin_search_areas.search_items_for_request(request)
if search_areas:
search_area = search_areas[0]
else:
search_area = None
account_menu = [
sidebar.LinkMenuItem("account",
_("Account"),
reverse("wagtailadmin_account"),
icon_name="user"),
sidebar.LinkMenuItem("logout",
_("Log out"),
reverse("wagtailadmin_logout"),
icon_name="logout"),
]
modules = [
sidebar.WagtailBrandingModule(),
sidebar.SearchModule(search_area) if search_area else None,
sidebar.MainMenuModule(admin_menu.render_component(request),
account_menu, request.user),
]
modules = [module for module in modules if module is not None]
return json_script(
{
"modules": JSContext().pack(modules),
},
element_id="wagtail-sidebar-props",
)
def test_admin_only_menuitem(self):
menu = Menu(register_hook_name="register_menu_item")
with hooks.register_temporarily([
("register_menu_item", menu_item_hook("Pages", "/pages/")),
(
"register_menu_item",
menu_item_hook("Secret pages",
"/pages/secret/",
cls=AdminOnlyMenuItem),
),
]):
rendered = menu.render_component(self.request)
self.request.user = self.create_user(username="******")
rendered_non_admin = menu.render_component(self.request)
self.assertListEqual(
rendered,
[
sidebar.LinkMenuItem("pages", "Pages", "/pages/"),
sidebar.LinkMenuItem("secret-pages", "Secret pages",
"/pages/secret/"),
],
)
self.assertListEqual(
rendered_non_admin,
[
sidebar.LinkMenuItem("pages", "Pages", "/pages/"),
],
)
def menu_props(context):
request = context['request']
search_areas = admin_search_areas.search_items_for_request(request)
if search_areas:
search_area = search_areas[0]
else:
search_area = None
account_menu = [
sidebar.LinkMenuItem('account',
_("Account"),
reverse('wagtailadmin_account'),
icon_name='user'),
sidebar.LinkMenuItem('logout',
_("Log out"),
reverse('wagtailadmin_logout'),
icon_name='logout'),
]
modules = [
sidebar.WagtailBrandingModule(),
sidebar.SearchModule(search_area) if search_area else None,
sidebar.MainMenuModule(admin_menu.render_component(request),
account_menu, request.user),
]
modules = [module for module in modules if module is not None]
return json.dumps({
'modules': JSContext().pack(modules),
},
cls=DjangoJSONEncoder)
def test_simple_menu(self):
# Note: initialise the menu before registering hooks as this is what happens in reality.
# (the real menus are initialised at the module level in admin/menu.py)
menu = Menu(register_hook_name='register_menu_item')
with hooks.register_temporarily([
('register_menu_item', menu_item_hook("Pages", '/pages/')),
('register_menu_item', menu_item_hook("Images", '/images/')),
]):
rendered = menu.render_component(self.request)
self.assertIsInstance(rendered, list)
self.assertListEqual(rendered, [
sidebar.LinkMenuItem('pages', "Pages", '/pages/'),
sidebar.LinkMenuItem('images', "Images", '/images/'),
])
def test_submenu(self):
menu = Menu(register_hook_name="register_menu_item")
submenu = Menu(register_hook_name="register_submenu_item")
with hooks.register_temporarily([
(
"register_menu_item",
menu_item_hook("My lovely submenu",
submenu,
cls=SubmenuMenuItem),
),
("register_submenu_item", menu_item_hook("Pages", "/pages/")),
]):
rendered = menu.render_component(self.request)
self.assertIsInstance(rendered, list)
self.assertEqual(len(rendered), 1)
self.assertIsInstance(rendered[0], sidebar.SubMenuItem)
self.assertEqual(rendered[0].name, "my-lovely-submenu")
self.assertEqual(rendered[0].label, "My lovely submenu")
self.assertListEqual(
rendered[0].menu_items,
[
sidebar.LinkMenuItem("pages", "Pages", "/pages/"),
],
)
def test_admin_only_menuitem(self):
menu = Menu(register_hook_name='register_menu_item')
with hooks.register_temporarily([
('register_menu_item', menu_item_hook("Pages", '/pages/')),
('register_menu_item',
menu_item_hook("Secret pages",
'/pages/secret/',
cls=AdminOnlyMenuItem)),
]):
rendered = menu.render_component(self.request)
self.request.user = self.create_user(username='******')
rendered_non_admin = menu.render_component(self.request)
self.assertListEqual(rendered, [
sidebar.LinkMenuItem('pages', "Pages", '/pages/'),
sidebar.LinkMenuItem('secret-pages', "Secret pages",
'/pages/secret/'),
])
self.assertListEqual(rendered_non_admin, [
sidebar.LinkMenuItem('pages', "Pages", '/pages/'),
])
def test_menu_with_construct_hook(self):
menu = Menu(register_hook_name='register_menu_item',
construct_hook_name='construct_menu')
def remove_images(request, items):
items[:] = [item for item in items if not item.name == 'images']
with hooks.register_temporarily([
('register_menu_item', menu_item_hook("Pages", '/pages/')),
('register_menu_item', menu_item_hook("Images", '/images/')),
('construct_menu', remove_images),
]):
rendered = menu.render_component(self.request)
self.assertEqual(rendered, [
sidebar.LinkMenuItem('pages', "Pages", '/pages/'),
])
def test_menu_with_construct_hook(self):
menu = Menu(
register_hook_name="register_menu_item",
construct_hook_name="construct_menu",
)
def remove_images(request, items):
items[:] = [item for item in items if not item.name == "images"]
with hooks.register_temporarily([
("register_menu_item", menu_item_hook("Pages", "/pages/")),
("register_menu_item", menu_item_hook("Images", "/images/")),
("construct_menu", remove_images),
]):
rendered = menu.render_component(self.request)
self.assertEqual(
rendered,
[
sidebar.LinkMenuItem("pages", "Pages", "/pages/"),
],
)
