Welcome to django-autocomplete-light’s documentation!¶

Features¶

This app fills all your ajax autocomplete needs:

global navigation autocomplete like on facebook
autocomplete widget for ModelChoiceField and ModelMultipleChoiceField
GenericForeignKey fully supported
django-generic-m2m support, yes that’s a generic M2M relation!
CharField autocomplete support, comma separated values, useful for tags field,
APIs powered autocomplete support, proposing results that are not (yet) in the database
0 hack required for admin integration, just use a form that uses the widget. It works exactly the same in the admin and in your pages.
no jQuery-ui required, the autocomplete script is as simple as possible,
optionnal autocomplete templating,
99% of the python logic is encapsulated in “autocomplete” classes, unlimited server side development possibilities
99% the javascript logic is encapsulated in an object, you can override any attribute or method, unlimited client side development possibilities
0 inline javascript you can load the javascript just before </body> for best page loading performance, wherever you want
add another also available outside the admin,
simple python, html and javascript, easy to hack, PEP8 compliant, tested

This is a simple alternative to django-ajax-selects.

You could subscribe to the mailing list ask questions or just be informed of package updates.

See test_project/README

Work in progress:

There is a convenience view to visualize the registry, login as staff, and open the autocomplete url, for example: /autocomplete_light/.

Ensure that:

jquery is loaded,
autocomplete_light/static.html is included once, it should load autocomplete.js, widget.js and style.css,
your form uses autocomplete_light widgets,
your channels are properly defined see /autocomplete/ if you included autocomplete_light.urls with prefix /autocomplete/.

If you don’t know how to debug, you should learn to use:

Firebug javascript debugger: Open the script tab, select a script, click on the left of the code to place a breakpoint
Ipdb python debugger: Install ipdb with pip, and place in your python code: import ipdb; ipdb.set_trace()

If you are able to do that, then you are a professional, enjoy autocomplete_light !!!

If you need help, open an issue on the github issues page.

Also, don’t hesitate to do pull requests !