replace SelectFilter2.js with a jQuery plugin

[Nick Sandford]

I needed to extend the functionality of the select filter, so I rewrote it in jQuery. I noticed a discussion about replacing some of the admin javascript with jQuery, so this is a first attempt at replacing SelectFilter2.js with jquery.selectfilter.js.

Discussion is here: ​http://groups.google.com/group/django-developers/browse_thread/thread/ff460085a3bfb12e/2c4e6f5a9807c19b?lnk=gst&q=jquery#2c4e6f5a9807c19b

[anonymous]

This needs to be reviewed by someone with better JS-foo than I have, but two initial impressions:

1. The instantiation code (widgets.py) looks a lot more complex -- is there any way to clean up that interface?
2. The widget.py code also contains a TODO. If we're refactoring in this area, it's a prime opportunity to do that cleanup.

[Russell Keith-Magee]

Oops - that was me.

[Nick Sandford]

The instantiation code could probably be a bit cleaner without the anonymous function, but it won't change it too much. It was mostly to avoid typing django.jQuery(etc..) twice (once for the document.ready and a second time for invoking the plugin)..

I'll upload a patch to fix the TODO shortly. Cheers.

[Nick Sandford]

I think BoundField has an auto_id property but I'm not sure how to go about using it, so I'm hoping the approach I took was ok (using attrs.get('id', 'id_%s' % name) ).

[dbunskoek]

I updated the original patch so it will apply cleanly to trunk, and also made some improvements:

Improved coding-style

• moved from leading spaces to tabs
• removed trailing comma's (fixes IE support)

Usability improvements

• removed inconsistent 'wrap-around' functionality in selects
• also allow moving back from 'selected' to 'choices'
• only allow moving with right or left key when the layout is horizontal (it doesn't make sense when layout is vertical)
• fixed keyboard shortcuts (didn't work at all in the trunk version)

I tested it all in IE7, IE8, FF4, Safari, Chrome, and it works like a charm.

[Idan Gazit]

This looks good to me, but I also lack the JS-foo to vet every line of the JS.

This would be an excellent candidate for figuring out a more standardized means of testing. Could be QUnit, could be Selenium, could be both. I'd feel more comfortable with JS changes like these if I had a test suite to run on them.

[Jannis Leidel]

FWIW, selenium tests have now landed in the admin, so this should be much easier to test.

[Julien Phalip]

Quick note: some tests were added in r17579.

[Julien Phalip]

FYI, while working on #13614, I've used the latest patch from here and brought it up to date with current trunk.

[Julien Phalip]

We'll do this shortly after 1.4 gets released, based on the patch in #13614.

[Tim Graham]

I closed #3202 as a duplicate which points out the inability of the current implementation to handle large lists. We should make sure new solution improves this.

[Tim Graham]

​PR 4701 is the latest effort on this if someone is interested in updating it.

[Collin Anderson]

This is basically fixed now that we can use select2 for many-to-many fields. Once it's been around for a while we could try changing UserAdmin to use select2 by default instead of SelectFilter2.js.