mirrors/wagtail
mirrors/wagtail
0
0
Fork 0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-25 05:02:57 +01:00
Code Issues Releases Wiki Activity

Don't use legacy header when breadcrumbs are used

Browse Source
This commit is contained in:
Sage Abdullah 2023-12-14 16:37:55 +00:00 committed by Thibaud Colas
parent 5ede8a132d
commit 8a7dd1f5a1
10 changed files with 81 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
client/scss/components/_header.scss
View File

@ -11,7 +11,8 @@
margin: 0;
}
h1 {
h1,
.w-header__title {
@apply w-h1;
position: relative;
}

7
wagtail/admin/templates/wagtailadmin/generic/base.html
View File

@ -34,12 +34,13 @@
{% endfragment %}
{# Ensure all necessary variables are passed explicitly here #}
{# TODO: Pass `title=header_title` once slim_header and main_header are mutually exclusive (to prevent multiple h1) #}
{% include "wagtailadmin/shared/headers/slim_header.html" with breadcrumbs_items=breadcrumbs_items side_panels=side_panels history_url=history_url search_url=index_results_url search_form=search_form filters=filters actions=actions only %}
{% include "wagtailadmin/shared/headers/slim_header.html" with breadcrumbs_items=breadcrumbs_items side_panels=side_panels history_url=history_url title=header_title search_url=index_results_url search_form=search_form filters=filters actions=actions only %}
{% endif %}
{% endblock %}
{% block main_header %}
{% include "wagtailadmin/shared/header.html" with title=page_title subtitle=page_subtitle icon=header_icon only %}
{% if not breadcrumbs_items %}
{% include "wagtailadmin/shared/header.html" with title=page_title subtitle=page_subtitle icon=header_icon only %}
{% endif %}
{% endblock %}
{% endblock %}

12
wagtail/admin/templates/wagtailadmin/generic/form.html
View File

@ -2,6 +2,18 @@
{% load i18n wagtailadmin_tags %}
{% block bodyclass %}editor-view{% endblock %}
{% block main_header %}
{% if breadcrumbs_items %}
<div class="w-header nice-padding w-mt-8">
<h2 class="w-header__title" id="header-title">
{{ page_subtitle }}
</h2>
</div>
{% else %}
{{ block.super }}
{% endif %}
{% endblock %}
{% block main_content %}
{% block before_form %}{% endblock %}
<form action="{{ action_url }}" method="POST" novalidate{% if form.is_multipart %} enctype="multipart/form-data"{% endif %}>

8
wagtail/admin/templates/wagtailadmin/generic/index.html
View File

@ -16,12 +16,18 @@
{% endif %}
{% endblock %}
{% endfragment %}
{% include "wagtailadmin/shared/header.html" with title=page_title subtitle=page_subtitle action_url=header_action_url action_text=header_action_label action_icon=header_action_icon base_actions=base_actions extra_actions=extra_actions icon=header_icon search_url=search_url search_form=search_form search_results_url=index_results_url only %}
{% if not breadcrumbs_items %}
{% include "wagtailadmin/shared/header.html" with title=page_title subtitle=page_subtitle action_url=header_action_url action_text=header_action_label action_icon=header_action_icon base_actions=base_actions extra_actions=extra_actions icon=header_icon search_url=search_url search_form=search_form search_results_url=index_results_url only %}
{% endif %}
{% endblock %}
{% block listing %}
<div class="nice-padding{% if filters and not breadcrumbs_items %} filterable{% endif %}">
<div id="listing-results">
{% if breadcrumbs_items and locale %}
{# TODO: temporarily put the locale selector here since we no longer use the legacy header #}
{% include 'wagtailadmin/shared/locale_selector.html' with theme="large" %}
{% endif %}
{% include view.results_template_name|default:"wagtailadmin/generic/listing_results.html" %}
</div>
{% if filters and not breadcrumbs_items %}

4
wagtail/admin/templates/wagtailadmin/generic/listing.html
View File

@ -2,7 +2,9 @@
{% load i18n %}
{% block main_header %}
{% include "wagtailadmin/shared/header.html" with title=page_title subtitle=page_subtitle action_url=header_action_url action_text=header_action_label icon=header_icon only %}
{% if not breadcrumbs_items %}
{% include "wagtailadmin/shared/header.html" with title=page_title subtitle=page_subtitle action_url=header_action_url action_text=header_action_label icon=header_icon only %}
{% endif %}
{% endblock %}
{% block content %}

26
wagtail/admin/tests/viewsets/test_model_viewset.py
View File

@ -135,12 +135,9 @@ class TestTemplateConfiguration(WagtailTestUtils, TestCase):
response, "<p>Some extra custom content</p>", html=True
)
def test_wagtail_admin_template_mixin_variables(self):
def test_wagtail_admin_template_mixin_variables_with_legacy_header(self):
pk = quote(self.custom.pk)
cases = {
"index": ([], "Feature complete toys", None),
"add": ([], "New", "Feature complete toy"),
"edit": ([pk], "Editing", str(self.custom)),
"delete": ([pk], "Delete", str(self.custom)),
}
for view_name, (args, title, subtitle) in cases.items():
@ -161,6 +158,27 @@ class TestTemplateConfiguration(WagtailTestUtils, TestCase):
icon = h1.select_one("svg use[href='#icon-media']")
self.assertIsNotNone(icon)
def test_wagtail_admin_template_mixin_variables(self):
pk = quote(self.custom.pk)
cases = {
"index": ([], "Feature complete toys", None),
"add": ([], "New", "Feature complete toy"),
"edit": ([pk], "Editing", str(self.custom)),
}
for view_name, (args, title, subtitle) in cases.items():
with self.subTest(view_name=view_name):
response = self.client.get(self.get_custom_url(view_name, args=args))
soup = self.get_soup(response.content)
h1 = soup.select_one("h1")
expected_h1 = title
if subtitle:
expected_h1 = f"{title}: {subtitle}"
self.assertIsNotNone(h1)
self.assertEqual(h1.get_text(strip=True), expected_h1)
icon = h1.select_one("svg use[href='#icon-media']")
# Icon is no longer rendered in the h1 with the slim header in place
self.assertIsNone(icon)
class TestCustomColumns(WagtailTestUtils, TestCase):
def setUp(self):

27
wagtail/snippets/tests/test_snippets.py
View File

@ -352,9 +352,9 @@ class TestLocaleSelectorOnList(WagtailTestUtils, TestCase):
reverse("wagtailsnippets_snippetstests_translatablesnippet:add")
+ "?locale=en"
)
self.assertContains(
response, f'<a href="{add_url}" class="button bicolor button--icon">'
)
soup = self.get_soup(response.content)
add_button = soup.select_one(f'a[href="{add_url}"]')
self.assertIsNotNone(add_button)
self.assertContains(
response,
f'No translatable snippets have been created. Why not <a href="{add_url}">add one</a>',
@ -370,9 +370,9 @@ class TestLocaleSelectorOnList(WagtailTestUtils, TestCase):
# Check that the add URLs don't include the locale
add_url = reverse("wagtailsnippets_snippetstests_translatablesnippet:add")
self.assertContains(
response, f'<a href="{add_url}" class="button bicolor button--icon">'
)
soup = self.get_soup(response.content)
add_button = soup.select_one(f'a[href="{add_url}"]')
self.assertIsNotNone(add_button)
self.assertContains(
response,
f'No translatable snippets have been created. Why not <a href="{add_url}">add one</a>',
@ -385,9 +385,9 @@ class TestLocaleSelectorOnList(WagtailTestUtils, TestCase):
# Check that the add URLs don't include the locale
add_url = reverse("wagtailsnippets_tests_advert:add")
self.assertContains(
response, f'<a href="{add_url}" class="button bicolor button--icon">'
)
soup = self.get_soup(response.content)
add_button = soup.select_one(f'a[href="{add_url}"]')
self.assertIsNotNone(add_button)
self.assertContains(
response,
f'No adverts have been created. Why not <a href="{add_url}">add one</a>',
@ -4271,11 +4271,10 @@ class TestSnippetHistory(WagtailTestUtils, TestCase):
html=True,
)
# Should use the latest draft title in the header subtitle
self.assertContains(
response,
'<span class="w-header__subtitle">Draft-enabled Bar, In Draft</span>',
)
soup = self.get_soup(response.content)
sublabel = soup.select_one(".w-breadcrumbs__sublabel")
# Should use the latest draft title in the breadcrumbs sublabel
self.assertEqual(sublabel.get_text(strip=True), "Draft-enabled Bar, In Draft")
@override_settings(WAGTAIL_I18N_ENABLED=True)
def test_get_with_i18n_enabled(self):

9
wagtail/snippets/tests/test_usage.py
View File

@ -68,11 +68,10 @@ class TestSnippetUsageView(WagtailTestUtils, TestCase):
)
)
# Should use the latest draft title in the header subtitle
self.assertContains(
response,
'<span class="w-header__subtitle">Draft-enabled Bar, In Draft</span>',
)
soup = self.get_soup(response.content)
sublabel = soup.select_one(".w-breadcrumbs__sublabel")
# Should use the latest draft title in the breadcrumbs sublabel
self.assertEqual(sublabel.get_text(strip=True), "Draft-enabled Bar, In Draft")
def test_usage(self):
# resave so that usage count gets updated

22
wagtail/snippets/tests/test_viewset.py
View File

@ -69,6 +69,8 @@ class BaseSnippetViewSetTests(WagtailTestUtils, TestCase):
class TestCustomIcon(BaseSnippetViewSetTests):
# TODO: decide what to do with this test, since the new designs after
# Universal Listings and unified breadcrumbs/header don't have icons
model = FullFeaturedSnippet
def setUp(self):
@ -82,11 +84,13 @@ class TestCustomIcon(BaseSnippetViewSetTests):
def test_get_views(self):
pk = quote(self.object.pk)
views = [
("list", []),
# TODO: Some of these views have been migrated to use the slim_header
# only, so there is no header_icon anymore.
# ("list", []),
("add", []),
("edit", [pk]),
("delete", [pk]),
("usage", [pk]),
# ("usage", [pk]),
("unpublish", [pk]),
("workflow_history", [pk]),
("revisions_revert", [pk, self.revision_1.id]),
@ -99,18 +103,16 @@ class TestCustomIcon(BaseSnippetViewSetTests):
self.assertEqual(response.status_code, 200)
self.assertEqual(response.context["header_icon"], "cog")
self.assertContains(response, "icon icon-cog", count=1)
# TODO: Make the list view use the shared header template
if view_name != "list":
self.assertTemplateUsed(response, "wagtailadmin/shared/header.html")
self.assertTemplateUsed(response, "wagtailadmin/shared/header.html")
def test_get_history(self):
response = self.client.get(self.get_url("history", [quote(self.object.pk)]))
self.assertEqual(response.status_code, 200)
self.assertTemplateUsed(response, "wagtailadmin/shared/header.html")
# History view icon is not configurable for consistency with pages
self.assertEqual(response.context["header_icon"], "history")
self.assertContains(response, "icon icon-history")
self.assertNotContains(response, "icon icon-cog")
self.assertTemplateUsed(
response,
"wagtailadmin/shared/headers/slim_header.html",
)
self.assertTemplateNotUsed(response, "wagtailadmin/shared/header.html")
def test_get_workflow_history_detail(self):
# Assign default workflow to the snippet model

2
wagtail/snippets/views/snippets.py
View File

@ -845,6 +845,7 @@ class SnippetViewSet(ModelViewSet):
workflow_history_detail_url_name=self.get_url_name(
"workflow_history_detail"
),
_show_breadcrumbs=False,
)
@property
@ -858,6 +859,7 @@ class SnippetViewSet(ModelViewSet):
object_icon=self.icon,
header_icon="list-ul",
workflow_history_url_name=self.get_url_name("workflow_history"),
_show_breadcrumbs=False,
)
@property