Refactored sorting JS files to be includes so that server-side variables may be passed to them.

Added 'after_sorting_js_callback_name' attribute to SortableAdminBase.
Added callback to be executed after sorting for each of the possible sorting scenarios.
Added custom template examples to add a callback to be executed when sorting is finished.

adminsortable/admin.py

@@ -32,6 +32,8 @@ class SortableAdminBase(object):
     change_form_template_extends = 'admin/change_form.html'
     change_list_template_extends = 'admin/change_list.html'
 
+    after_sorting_js_callback_name = None
+
     def changelist_view(self, request, extra_context=None):
         """
         If the model that inherits Sortable has more than one object,
@@ -215,7 +217,8 @@ class SortableAdmin(SortableAdminBase, ModelAdmin):
             'sortable_by_class_is_sortable': sortable_by_class_is_sortable,
             'sortable_by_class_display_name': sortable_by_class_display_name,
             'jquery_lib_path': jquery_lib_path,
-            'csrf_cookie_name': getattr(settings, 'CSRF_COOKIE_NAME', 'csrftoken')
+            'csrf_cookie_name': getattr(settings, 'CSRF_COOKIE_NAME', 'csrftoken'),
+            'after_sorting_js_callback_name': self.after_sorting_js_callback_name
         })
         return render(request, self.sortable_change_list_template, context)
 
@@ -238,7 +241,8 @@ class SortableAdmin(SortableAdminBase, ModelAdmin):
             'change_form_template_extends': self.change_form_template_extends,
             'has_sortable_tabular_inlines': self.has_sortable_tabular_inlines,
             'has_sortable_stacked_inlines': self.has_sortable_stacked_inlines,
-            'csrf_cookie_name': getattr(settings, 'CSRF_COOKIE_NAME', 'csrftoken')
+            'csrf_cookie_name': getattr(settings, 'CSRF_COOKIE_NAME', 'csrftoken'),
+            'after_sorting_js_callback_name': self.after_sorting_js_callback_name
         })
 
         return super(SortableAdmin, self).change_view(request, object_id,

adminsortable/templates/adminsortable/admin.sortable.html

@@ -1,3 +1,4 @@
+<script>
   (function($){
 
     $(function() {
@@ -36,6 +37,11 @@
                         });
 
                         ui.item.effect('highlight', {}, 1000);
+
+                        {% if after_sorting_js_callback_name %}
+                        {# if a callback is defined in a custom template, execute it #}
+                        window['{{ after_sorting_js_callback_name }}']();
+                        {% endif %}
                     }
                 });
             }
@@ -45,3 +51,4 @@
     });
 
   })(django.jQuery);
+</script>

adminsortable/templates/adminsortable/change_form.html

@@ -7,17 +7,17 @@
     {% url 'admin:jsi18n' as jsi18nurl %}
 
     {% if has_sortable_tabular_inlines or has_sortable_stacked_inlines %}
-        <script type="text/javascript" src="{% static 'adminsortable/js/jquery-ui-django-admin.min.js' %}"></script>
+        <script src="{% static 'adminsortable/js/jquery-ui-django-admin.min.js' %}"></script>
         <script src="{% static 'adminsortable/js/jquery.ui.touch-punch.min.js' %}"></script>
         {% include 'adminsortable/csrf/jquery.django-csrf.html' with csrf_cookie_name=csrf_cookie_name %}
     {% endif %}
 
     {% if has_sortable_tabular_inlines %}
-        <script type="text/javascript" src="{% static 'adminsortable/js/admin.sortable.tabular.inlines.js' %}"></script>
+        {% include 'adminsortable/edit_inline/admin.sortable.stacked.inlines.html' with after_sorting_js_callback_name=after_sorting_js_callback_name %}
     {% endif %}
 
     {% if has_sortable_stacked_inlines %}
-        <script type="text/javascript" src="{% static 'adminsortable/js/admin.sortable.stacked.inlines.js' %}"></script>
+        {% include 'adminsortable/edit_inline/admin.sortable.tabular.inlines.html' with after_sorting_js_callback_name=after_sorting_js_callback_name %}
     {% endif %}
 {% endblock %}
 

adminsortable/templates/adminsortable/change_list.html

@@ -21,14 +21,31 @@
 {% endblock %}
 
 {% block extrahead %}
-{{ block.super }}
-{{ media.js }}
 <script src="{% static jquery_lib_path %}"></script>
 <script src="{% static 'admin/js/jquery.init.js' %}"></script>
+{{ block.super }}
+{{ media.js }}
 <script src="{% static 'adminsortable/js/jquery-ui-django-admin.min.js' %}"></script>
 <script src="{% static 'adminsortable/js/jquery.ui.touch-punch.min.js' %}"></script>
 {% include 'adminsortable/csrf/jquery.django-csrf.html' with csrf_cookie_name=csrf_cookie_name %}
-<script src="{% static 'adminsortable/js/admin.sortable.js' %}"></script>
+{% include 'adminsortable/admin.sortable.html' with after_sorting_js_callback_name=after_sorting_js_callback_name %}
+
+<script type="text/javascript">
+(function($) {
+    $(document).ready(function($) {
+        var url = window.location.href;
+        var urlParts = url.split('?');
+        var changeListUrl = $('a#return-to-changelist').attr('href');
+
+        if (urlParts.length === 2) {
+            $('a#return-to-changelist').attr(
+                'href',
+                changeListUrl + '?' + urlParts[1].replace('filter_expression=', '')
+            );
+        }
+    });
+})(django.jQuery);
+</script>
 {% endblock %}
 
 {% block bodyclass %}{{ block.super }} app-{{ opts.app_label }} model-{{ opts.model_name }} change-list{% endblock %}

adminsortable/templates/adminsortable/edit_inline/admin.sortable.stacked.inlines.html

@@ -1,3 +1,4 @@
+<script>
   (function($){
 
     $(function() {
@@ -60,6 +61,11 @@
                             });
 
                             ui.item.find(highlightedSelector).effect('highlight', {}, 1000);
+
+                            {% if after_sorting_js_callback_name %}
+                            {# if a callback is defined in a custom template, execute it #}
+                            window['{{ after_sorting_js_callback_name }}']();
+                            {% endif %}
                         }
                     });
                 }
@@ -68,3 +74,5 @@
     });
 
     })(django.jQuery);
+
+</script>

adminsortable/templates/adminsortable/edit_inline/admin.sortable.tabular.inlines.html

@@ -1,3 +1,4 @@
+<script>
   (function($){
 
     $(function() {
@@ -59,6 +60,11 @@
                             tabular_inline_rows.removeClass('row1 row2');
                             $('.tabular table tbody tr:odd').addClass('row2');
                             $('.tabular table tbody tr:even').addClass('row1');
+
+                            {% if after_sorting_js_callback_name %}
+                            {# if a callback is defined in a custom template, execute it #}
+                            window['{{ after_sorting_js_callback_name }}']();
+                            {% endif %}
                         }
                     });
                 }
@@ -67,3 +73,5 @@
     });
 
     })(django.jQuery);
+
+</script>

sample_project/samples/admin.py

@@ -83,6 +83,9 @@ class ProjectAdmin(SortableAdmin):
         NonSortableCreditInline, NonSortableNoteInline
     ]
     list_display = ['__str__', 'category']
+    after_sorting_js_callback_name = 'afterSortCallback'
+    sortable_change_list_template = 'adminsortable/custom_change_list.html'
+    sortable_change_form_template = "adminsortable/custom_change_form.html"
 
 admin.site.register(Project, ProjectAdmin)
 

sample_project/templates/adminsortable/custom_change_form.html

@@ -0,0 +1,15 @@
+{% extends "adminsortable/change_form.html" %}
+
+{% block extrahead %}
+  {{ block.super }}
+
+  <script>
+    django.jQuery(document).on('order:changed', function(event) {
+      console.log(event.message);
+    });
+
+    window['{{ after_sorting_js_callback_name }}'] = function() {
+      django.jQuery(document).trigger({ type: 'order:changed', message: 'Order changed', time: new Date() });
+    };
+  </script>
+{% endblock %}

sample_project/templates/adminsortable/custom_change_list.html

@@ -0,0 +1,15 @@
+{% extends 'adminsortable/change_list.html' %}
+
+{% block extrahead %}
+  {{ block.super }}
+
+  <script>
+    django.jQuery(document).on('order:changed', function(event) {
+      console.log(event.message);
+    });
+
+    window['{{ after_sorting_js_callback_name }}'] = function() {
+      django.jQuery(document).trigger({ type: 'order:changed', message: 'Order changed', time: new Date() });
+    };
+  </script>
+{% endblock %}