Welcome to django-autocomplete-light’s documentation!¶
Features¶
Python 3.11–3.14 and Django 5.2–6.0+ support
Django (multiple) choice support,
Django (multiple) model choice support,
Django generic foreign key support (through django-querysetsequence),
Multiple widget support: native web component (
dal_alight), select2.js (dal_select2).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.
Resources¶
For Security issues, please contact security@<our github group name>.org
Basics¶
- Install
- Autocomplete-Light Frontend (dal_alight)
- Overview
- Install
- Create an autocomplete view
- Register the view
- Use the view in a Form widget
- Using autocompletes in the admin
- Using autocompletes outside the admin
- Creation of new choices
- Filtering results based on other form fields (forwarding)
- Autocompleting from a list of strings
- Grouped results
- Tags support
- Generic Foreign Key support
- Class reference
External app support¶
Migrating from Select2¶
- Migrating from dal_select2 to dal_alight
- Select2 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