Welcome to django-autocomplete-light’s documentation!

Features

• Python 2.7, 3.4, Django 2.0+ support (Django 1.11 (LTS), is supported until django-autocomplete-light-3.2.10),
• Django (multiple) choice support,
• Django (multiple) model choice support,
• Django generic foreign key support (through django-querysetsequence),
• Django generic many to many relation support (through django-generic-m2m and django-gm2m)
• Multiple widget support: select2.js, easy to add more.
• Creating choices that don’t exist in the autocomplete,
• Offering choices that depend on other fields in the form, in an elegant and innovant way,
• Dynamic widget creation (ie. inlines), supports YOUR custom scripts too,
• Provides a test API for your awesome autocompletes, to support YOUR custom use cases too,
• A documented, automatically tested example for each use case in test_project.

Upgrading

See CHANGELOG..

For v2 users and experts, a blog post was published with plenty of details.

Resources

• **Live demo** graciously hosted by Repl.it
• **Documentation** graciously hosted by RTFD
• Video demo graciously hosted by Youtube,
• Mailing list graciously hosted by Google
• For Security issues, please contact yourlabs-security@googlegroups.com
• Git graciously hosted by GitHub,
• Package graciously hosted by PyPi,
• Continuous integration graciously hosted by Travis-ci
• **Online paid support** provided via HackHands,

Basics

• Install django-autocomplete-light v3
  • Install in your project
  • Configuration
  • Install the demo project
• django-autocomplete-light tutorial
  • Overview
  • Create an autocomplete view
  • Register the autocomplete view
  • Use the view in a Form widget
  • Passing options to select2
  • Using autocompletes in the admin
  • Using autocompletes outside the admin
  • Displaying results using custom HTML
  • Displaying selected result differently than in list
  • Overriding javascript code
  • Creation of new choices in the autocomplete form
  • Filtering results based on the value of other fields in the form
• Types of forwarded values
• Building blocks for custom logic
  • Autocompleting based on a List of Strings

External app support

• Autocompletion for GenericForeignKey
  • Model example
  • Form example
  • Register the view for the form
• Autocompletion for django-gm2m’s GM2MField
  • Model example
  • View example
  • Form example
• Autocompletion for django-generic-m2m’s RelatedObjectsDescriptor
  • Model example
  • View example
  • Form example
• Autocompletion for django-tagging’s TagField
  • Model example
  • View example
  • Form example
• Autocompletion for django-taggit’s TaggableManager
  • Model example
  • View example
  • Form example

API

• dal: django-autocomplete-light3 API
• FutureModelForm
• dal_select2: Select2 support for DAL
• dal_contenttypes: GenericForeignKey support
• dal_select2_queryset_sequence: Select2 for QuerySetSequence choices
• dal_queryset_sequence: QuerySetSequence choices
• dal_gm2m_queryset_sequence
• dal_genericm2m_queryset_sequence
• dal_gm2m: django-gm2m support
• dal_genericm2m: django-genericm2m support
• dal_select2_taggit: django-taggit support
• dal_select2_tagging: django-tagging support

Indices and tables

• Index
• Module Index
• Search Page