fix #397: Django popup when using list action

Author: jrief

.github/workflows/publish.yml

@@ -34,14 +34,17 @@ jobs:
       run: |
         npm run build
         npm run build -- --debug
-    - name: Patch templates
+    - name: Patch Django templates and JavaScript files
       run: |
+        mkdir -p adminsortable2/static/adminsortable2/js
         mkdir -p adminsortable2/templates/adminsortable2/edit_inline
-        DJANGO_VERSIONS=("4.2" "5.0" "5.1" "5.2")
+        DJANGO_VERSIONS=("4.2" "5.0" "5.1" "5.2" "6.0")
         for django_version in ${DJANGO_VERSIONS[@]}; do
           echo $django_version
+          curl --silent --output adminsortable2/static/adminsortable2/js/actions-$django_version.js https://raw.githubusercontent.com/django/django/stable/$django_version.x/django/contrib/admin/static/admin/js/actions.js
           curl --silent --output adminsortable2/templates/adminsortable2/edit_inline/stacked-django-$django_version.html https://raw.githubusercontent.com/django/django/stable/$django_version.x/django/contrib/admin/templates/admin/edit_inline/stacked.html
           curl --silent --output adminsortable2/templates/adminsortable2/edit_inline/tabular-django-$django_version.html https://raw.githubusercontent.com/django/django/stable/$django_version.x/django/contrib/admin/templates/admin/edit_inline/tabular.html
+          patch -p0 adminsortable2/static/adminsortable2/js/actions-$django_version.js patches/actions-django-5.2.patch
           patch -p0 adminsortable2/templates/adminsortable2/edit_inline/stacked-django-$django_version.html patches/stacked-django-4.0.patch
           patch -p0 adminsortable2/templates/adminsortable2/edit_inline/tabular-django-$django_version.html patches/tabular-django-4.0.patch
         done

.github/workflows/tests.yml

@@ -60,14 +60,17 @@ jobs:
     - name: Build Client
       run: |
         npm run build
-    - name: Patch templates
+    - name: Patch Django templates and JavaScript files
       run: |
+        mkdir -p adminsortable2/static/adminsortable2/js
         mkdir -p adminsortable2/templates/adminsortable2/edit_inline
-        DJANGO_VERSIONS=("4.2" "5.0" "5.1" "5.2")
+        DJANGO_VERSIONS=("4.2" "5.0" "5.1" "5.2" "6.0")
         for django_version in ${DJANGO_VERSIONS[@]}; do
           echo $django_version
+          curl --silent --output adminsortable2/static/adminsortable2/js/actions-$django_version.js https://raw.githubusercontent.com/django/django/stable/$django_version.x/django/contrib/admin/static/admin/js/actions.js
           curl --silent --output adminsortable2/templates/adminsortable2/edit_inline/stacked-django-$django_version.html https://raw.githubusercontent.com/django/django/stable/$django_version.x/django/contrib/admin/templates/admin/edit_inline/stacked.html
           curl --silent --output adminsortable2/templates/adminsortable2/edit_inline/tabular-django-$django_version.html https://raw.githubusercontent.com/django/django/stable/$django_version.x/django/contrib/admin/templates/admin/edit_inline/tabular.html
+          patch -p0 adminsortable2/static/adminsortable2/js/actions-$django_version.js patches/actions-django-5.2.patch
           patch -p0 adminsortable2/templates/adminsortable2/edit_inline/stacked-django-$django_version.html patches/stacked-django-4.0.patch
           patch -p0 adminsortable2/templates/adminsortable2/edit_inline/tabular-django-$django_version.html patches/tabular-django-4.0.patch
         done

.gitignore

@@ -18,5 +18,6 @@ dist
 node_modules/
 workdir/*
 htmlcov
+adminsortable2/static/adminsortable2/js/actions-*
 adminsortable2/static/adminsortable2/js/adminsortable2.*
 adminsortable2/templates/adminsortable2/edit_inline

adminsortable2/admin.py

@@ -81,9 +81,16 @@ class MovePageActionForm(admin.helpers.ActionForm):
 class SortableAdminBase:
     @property
     def media(self):
-        css = {'all': ['adminsortable2/css/sortable.css']}
-        js = ['adminsortable2/js/adminsortable2{}.js'.format('' if settings.DEBUG else '.min')]
-        return super().media + widgets.Media(css=css, js=js)
+        media = super().media
+        css = dict(media._css)
+        css.setdefault('all', [])
+        css['all'].append('adminsortable2/css/sortable.css')
+        js = list(media._js)
+        # replace actions.js with our patched version until https://code.djangoproject.com/ticket/36757 is fixed
+        if 'admin/js/actions.js' in js:
+            js[js.index('admin/js/actions.js')] = 'adminsortable2/js/actions-{0}.{1}.js'.format(*DJANGO_VERSION)
+        js.append('adminsortable2/js/adminsortable2{}.js'.format('' if settings.DEBUG else '.min'))
+        return widgets.Media(css=css, js=js)
 
     def get_formset_kwargs(self, request, obj, inline, prefix):
         formset_params = super().get_formset_kwargs(request, obj, inline, prefix)

client/admin-sortable2.ts

@@ -48,9 +48,11 @@ class ListSortable {
 			this.firstOrder = parseInt(firstOrder);
 			this.orderDirection = parseInt(lastOrder) > this.firstOrder ? 1 : -1;
 		}
+		this.tableBody.classList.add('ignore-list-changes');
 	}
 
 	private async onEnd(evt: SortableEvent) {
+		this.tableBody.classList.remove('ignore-list-changes');
 		if (typeof evt.newIndex !== 'number' || typeof evt.oldIndex !== 'number'
 			|| typeof this.firstOrder !== 'number'|| typeof this.orderDirection !== 'number'
 			|| !(evt.item instanceof HTMLTableRowElement))

patches/actions-django-5.2.patch

@@ -0,0 +1,11 @@
+--- django/contrib/admin/static/admin/js/actions.js
++++ adminsortable2/static/adminsortable2/js/actions.js
+@@ -151,7 +151,7 @@
+                     updateCounter(actionCheckboxes, options);
+                     lastChecked = target;
+                 } else {
+-                    list_editable_changed = true;
++                    list_editable_changed = !target.classList.contains('ignore-list-changes');
+                 }
+             });
+         });