Move modal-workflow.js script to admin_base.html

The modal-workflow.js script is used across a wide range of views in the admin, it's simpler to include it globally instead of having to consider all places it may be used.

Also unblocks use cases that are outside of the core admin such as custom documents/user/image models that may want to leverage this functionality.

CHANGELOG.txt

@@ -31,6 +31,7 @@ Changelog
  * Maintenance: Merge `UploadedDocument` and `UploadedImage` into new `UploadedFile` model for easier shared code usage (Advik Kabra, Karl Hobley)
  * Maintenance: Optimize queries in dashboard panels (Sage Abdullah)
  * Maintenance: Optimize queries in group create/edit view (Sage Abdullah)
+ * Maintenance: Move modal-workflow.js script usage to base admin template instead of ad-hoc imports (Elhussein Almasri)
 
 
 6.0.1 (15.02.2024)

docs/releases/6.1.md

@@ -52,6 +52,7 @@ depth: 1
  * Merge `UploadedDocument` and `UploadedImage` into new `UploadedFile` model for easier shared code usage (Advik Kabra, Karl Hobley)
  * Optimize queries in dashboard panels (Sage Abdullah)
  * Optimize queries in group create/edit view (Sage Abdullah)
+ * Move modal-workflow.js script usage to base admin template instead of ad-hoc imports (Elhussein Almasri)
 
 
 ## Upgrade considerations

wagtail/admin/templates/wagtailadmin/admin_base.html

@@ -56,6 +56,7 @@
     <script src="{% versioned_static 'wagtailadmin/js/wagtailadmin.js' %}"></script>
     <script src="{% versioned_static 'wagtailadmin/js/telepath/telepath.js' %}"></script>
     <script src="{% versioned_static 'wagtailadmin/js/sidebar.js' %}"></script>
+    <script src="{% versioned_static 'wagtailadmin/js/modal-workflow.js' %}"></script>
 
     {% hook_output 'insert_global_admin_js' %}
 

wagtail/admin/templates/wagtailadmin/collections/edit.html

@@ -7,6 +7,5 @@
 
 {% block extra_js %}
     {{ block.super }}
-    <script src="{% versioned_static 'wagtailadmin/js/modal-workflow.js' %}"></script>
     <script src="{% versioned_static 'wagtailadmin/js/privacy-switch.js' %}"></script>
 {% endblock %}

wagtail/admin/templates/wagtailadmin/home/workflow_objects_to_moderate.html

@@ -89,7 +89,6 @@
         </table>
     {% endpanel %}
 
-    <script src="{% versioned_static 'wagtailadmin/js/modal-workflow.js' %}"></script>
     <script src="{% versioned_static 'wagtailadmin/js/workflow-action.js' %}"></script>
     <script>
         document.querySelectorAll('[data-controller="w-dropdown"]').forEach((e) => {

wagtail/admin/templates/wagtailadmin/pages/_editor_js.html

@@ -18,7 +18,6 @@
 <script src="{% versioned_static 'wagtailadmin/js/vendor/rangy-core.js' %}"></script>
 <script src="{% versioned_static 'wagtailadmin/js/vendor/mousetrap.min.js' %}"></script>
 <script src="{% versioned_static 'wagtailadmin/js/expanding-formset.js' %}"></script>
-<script src="{% versioned_static 'wagtailadmin/js/modal-workflow.js' %}"></script>
 <script src="{% versioned_static 'wagtailadmin/js/page-editor.js' %}"></script>
 <script src="{% versioned_static 'wagtailadmin/js/preview-panel.js' %}"></script>
 <script src="{% versioned_static 'wagtailadmin/js/privacy-switch.js' %}"></script>

wagtail/admin/templates/wagtailadmin/pages/index.html

@@ -23,8 +23,6 @@
 {% block extra_js %}
     {{ block.super }}
 
-    {% comment %} modal-workflow is required by the view restrictions interface {% endcomment %}
-    <script src="{% versioned_static 'wagtailadmin/js/modal-workflow.js' %}"></script>
     <script src="{% versioned_static 'wagtailadmin/js/privacy-switch.js' %}"></script>
 
     {% comment %}

wagtail/sites/templates/wagtailsites/create.html

@@ -1,7 +0,0 @@
-{% extends "wagtailadmin/generic/create.html" %}
-{% load wagtailadmin_tags %}
-
-{% block extra_js %}
-    {{ block.super }}
-    <script src="{% versioned_static 'wagtailadmin/js/modal-workflow.js' %}"></script>
-{% endblock %}

wagtail/sites/templates/wagtailsites/edit.html

@@ -1,7 +0,0 @@
-{% extends "wagtailadmin/generic/edit.html" %}
-{% load wagtailadmin_tags %}
-
-{% block extra_js %}
-    {{ block.super }}
-    <script src="{% versioned_static 'wagtailadmin/js/modal-workflow.js' %}"></script>
-{% endblock %}

wagtail/sites/tests.py

@@ -56,7 +56,6 @@ class TestSiteCreateView(AdminTemplateTestUtils, WagtailTestUtils, TestCase):
     def test_simple(self):
         response = self.get()
         self.assertEqual(response.status_code, 200)
-        self.assertTemplateUsed(response, "wagtailsites/create.html")
         self.assertBreadcrumbsNotRendered(response.content)
 
     def test_create(self):
@@ -201,7 +200,6 @@ class TestSiteEditView(AdminTemplateTestUtils, WagtailTestUtils, TestCase):
     def test_simple(self):
         response = self.get()
         self.assertEqual(response.status_code, 200)
-        self.assertTemplateUsed(response, "wagtailsites/edit.html")
         self.assertBreadcrumbsNotRendered(response.content)
 
         url_finder = AdminURLFinder(self.user)
@@ -396,7 +394,6 @@ class TestLimitedPermissions(WagtailTestUtils, TestCase):
     def test_get_create_view(self):
         response = self.client.get(reverse("wagtailsites:add"))
         self.assertEqual(response.status_code, 200)
-        self.assertTemplateUsed(response, "wagtailsites/create.html")
 
     def test_create(self):
         response = self.client.post(
@@ -418,7 +415,6 @@ class TestLimitedPermissions(WagtailTestUtils, TestCase):
         edit_url = reverse("wagtailsites:edit", args=(self.localhost.id,))
         response = self.client.get(edit_url)
         self.assertEqual(response.status_code, 200)
-        self.assertTemplateUsed(response, "wagtailsites/edit.html")
 
     def test_edit(self):
         edit_url = reverse("wagtailsites:edit", args=(self.localhost.id,))

wagtail/users/templates/wagtailusers/groups/includes/group_form_js.html

@@ -1,6 +1,5 @@
 {% load wagtailadmin_tags %}
 <script src="{% versioned_static 'wagtailadmin/js/expanding-formset.js' %}"></script>
-<script src="{% versioned_static 'wagtailadmin/js/modal-workflow.js' %}"></script>
 <script src="{% versioned_static 'wagtailusers/js/group-form.js' %}"></script>
 
 {{ form_media.js }}