{% endblock %}
{% block footer %}
{{ form.media }}
{% endblock %}
```
--------------------------------
### Autocomplete Form with GenericForeignKeyModelField and Custom Widgets
Source: https://github.com/yourlabs/django-autocomplete-light/blob/master/docs/gfk.md
Uses FutureModelForm and GenericForeignKeyModelField with custom widgets and views for GenericForeignKey autocompletion. This provides more control over the widget and view implementation.
```python
from dal import autocomplete
class TestForm(autocomplete.FutureModelForm):
location = autocomplete.GenericForeignKeyModelField(
model_choice=[(Country,), (City,)], # Models
widget=autocomplete.QuerySetSequenceAlight,
view=autocomplete.AlightQuerySetSequenceView,
)
class Meta:
model = TestModel
```
--------------------------------
### Widget for List Autocomplete
Source: https://github.com/yourlabs/django-autocomplete-light/blob/master/docs/alight.md
Use ListAlight widget in your form, specifying the URL where the autocomplete view is registered.
```python
widget = autocomplete.ListAlight(url='fruit-autocomplete')
```
--------------------------------
### List-based Grouped Results
Source: https://github.com/yourlabs/django-autocomplete-light/blob/master/docs/alight.md
Use AlightGroupListView for grouping string lists. The get_list method should return pairs of (group_name, item). Items with group=None are displayed without a header.
```python
class FruitAutocomplete(autocomplete.AlightGroupListView):
def get_list(self):
return [
('Tropical', 'mango'),
('Tropical', 'papaya'),
('Temperate', 'apple'),
('Temperate', 'pear'),
]
```
--------------------------------
### Form Field for List Creation
Source: https://github.com/yourlabs/django-autocomplete-light/blob/master/docs/alight.md
Use AlightListCreateChoiceField in the form to enable creating new values that are not in the initial choice list. This ensures submitted values pass validation.
```python
from dal import autocomplete
class FruitForm(forms.ModelForm):
fruit = autocomplete.AlightListCreateChoiceField(
choice_list=['apple', 'mango', 'apricot', 'orange'],
widget=autocomplete.ListAlight(url='fruit-autocomplete'),
)
```
--------------------------------
### Automate FormField with djhacker and ModelAlight
Source: https://github.com/yourlabs/django-autocomplete-light/blob/master/docs/alight.md
Utilize the djhacker library to automatically configure a form field with the ModelAlight widget. This is useful for integrating autocompletion into existing Django models without modifying the forms directly.
```python
import djhacker # pip install djhacker
from django import forms
djhacker.formfield(
Person.birth_country,
forms.ModelChoiceField,
widget=autocomplete.ModelAlight(url='country-autocomplete')
)
```
--------------------------------
### Registering Auto-Generated URLs
Source: https://github.com/yourlabs/django-autocomplete-light/blob/master/docs/alight.md
Register the auto-generated URLs for the form using its as_urls() method in your project's urls.py.
```python
from .forms import TestForm
urlpatterns += TestForm.as_urls()
```
--------------------------------
### Customizing Forwarding with JavaScript
Source: https://github.com/yourlabs/django-autocomplete-light/blob/master/docs/tutorial.md
Use this to integrate custom JavaScript forwarding logic for non-standard fields. The registered handler's return value is forwarded to the autocomplete view with a specified destination name.
```python
from dal import forward
class ShippingForm(forms.Form):
country = forms.ModelChoiceField(
queryset=Country.objects.all(),
widget=autocomplete.ModelSelect2(
url='country-autocomplete',
forward=(forward.JavaScript('my_awesome_handler', 'magic_number'),)))
```
--------------------------------
### Register Alight Autocomplete View with URL
Source: https://github.com/yourlabs/django-autocomplete-light/blob/master/docs/alight.md
Register the custom autocomplete view in your Django urls.py. This maps a URL path to your autocomplete view, making it accessible for form widgets.
```python
from django.urls import path
from your_countries_app.views import CountryAutocomplete
urlpatterns = [
path(
'country-autocomplete/',
CountryAutocomplete.as_view(),
name='country-autocomplete',
),
]
```
--------------------------------
### Configure ModelForm Widget for ForeignKey
Source: https://github.com/yourlabs/django-autocomplete-light/blob/master/docs/tutorial.md
This sets up the autocomplete form widget for a ForeignKey field using ModelSelect2, linking it to the registered 'country-autocomplete' URL.
```python
from dal import autocomplete
from django import forms
class PersonForm(forms.ModelForm):
class Meta:
model = Person
fields = ('__all__')
widgets = {
'birth_country': autocomplete.ModelSelect2(url='country-autocomplete')
}
```
--------------------------------
### Autocomplete with Custom Values from a List
Source: https://github.com/yourlabs/django-autocomplete-light/blob/master/docs/tutorial.md
Define a view that returns a list of lists or tuples, where each inner item contains a value and a display text. This allows for custom values distinct from the displayed text.
```python
class CountryAutocompleteFromList(autocomplete.Select2ListView):
def get_list(self):
return [
['France_value', 'France'],
['Fiji_value', 'Fiji'],
['Finland_value', 'Finland'],
['Switzerland_value', 'Switzerland']
]
```
--------------------------------
### Create a Select2 QuerySet Autocomplete View
Source: https://github.com/yourlabs/django-autocomplete-light/blob/master/docs/tutorial.md
This view serves suggestions for a Select2 widget, filtering results based on user authentication and query input. It uses Django's class-based views and Mixins.
```python
from dal import autocomplete
from your_countries_app.models import Country
class CountryAutocomplete(autocomplete.Select2QuerySetView):
def get_queryset(self):
# Don't forget to filter out results depending on the visitor !
if not self.request.user.is_authenticated:
return Country.objects.none()
qs = Country.objects.all()
if self.q:
qs = qs.filter(name__istartswith=self.q)
return qs
```
--------------------------------
### Autocomplete Form with AlightGenericForeignKeyModelField
Source: https://github.com/yourlabs/django-autocomplete-light/blob/master/docs/gfk.md
Uses FutureModelForm and AlightGenericForeignKeyModelField to enable autocompletion for a GenericForeignKey. It allows filtering based on related model attributes.
```python
from dal import autocomplete # don't forget to pip install django-autocomplete-light[gfk]
class TestForm(autocomplete.FutureModelForm):
location = autocomplete.AlightGenericForeignKeyModelField(
# Model with values to filter, linked with the name field
model_choice=[(Country, 'country_code', [('language', 'spoken_language'),]),
(City, 'name')],
)
class Meta:
model = TestModel
```
--------------------------------
### Using Self() for Forwarding
Source: https://github.com/yourlabs/django-autocomplete-light/blob/master/docs/tutorial.md
A shortcut provided by DAL to forward the value from the same field. The value will be available in the autocomplete view as 'self.forwarded['self']'.
```python
from dal import forward
class SomeForm(forms.Form):
countries = forms.ModelMultipleChoiceField(
queryset=Country.objects.all(),
widget=autocomplete.ModelSelect2Multiple(
url='country-autocomplete',
forward=(forward.Self(),)
```
--------------------------------
### Django Admin Base Template Structure
Source: https://github.com/yourlabs/django-autocomplete-light/blob/master/test_project/templates/admin/base_site.html
This snippet shows the basic Django template inheritance for the admin site. It includes blocks for title, branding, navigation, and extra head content.
```html
{% extends "admin/base.html" %} {% load i18n static %} {% block title %}{{ title }} | {{ site_header|default:">_('Django administration')" }}{% endblock %} {% block branding %} {{ site_header|default:">_('Django administration')" }} {% url 'admin:index' %} {% if user.is_anonymous %} {% include "admin/color_theme_toggle.html" %} {% endif %} {% endblock %} {% block nav-global %} {% if user.is_staff %} {% endif %} {% endblock %} {% block extrahead %} {{ block.super }}
```
--------------------------------
### Validate New Objects Before Creation
Source: https://github.com/yourlabs/django-autocomplete-light/blob/master/docs/alight.md
To ensure data integrity, add `validate_create=True` to your autocomplete view configuration. This will run the model's `full_clean()` method before saving any newly created objects.
```python
CountryAutocomplete.as_view(create_field='name', validate_create=True)
```
--------------------------------
### Taggit Integration Widget
Source: https://github.com/yourlabs/django-autocomplete-light/blob/master/docs/alight.md
Use TaggitAlight widget in your form for django-taggit integration. Provide the URL for your taggit autocomplete view.
```python
from dal import autocomplete
class TestForm(autocomplete.FutureModelForm):
class Meta:
model = TestModel
fields = ('name',)
widgets = {
'tags': autocomplete.TaggitAlight('your-taggit-autocomplete-url')
}
```
--------------------------------
### Forwarding Arbitrary Constant Values
Source: https://github.com/yourlabs/django-autocomplete-light/blob/master/docs/tutorial.md
Shows how to forward a constant value ('europe') as a specific field name ('continent') without adding extra hidden fields to the form. This is useful for setting default or fixed parameters.
```python
from dal import forward
class EuropeanShippingForm(forms.Form):
src_country = forms.ModelChoiceField(
queryset=Country.objects.all(),
widget=autocomplete.ModelSelect2(
url='country-autocomplete',
forward=(forward.Const('europe', 'continent'),)))
```
--------------------------------
### Register Custom JavaScript Initialization Function
Source: https://github.com/yourlabs/django-autocomplete-light/blob/master/docs/tutorial.md
Register a custom JavaScript function to be called when Django Autocomplete Light initializes a widget. This is useful for custom logic that needs to run after initialization, especially with dynamically added form elements. The function receives the jQuery object and the input DOM element as arguments.
```javascript
document.addEventListener('dal-init-function', function () {
yl.registerFunction( 'select2', function ($, element) {
// autocomplete function here
});
})
```
```python
class YourWidget(ModelSelect2):
autocomplete_function = 'your_autocomplete_function'
```
```javascript
document.addEventListener('dal-init-function', function () {
yl.registerFunction( 'your_autocomplete_function', function ($, element) {
var $element = $(element);
// autocomplete function here
});
})
```
--------------------------------
### ModelForm with Forwarded Widget Argument
Source: https://github.com/yourlabs/django-autocomplete-light/blob/master/docs/_forward.md
Define a ModelForm and specify the 'forward' argument for the autocomplete widget to link it with another form field.
```python
class PersonForm(forms.ModelForm):
continent = forms.ChoiceField(choices=CONTINENT_CHOICES)
class Meta:
model = Person
fields = ('__all__',)
widgets = {
'birth_country': autocomplete.ModelAlight(
url='country-autocomplete',
forward=['continent'],
)
}
```
--------------------------------
### Configure TabularInline with Custom Form
Source: https://github.com/yourlabs/django-autocomplete-light/blob/master/docs/alight.md
Use a custom form, which includes Alight autocomplete widgets, within a Django TabularInline. This allows for autocompletion fields to be used in inline editing scenarios.
```python
class PersonInline(admin.TabularInline):
model = Person
form = PersonForm
```
--------------------------------
### Display Custom HTML in Autocomplete Results
Source: https://github.com/yourlabs/django-autocomplete-light/blob/master/docs/tutorial.md
Renders custom HTML for autocomplete results by setting `data-html: true` on the widget and overriding `get_result_label` in the view. Use `format_html` to prevent XSS attacks.
```python
from django.utils.html import format_html
class CountryAutocomplete(autocomplete.Select2QuerySetView):
def get_result_label(self, result):
return format_html('
{}', result.name, result.name)
class PersonForm(forms.ModelForm):
class Meta:
widgets = {
'birth_country': autocomplete.ModelSelect2(
url='country-autocomplete',
attrs={'data-html': True}
)
}
```
--------------------------------
### QuerySet-backed Grouped Results
Source: https://github.com/yourlabs/django-autocomplete-light/blob/master/docs/alight.md
Use AlightGroupQuerySetView to display QuerySet results grouped by a related field. Set group_by_related to the ForeignKey field name and optionally related_field_name for the label attribute.
```python
class CountryAutocomplete(autocomplete.AlightGroupQuerySetView):
group_by_related = 'continent'
related_field_name = 'name'
def get_queryset(self):
return Country.objects.all()
```
--------------------------------
### Configure ModelForm Widget for ManyToMany
Source: https://github.com/yourlabs/django-autocomplete-light/blob/master/docs/tutorial.md
This configures the autocomplete form widget for a ManyToMany field using ModelSelect2Multiple, connecting it to the 'country-autocomplete' URL.
```python
widgets = {
'visited_countries': autocomplete.ModelSelect2Multiple(url='country-autocomplete')
}
```
--------------------------------
### Form Widget for Taggit Tags
Source: https://github.com/yourlabs/django-autocomplete-light/blob/master/docs/taggit.md
Use TaggitAlight widget in a Django form to enable tag autocompletion for a TaggableManager field.
```python
from dal import autocomplete
class TestForm(autocomplete.FutureModelForm):
class Meta:
model = TestModel
fields = ('name',)
widgets = {
'tags': autocomplete.TaggitAlight(
'your-taggit-autocomplete-url'
)
}
```
--------------------------------
### JavaScript Event Listener for Autocomplete
Source: https://github.com/yourlabs/django-autocomplete-light/blob/master/test_project/templates/admin/base_site.html
This JavaScript code listens for the 'autocompleteChoiceSelected' event. When a choice is selected, it checks for a 'url' dataset attribute on the choice and redirects the window to that URL if found.
```javascript
document.addEventListener('autocompleteChoiceSelected', function(ev) { var url = ev.detail.choice.dataset.url if (url) window.location.href = url })
```
--------------------------------
### Manual Generic Foreign Key Form Field
Source: https://github.com/yourlabs/django-autocomplete-light/blob/master/docs/alight.md
Configure a Generic Foreign Key field manually using GenericForeignKeyModelField, specifying the widget and view. This offers more control over the autocomplete behavior.
```python
from dal import autocomplete
from dal_alight_queryset_sequence.views import AlightQuerySetSequenceView
from dal_alight_queryset_sequence.widgets import QuerySetSequenceAlight
class TestForm(autocomplete.FutureModelForm):
location = autocomplete.GenericForeignKeyModelField(
model_choice=[(Country,), (City,)],
widget=QuerySetSequenceAlight,
view=AlightQuerySetSequenceView,
)
class Meta:
model = TestModel
```
--------------------------------
### Use ModelAlight Widget for ForeignKey
Source: https://github.com/yourlabs/django-autocomplete-light/blob/master/docs/alight.md
Integrate the ModelAlight widget into a Django ModelForm for ForeignKey fields. This widget connects the form field to the specified autocomplete URL.
```python
from dal import autocomplete
from django import forms
class PersonForm(forms.ModelForm):
class Meta:
model = Person
fields = ('__all__',)
widgets = {
'birth_country': autocomplete.ModelAlight(url='country-autocomplete')
}
```
--------------------------------
### Registering a JavaScript Forward Handler
Source: https://github.com/yourlabs/django-autocomplete-light/blob/master/docs/tutorial.md
Register a custom JavaScript function to handle value forwarding for non-standard fields. The handler receives the autocomplete HTML element as an argument.
```javascript
// autocompleteElem here is an HTML element for autocomplete field
yl.registerForwardHandler("my_awesome_handler", function (autocompleteElem) {
return doSomeMagicAndGetValueFromSpace();
});
```
--------------------------------
### Django Admin Login Template Structure
Source: https://github.com/yourlabs/django-autocomplete-light/blob/master/test_project/templates/admin/login.html
This is the main structure of the Django admin login template, extending the base site and defining various blocks.
```html
{% extends "admin/base\_site.html" %} {% load i18n static %} {% block extrastyle %}{{ block.super }} {{ form.media }} {% endblock %} {% block bodyclass %}{{ block.super }} login{% endblock %} {% block usertools %}{% endblock %} {% block nav-global %}{% endblock %} {% block content_title %}{% endblock %} {% block breadcrumbs %}{% endblock %} {% block content %} {% if form.errors and not form.non_field_errors %} {% if form.errors.items|length == 1 %}{% trans "Please correct the error below." %}{% else %}{% trans "Please correct the errors below." %}{% endif %} {% endif %} {% if form.non_field_errors %} {% for error in form.non_field_errors %} {{ error }} {% endfor %} {% endif %} {% if user.is_authenticated %} {% blocktrans with username=request.user.username trimmed %} You are authenticated as {{ username }}, but are not authorized to access this page. Would you like to login to a different account? {% endblocktrans %} {% endif %} {% csrf_token %} {{ form.username.errors }} {{ form.username.label_tag }} {{ form.username }} {{ form.password.errors }} {{ form.password.label_tag }} {{ form.password }} {% url 'admin_password_reset' as password_reset_url %} {% if password_reset_url %} [{% trans 'Forgotten your password or username?' %}]({{ password_reset_url }}) {% endif %} {% endblock %}
```