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 innovative 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.
Roadmap¶
- DAL < 4 supports Python 2 and 3 and Django 1.8 to 3.x
- DAL 4 supports Django 3.x and 4.x and Python 3
- DAL >= 3.9 offers a modern alternative to select2
Resources¶
- **Documentation** graciously hosted by RTFD
- 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,
Basics¶
- Install django-autocomplete-light v3
- 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
- Listening for the initialization of a specific input
- Creation of new choices in the autocomplete form
- Filtering results based on the value of other fields in the form
- Building blocks for custom logic
- Autocompleting based on a List of Strings
External app support¶
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