Add basic chooser modal views

wagtail/admin/templates/wagtailadmin/generic/chooser/chooser.html

@@ -0,0 +1,17 @@
+{% load i18n wagtailadmin_tags %}
+{% include "wagtailadmin/shared/header.html" with title=page_title merged=1 icon=icon %}
+
+<div class="w-tabs" data-tabs data-tabs-disable-url>
+    <div class="tab-content nice-padding">
+        <section
+            id="tab-search"
+            class="w-tabs__panel"
+            role="tabpanel"
+            aria-labelledby="tab-label-search"
+        >
+            <div id="search-results" class="listing documents">
+                {% include "wagtailadmin/generic/chooser/results.html" %}
+            </div>
+        </section>
+    </div>
+</div>

wagtail/admin/templates/wagtailadmin/generic/chooser/results.html

@@ -0,0 +1,4 @@
+{% load i18n wagtailadmin_tags %}
+
+{% component table %}
+{% include "wagtailadmin/shared/pagination_nav.html" with items=results linkurl=results_url_name %}

wagtail/admin/views/generic/chooser.py

@@ -0,0 +1,153 @@
+from django.contrib.admin.utils import quote, unquote
+from django.core.exceptions import ObjectDoesNotExist
+from django.core.paginator import Paginator
+from django.http import Http404
+from django.template.response import TemplateResponse
+from django.urls import reverse
+from django.utils.translation import gettext as _
+from django.views.generic.base import ContextMixin, View
+
+from wagtail.admin.modal_workflow import render_modal_workflow
+from wagtail.admin.ui.tables import Table, TitleColumn
+
+
+class ModalPageFurnitureMixin(ContextMixin):
+    """
+    Add icon and page title to the template context
+    """
+
+    icon = None
+    page_title = None
+
+    def get_context_data(self, **kwargs):
+        context = super().get_context_data(**kwargs)
+        context.update(
+            {
+                "icon": self.icon,
+                "page_title": self.page_title,
+            }
+        )
+        return context
+
+
+class BaseChooseView(ModalPageFurnitureMixin, ContextMixin, View):
+    model = None
+    per_page = 10
+    chosen_url_name = None
+    results_url_name = None
+    icon = "snippet"
+    page_title = _("Choose")
+
+    def get_object_list(self):
+        return self.model.objects.all()
+
+    def get(self, request):
+        objects = self.get_object_list()
+        paginator = Paginator(objects, per_page=self.per_page)
+        self.results = paginator.get_page(request.GET.get("p"))
+
+        columns = [
+            TitleColumn(
+                "title",
+                label=_("Title"),
+                accessor=str,
+                url_name=self.chosen_url_name,
+                link_attrs={"data-chooser-modal-choice": True},
+            ),
+        ]
+
+        self.table = Table(columns, self.results)
+
+        return self.render_to_response()
+
+    def get_context_data(self, **kwargs):
+        context = super().get_context_data(**kwargs)
+        context.update(
+            {
+                "results": self.results,
+                "table": self.table,
+                "results_url_name": self.results_url_name,
+            }
+        )
+        return context
+
+    def render_to_response(self):
+        raise NotImplementedError()
+
+
+class ChooseView(BaseChooseView):
+    def render_to_response(self):
+        return render_modal_workflow(
+            self.request,
+            "wagtailadmin/generic/chooser/chooser.html",
+            None,
+            self.get_context_data(),
+            json_data={
+                "step": "choose",
+            },
+        )
+
+
+class ChooseResultsView(BaseChooseView):
+    def render_to_response(self):
+        return TemplateResponse(
+            self.request,
+            "wagtailadmin/generic/chooser/results.html",
+            self.get_context_data(),
+        )
+
+
+class ChosenView(View):
+    model = None
+    edit_item_url_name = None
+
+    def get(self, request, pk):
+        try:
+            item = self.get_object(unquote(pk))
+        except ObjectDoesNotExist:
+            raise Http404
+
+        return self.get_chosen_response(item)
+
+    def get_object(self, pk):
+        return self.model.objects.get(pk=pk)
+
+    def get_object_id(self, instance):
+        return instance.pk
+
+    def get_object_string(self, instance):
+        """
+        Return a string representation of the given object instance
+        """
+        return str(instance)
+
+    def get_edit_item_url(self, instance):
+        if self.edit_item_url_name is None:
+            return None
+        else:
+            object_id = self.get_object_id(instance)
+            return reverse(self.edit_item_url_name, args=(quote(object_id),))
+
+    def get_chosen_response_data(self, item):
+        """
+        Generate the result value to be returned when an object has been chosen
+        """
+        return {
+            "id": str(self.get_object_id(item)),
+            "string": self.get_object_string(item),
+            "edit_link": self.get_edit_item_url(item),
+        }
+
+    def get_chosen_response(self, item):
+        """
+        Return the HTTP response to indicate that an object has been chosen
+        """
+        response_data = self.get_chosen_response_data(item)
+
+        return render_modal_workflow(
+            self.request,
+            None,
+            None,
+            None,
+            json_data={"step": "chosen", "result": response_data},
+        )