Welcome to django-autocomplete-light’s documentation!

https://secure.travis-ci.org/yourlabs/django-autocomplete-light.png?branch=master https://pypip.in/d/django-autocomplete-light/badge.png https://pypip.in/v/django-autocomplete-light/badge.png https://coveralls.io/repos/yourlabs/django-autocomplete-light/badge.png

django-autocomplete-light’s purpose is to enable autocompletes quickly and properly in a django project: it is the fruit of years of R&D. It was designed for Django so that every part overridable or reusable independently. It is stable, tested, documented and fully supported: it tries to be a good neighbour in Django ecosystem.

Features

Features include:

  • charfield, foreign key, many to many autocomplete widgets,
  • generic foreign key, generic many to many autocomplete widgets,
  • remote API backed-autocompletes,
  • django template engine support for autocompletes, enabling you to include images etc ...
  • 100% overridable HTML, CSS, Python and Javascript: there is no variable hidden far down in the scope anywhere.
  • add-another popup supported outside the admin too.
  • keyboard is supported with enter, tab and arrows by default.

Each feature has a live example and is fully documented. It is also designed and documented so that you create your own awesome features too.

v2

v2 branch is under active development.

You might want to use that instead, since it’s much easier to work with and supports python3.

In this case, please refer to the v2 documentation.

To upgrade to v2, inherit from autocomplete_light.ModelForm and remove calls to get_widgets_dict. Optionnaly remove all old widget definitions.

Demo

You can run test projects for a local demo in a temporary virtualenv.

Upgrade

Run pip install -U django-autocomplete-light. Check the CHANGELOG for BC (Backward Compatibility) breaks. There should be none for minor version upgrades ie. from 1.1.3 to 1.1.22.

Tutorial

Learn the concepts by doing useful things.

You should now fully understand the concepts and be able to do literally what you want.

Indices and tables