A Django helper app to add editing capabilities to the frontend using modal forms.
Bases on my previous research as documented here: Editing Django models in the front end
Contents
- 1 Demo site
- 2 Installation
- 3 How to use
- 4 Opening a Dialog
- 5 Open the Dialog and perform some actions after content has been loaded
- 6 Handling form submission
- 7 Giving a feedback after successful form submission
- 8 Logging in with a modal form
- 9 Replacing login_required
- 10 A full, real example for a Django Form submission from a Dialog
- 11 Editing a Django Model from a Dialog
- 12 Default dialog layout
- 13 App Settings
- 14 "bs4" flavor
- 15 Utilities (module FrontendForms)
- 16 Form rendering helpers
- 17 Datepicker support
- 18 jQuery MultiSelect support
- 19 django-select2 support
An accompaning Demo site provides:
- a detailed description of the techniques used under the hood
- a list of working code samples (source: https://github.com/morlandi/django-frontend-forms/tree/master/example/samples)
Install the package by running:
pip install django-frontend-forms
or:
pip install git+https://github.com/morlandi/django-frontend-formsIn your settings, add:
INSTALLED_APPS = [
...
'frontend_forms',
]Include library's views mapping (file urls.py):
urlpatterns = [
...
path('frontend_forms/', include('frontend_forms.urls', namespace='frontend_forms')),
...In your base template, include the default styles, the javascript support, and optionally the sample HTML template:
<link rel='stylesheet' href="{% static 'frontend_forms/css/frontend_forms.css' %}">
<script src="{% static 'frontend_forms/js/frontend_forms.js' %}"></script>
<script src="{% url 'frontend_forms:javascript-catalog' %}"></script>
{% include 'frontend_forms/dialogs.html' %}Notes:
javascript catalog
Please note the third row in the snippets above:
<script src="{% url 'frontend_forms:javascript-catalog' %}"></script>
Since v0.2.1 it is mandatory to include the dynamically generated javascript catalog, as a few messages have been translated in javascript code following these instructions: Django Internationalization: in JavaScript code.
compatibility with older browsers
frontend_forms/js/frontend_forms.jsx has been transpiled to produce frontend_forms/js/frontend_forms.js for maximum compatibility with older browsers (using transpile_jsx.py helper script).
If you don't care, or you plan to transpile via django-compressor, you can include the ".jsx" file instead:
<script src="{% static 'frontend_forms/js/frontend_forms.jsx' %}" type="text/jsx"></script>
Two actions are required:
- provide an HTML template for the dialog layout
- attach the template to a Dialog javascript object to control it's behaviour
Since in most cases you will be primarily interested in customizing the modal content only, a default template is provided to render a generic dialog (file frontend_forms/templates/frontend_forms/dialogs.html).
| Method | Effects |
| constructor(options={}) | See options list below |
| open(event=null, show=true) | Open the dialog
|
| close() | Close (hide) the dialog |
| show() | Make the dialog visible |
| Option | Default value | Notes |
| dialog_selector | '#dialog_generic' | The selector for HTML dialog template |
| open_event | null | Used to "remember" the event which triggered Dialog opening |
| html | '' | Static content to display in dialog body |
| url | '' | Optional url to retrieve dialog content via Ajax |
| width | null | |
| min_width | null | |
| max_width | null | |
| height | null | |
| min_height | null | |
| max_height | null | |
| button_save_label | 'Save' | |
| button_save_initially_hidden | false | Will be shown after form rendering |
| button_close_label | 'Cancel' | |
| title | '' | |
| subtitle | '' | |
| footer_text | '' | |
| enable_trace | false | show notifications in debug console |
| callback | null | a callback to receive events |
| autofocus_first_visible_input | true |
Unspecified options will be retrieved from corresponding HTML attributes on the element which fires the dialog opening; for example:
<a href="{% url 'frontend:whatever' object.id %}"
data-title="My title"
data-subtitle="My Subtitle"
onclick="new Dialog().open(event); return false;">
Open
</a>| Option | HTML attribute |
| url | href |
| html | data-html |
| width | data-width |
| min_width | data-min-width |
| max_width | data-max-width |
| height | data-height |
| min_height | data-min-height |
| max_height | data-max-height |
| button_save_label | data-button-save-label |
| button_close_label | data-button-close-label |
| title | data-title |
| subtitle | data-subtitle |
| footer_text | data-footer-text |
| event_name | params |
|---|---|
| created | options |
| closed | |
| initialized | |
| shown | |
| loading | url |
| loaded | url, data |
| loading_failed | jqXHR, textStatus, errorThrown |
| open | |
| submitting | method, url, data |
| submission_failure | method, url, data |
| submitted | method, url, data |
During it's lifetime, the Dialog will notify all interesting events to the caller, provided he supplies a suitable callback in the contructor:
self.options.callback(event_name, dialog, params)
Example:
dialog1 = new Dialog({
...
callback: function(event_name, dialog, params) {
console.log('event_name: %o, dialog: %o, params: %o', event_name, dialog, params);
}
});Result:
event_name: "created", dialog: Dialog {options: {…}, element: …}, params: {options: {…}}
event_name: "initialized", dialog: Dialog {options: {…}, element: …}, params: {}
event_name: "open", dialog: Dialog {options: {…}, element: …}, params: {}
event_name: "shown", dialog: Dialog {options: {…}, element: …}, params: {}
event_name: "loading", dialog: Dialog {options: {…}, element: …}, params: {url: "/admin_ex/popup/"}
event_name: "loaded", dialog: Dialog {options: {…}, element: …}, params: {url: "/admin_ex/popup/"}
event_name: "submitting", dialog: Dialog {options: {…}, element: …}, params: {method: "post", url: "/admin_ex/popup/", data: "text=&number=aaa"}
event_name: "submitted", dialog: Dialog {options: {…}, element: …}, params: {method: "post", url: "/admin_ex/popup/", data: "text=111&number=111"}
event_name: "closed", dialog: Dialog {options: {…}, element: …}, params: {}
You can also trace all events in the console setting the boolean flag enable_trace.
In the following example, we build a Dialog() object providing some custom options; then, we use it to open a modal dialog and load it from the specified url.
For demonstration purposes, we also subscribe the 'created' notification.
<script language="javascript">
$(document).ready(function() {
dialog1 = new Dialog({
html: '<h1>Loading ...</h1>',
url: '{% url 'frontend:j_object' %}',
width: '400px',
min_height: '200px',
title: '<i class="fa fa-calculator"></i> Selezione Oggetto',
footer_text: 'testing dialog ...',
enable_trace: true,
callback: function(event_name, dialog, params) {
switch (event_name) {
case "created":
console.log('Dialog created: dialog=%o, params=%o', dialog, params);
break;
}
}
});
});
</script>
<a href="#" class="btn btn-primary pull-right" onclick="dialog1.open(event); return false;">
<i class="fa fa-plus-circle"></i>
Test Popup
</a>In the following example:
- we subscribe the 'loaded' event
- we call open() with show=false, so the Dialog will remain hidden during loading
- after loading is completed, our handle is called
- in this handle, we show the dialog and hide it after a 3 seconds timeout
Sample usage in a template:
<script language="javascript">
$(document).ready(function() {
dialog2 = new Dialog({
url: "{% url 'frontend:j_object' %}",
width: '400px',
min_height: '200px',
enable_trace: true,
callback: dialog2_callback
});
});
function dialog2_callback(event_name, dialog, params) {
switch (event_name) {
case "loaded":
dialog.show();
setTimeout(function() {
dialog.close();
}, 3000);
break;
}
}
</script>
<a href="#" onclick="dialog2.open(event, show=false); return false;">
<i class="fa fa-plus-circle"></i>
Test Popup (2)
</a>When a form submission is involved, the modal life cycle has to be modified as follows:
First and foremost, we need to prevent the form from performing its default submit.
If not, after submission we'll be redirected to the form action, outside the context of the dialog.
We'll do this binding to the form's submit event, where we'll serialize the form's content and sent it to the view for validation via an Ajax call.
Then, upon a successufull response from the server, we'll need to further investigate the HTML received:
- if it contains any field error, the form did not validate successfully, so we update the modal body with the new form and its errors
- otherwise, user interaction is completed, and we can finally close the modal
django-frontend-forms, upon detecting a form in the content downloaded from the server, already takes care of all these needs automatically, and keeps refreshing the modal after each submission until the form validation succeedes.
Sometimes, you might want to notify the user after successful form submission.
To obtain this, all you have to do, after the form has been validated and saved, is to return an HTML fragment with no forms in it; in this case:
- the popup will not close
- the "save" button will be hidden
thus giving to the user a chance to read your feedback.
def form_validation_with_feedback(request):
assert request.is_ajax()
if request.method == 'POST':
form = MyForm(data=request.POST)
if form.is_valid():
form.save()
return HttpResponse("<h1>Great !</h1> Your form has been validated")
else:
form = MyForm()
return render(request, "my_form.html", {
'form': form,
})If you're trying to minimize page switching and reduce navigation in your frontend, why not provide a modal window for login as well ?
The library contains a login view adapted from the standard (function based) Django login view, which can be used for either a standalone HTML page or in a Dialog.
For example:
<a id="login_with_dialog" href="{% url 'frontend_forms:login' %}">
<i class="fa fa-sign-in"></i>
Login
</a>
<script language="javascript">
$(document).ready(function() {
$('#login_with_dialog').on('click', function(event) {
event.preventDefault();
var target = $(event.target);
var url = target.attr('href');
var logged_in = false;
var login_dialog = new Dialog({
url: url,
width: '400px',
min_height: '200px',
title: '<i class="fa fa-sign-in"></i> Login ...',
button_save_label: "Login",
button_close_label: "Close",
callback: function(event_name, dialog, params) {
switch (event_name) {
case "submitted":
logged_in = true;
break;
case "closed":
if (logged_in) {
FrontendForms.redirect('/', true);
}
break;
}
}
});
login_dialog.open(event);
});
});
</script>
You can customize the following templates:
- frontend_forms/login.html
- frontend_forms/login_inner.html
- frontend_forms/login_successful_message.html
A decorator suitable for modal forms is provided to replace login_required():
from frontend_forms.decorators import check_logged_in
@check_logged_in()
def my_view(request, ...):
...It checks that the user is logged in, showing an error message in place if not.
You can customize the following template:
- frontend_forms/check_logged_in_failed.html
We start by creating a view for form rendering and submission:
file ajax.py:
import time
from frontend_forms.decorators import check_logged_in
from django.views.decorators.cache import never_cache
from django.core.exceptions import PermissionDenied
from django.http import HttpResponseRedirect
@check_logged_in()
@never_cache
def select_contract(request):
# if settings.DEBUG:
# time.sleep(0.5);
if not request.user.has_perm('backend.view_contract') or not request.is_ajax():
raise PermissionDenied
#template_name = 'frontend/dialogs/generic_form_inner_with_video.html'
template_name = 'dashboard/dialogs/select_contract.html'
object = None
if request.method == 'POST':
form = SelectContractForm(request=request, data=request.POST)
if form.is_valid():
object = form.save(request)
if not request.is_ajax():
# reload the page
next = request.META['PATH_INFO']
return HttpResponseRedirect(next)
# if is_ajax(), we just return the validated form, so the modal will close
else:
form = SelectContractForm(request=request)
return render(request, template_name, {
'form': form,
'object': object, # unused, but armless
})and provide an endpoint to it for ajax call:
file urls.py
from django.urls import path
from . import ajax
app_name = 'dashboard'
urlpatterns = [
...
path('j/select_contract/', ajax.select_contract, name='j_select_contract'),
...
]The Form in this example does a few interesting things:
- includes some specific assets declaring an inner Media class
- receives the request upon construction
- uses it to provide specific initial values to the widgets
- provides some specific validations with clean()
- encapsulates in save() all actions required after successfull submission
file forms.py:
import json
import datetime
from django import forms
from selectable.forms import AutoCompleteWidget, AutoCompleteSelectWidget, AutoComboboxSelectWidget
from backend.models import Contract
from django.utils.safestring import mark_safe
from .lookups import ContractLookup
class SelectContractForm(forms.Form):
contract = forms.CharField(
label='Contract',
widget=AutoComboboxSelectWidget(ContractLookup, limit=10),
required=True,
help_text=mark_safe(" "),
)
today = forms.BooleanField(label="Oggi", required=False)
date = forms.DateField(widget=forms.DateInput(), label='', required=False)
class Media:
css = {
'screen': ('dashboard/css/select_contract_form.css', )
}
js = ('dashboard/js/select_contract_form.js', )
def __init__(self, request, *args, **kwargs):
super().__init__(*args, **kwargs)
self.fields['date'].widget = forms.DateInput(attrs={'class': 'datepicker'})
assert request.user.is_authenticated and request.user.is_active
self.fields['contract'].initial = request.user.contract_attivo
self.fields['date'].initial = request.user.data_attiva
self.fields['today'].initial = request.user.data_attiva is None
def lookup_contract(self):
try:
contract = Contract.objects.get(
id=self.cleaned_data['contract']
)
except Contract.DoesNotExist:
contract = None
return contract
def clean(self):
cleaned_data = self.cleaned_data
if not cleaned_data['today'] and not cleaned_data['date']:
raise forms.ValidationError({
'date': 'Questo campo è obbligatorio'
})
return cleaned_data
def save(self, request):
user = request.user
assert request.user.is_authenticated and request.user.is_active
user.contract_attivo = self.lookup_contract()
if self.cleaned_data['today']:
user.data_attiva = None
else:
user.data_attiva = self.cleaned_data['date']
user.save(update_fields=['contract_attivo', 'data_attiva', ])The javascript and css assets are used for specific needs of this form:
function onChangeToday(event) {
var controller = $('#id_today');
var value = controller.is(":checked");
$('#id_date').prop('disabled', value);
$('.field-date .ui-datepicker-trigger').prop('disabled', value);
if (value) {
$('#id_date').datepicker('setDate', null);
}
}
$(document).ready(function() {
$('#id_today').on('change', onChangeToday);
onChangeToday();
});In the template, remember to include the Form's assets:
{% load i18n frontend_forms_tags %}
{{ form.media.css }}
<div class="row">
<div class="col-sm-12">
<form action="{{ action }}" method="post" class="form {{form.form_class}}" novalidate autocomplete="off">
{% csrf_token %}
{% if form.errors or form.non_field_errors %}
<p class="errornote">{% trans 'Please correct the error below.' %}</p>
{% endif %}
{% if form.non_field_errors %}
<ul class="errorlist">
{% for error in form.non_field_errors %}
<li>{{ error }}</li>
{% endfor %}
</ul>
{% endif %}
{% for hidden_field in form.hidden_fields %}
{{ hidden_field }}
{% endfor %}
<fieldset>
{% render_form_field form.contract %}
<div>Data di riferimento:</div>
<div class="data-selection-block">
{% render_form_field form.today %}
{% render_form_field form.date %}
</div>
</fieldset>
<input type="hidden" name="object_id" value="{{ object.id|default:'' }}">
<div class="form-submit-row">
<input type="submit" value="Save" />
</div>
</form>
</div>
</div>
{% if request.is_ajax %}
{{ form.media.js }}
{% endif %}And finally, the Dialog itself;
please note that we use the loaded event notification to rebind the widgets after form rendering.
{% block extrajs %}
<script language="javascript">
$(document).ready(function() {
dialog1 = new Dialog({
dialog_selector: '#dialog_generic',
html: '',
url: "{% url 'dashboard:j_select_contract' %}",
width: '80%',
max_width: '400px',
min_height: '200px',
button_save_label: 'Salva',
button_close_label: 'Annulla',
title: '<i class="fa fa-file-o"></i> Selezione Contract',
footer_text: '',
enable_trace: true,
callback: function(event_name, dialog, params) {
switch (event_name) {
case "loaded":
bindSelectables();
dialog.element.find(".datepicker").datepicker({});
break;
case "submitted":
FrontendForms.reload_page(show_layer=true);
break;
}
}
});
$('.btn-cambia-contract').off().on('click', function(event) {
event.preventDefault();
dialog1.open();
})
});
</script>
{% endblock extrajs %}TODO: TO BE REFINED ... AND VERIFIED ;)
First of all, we need a view for form rendering and submission.
For example:
@check_logged_in()
@never_cache
def edit_something(request, id_object=None):
# if not request.user.has_perm('backend.view_something') or not request.is_ajax():
# raise PermissionDenied
if id_object is not None:
object = get_object_or_404(Something, id=id_object)
else:
object = None
template_name = 'frontend_forms/generic_form_inner.html'
if request.method == 'POST':
form = SomethingForm(data=request.POST, instance=object)
if form.is_valid():
object = form.save(request)
if not request.is_ajax():
# reload the page
next = request.META['PATH_INFO']
return HttpResponseRedirect(next)
# if is_ajax(), we just return the validated form, so the modal will close
else:
form = SomethingForm()
return render(request, template_name, {
'form': form,
'object': object, # unused, but armless
})where:
class SomethingForm(forms.ModelForm):
class Meta:
model = Someghing
exclude = []
...and an endpoint for Ajax call:
File "urls.py" ...
path('j/edit_something/<int:id_object>/', ajax.edit_something, name='j_edit_something'),We can finally use the form in a Dialog:
$(document).ready(function() {
dialog1 = new Dialog({
dialog_selector: '#dialog_generic',
html: '<h1>Loading ...</h1>',
url: '/j/edit_something/{{ object.id }}/',
width: '400px',
min_height: '200px',
title: '<i class="fa fa-add"></i> Edit',
footer_text: '',
enable_trace: true,
callback: function(event_name, dialog, params) {
switch (event_name) {
case "created":
console.log('Dialog created: dialog=%o, params=%o', dialog, params);
break;
case "submitted":
FrontendForms.hide_mouse_cursor();
FrontendForms.reload_page(true);
break;
}
}
});
});When contructing a Dialog, you can use the dialog_selector option to select which HTML fragment of the page will be treated as the dialog to work with.
It is advisable to use an HTML structure similar to the default layout:
<div id="dialog_generic" class="dialog draggable">
<div class="dialog-dialog">
<div class="dialog-content">
<div class="dialog-header">
<span class="spinner">
<i class="fa fa-spinner fa-spin"></i>
</span>
<span class="close">×</span>
<div class="title">Title</div>
</div>
<div class="dialog-body ui-front">
</div>
<div class="dialog-footer">
<input type="submit" value="Close" class="btn btn-close" />
<input type="submit" value="Save" class="btn btn-save" />
<div class="text">footer</div>
</div>
</div>
</div>
</div>Notes:
- ".draggable" make the Dialog draggable
- adding ".ui-front" to the ".dialog-box" element helps improving the behaviour of the dialog on a mobile client
| Option | Accepted values |
| FRONTEND_FORMS_FORM_LAYOUT_FLAVOR | "generic", "bs4" |
| FRONTEND_FORMS_FORM_LAYOUT_DEFAULT | "vertical", "horizontal" |
| FRONTEND_FORMS_MODEL_FORMS_MODULES |
Default values:
FRONTEND_FORMS_FORM_LAYOUT_FLAVOR = "generic" FRONTEND_FORMS_FORM_LAYOUT_DEFAULT = "vertical" FRONTEND_FORMS_MODEL_FORMS_MODULES = ['frontend.forms', ]
Add the .compact-fields class to the form to modify the layout as in the right picture below:
- display_server_error(errorDetails)
- redirect(url, show_layer=false)
- gotourl(url, show_layer=false)
- reload_page(show_layer=false)
- overlay_show(element)
- overlay_hide(element)
- hide_mouse_cursor()
- logObject(element, obj)
- dumpObject(obj, max_depth, depth)
- isEmptyObject(obj)
- cloneObject(obj)
- lookup(array, prop, value)
- adjust_canvas_size(id)
- getCookie(name)
- confirmRemoteAction(url, options, afterDoneCallback, data=null)
- downloadFromAjaxPost(url, params, headers, callback)
- querystring_parse(qs, sep, eq, options)
- set_datepicker_defaults(language_code)
- apply_multiselect(elements)
A render_form(form, flavor=None, layout=FORM_LAYOUT_DEFAULT) template tag is available for form rendering:
{% load frontend_forms_tags ... %}
<form method="post">
{% csrf_token %}
{% render_form form %}
<div class="form-group form-submit-row">
<button type="submit" class="btn btn-lg btn-primary btn-block">{% trans 'Submit' %}</button>
</div>
</form>For more a more advanced customization, you can use render_form_field(field, flavor=None, extra_attrs='', layout=FORM_LAYOUT_DEFAULT, index=0, addon='') instead:
{% load frontend_forms_tags ... %}
<form method="post">
{% csrf_token %}
{% if form.non_field_errors %}
<ul class="errorlist">
{% for error in form.non_field_errors %}
<li>{{ error }}</li>
{% endfor %}
</ul>
{% endif %}
{% for hidden_field in form.hidden_fields %}
{{ hidden_field }}
{% endfor %}
<fieldset>
{% render_form_field form.username extra_attrs="autocomplete=^off,role=presentation,autocorrect=off,autocapitalize=none" %}
{% render_form_field form.password extra_attrs="autocomplete=^off,role=presentation,autocorrect=off,autocapitalize=none" addon='<i class="fa fa-user"></i>' %}
</fieldset>
<div class="form-group form-submit-row">
<button type="submit" class="btn btn-lg btn-primary btn-block">{% trans 'Submit' %}</button>
</div>
</form>In this second example, we supply extra_attrs attributes to each form field; these will be added to the attributes already derived from the Django Form field definitions.
The special prefix ^ will be removed from the attribute, and interpreted as "replace" instead of "append".
A generic template is also available:
generic_form_inner.html:
{% load i18n frontend_forms_tags %}
<div class="row">
<div class="col-sm-12">
<form action="{{ action }}" method="post" class="form" novalidate autocomplete="off">
{% csrf_token %}
{% render_form form %}
<input type="hidden" name="object_id" value="{{ object.id|default:'' }}">
<div class="form-submit-row">
<input type="submit" value="Save" />
</div>
</form>
</div>
</div>Please note that, as a convenience when editing a Django Model, we've added an hidden field object_id; in other occasions, this is useless (but also armless, as long as the form doesn't contain a field called "object").
A basic support is provided for jquery-ui datepicker.
Follow these steps:
- Initialize datepicker default by calling FrontendForms.set_datepicker_defaults(language_code) once:
<script language="javascript">
$(document).ready(function() {
moment.locale('it');
FrontendForms.set_datepicker_defaults('{{LANGUAGE_CODE}}'); <-------------
...- In your form, make sure that the datepicker class is assigned to the input element; for example:
class MyForm(forms.Form):
date = forms.DateField(widget=forms.DateInput())
...
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.fields['date'].widget = forms.DateInput(attrs={'class': 'datepicker'})- If loading the form in a dialog, rebind as necessary:
dialog1 = new Dialog({
...
callback: function(event_name, dialog, params) {
switch (event_name) {
case "loaded":
bindSelectables();
dialog.element.find(".datepicker").datepicker({}); <-------------
break;
...
}
}
});Requirements:
<link rel="stylesheet" type="text/css" href="{% static 'multiselect/css/multi-select.css' %}" />
<script src="{% static 'multiselect/js/jquery.multi-select.js' %}"></script>
<script src="{% static 'jquery.quicksearch/dist/jquery.quicksearch.min.js' %}"></script>
Follow these steps:
- In your form, add the multiselect class to the SelectMultiple() widget
class MyForm(forms.ModelForm):
...
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.fields['operators'].widget.attrs = {'class': 'multiselect'}- Later on, bind the widget using apply_multiselect() helper:
dialog1 = new Dialog({
...
callback: function(event_name, dialog, params) {
switch (event_name) {
case "loaded":
FrontendForms.apply_multiselect(dialog.element.find('.multiselect'));
break;
...
}
}
});Requirements:
pip install django-select2 npm install select2
Changes to "settings.py":
INSTALLED_APPS = [
...
'django_select2',
...
Changes to "base.html":
<link rel="stylesheet" type="text/css" href="{% static 'select2/dist/css/select2.min.css' %}" />
<script src="{% static 'select2/dist/js/select2.min.js' %}"></script>
<script src="{% static 'select2/dist/js/i18n/it.js' %}"></script>
<script language="javascript">
$.fn.select2.defaults.set('language', 'it');
</script>
<script src="{% static 'django_select2/django_select2.js' %}"></script>
Follow these steps:
- In your form, use one or more Select2Widget():
from django_select2.forms import HeavySelect2Widget
class MyForm(forms.ModelForm):
...
class Meta:
...
widgets = {
'fieldname': HeavySelect2Widget(
data_url='/url/to/json/response'
)
}- Later on, bind the widgets using djangoSelect2() helper:
dialog1 = new Dialog({
...
callback: function(event_name, dialog, params) {
switch (event_name) {
case "loaded":
dialog.element.find('.django-select2').djangoSelect2({
// "dropdownParent" is required for Bootstrap; see:
// https://select2.org/troubleshooting/common-problems#select2-does-not-function-properly-when-i-use-it-inside-a-bootst
dropdownParent: dialog.element
});
break;
...
}
}
});I normally opt to include all required static files in "base.hmtml", since I'm already including so much javascript stuff.
In this case, make sure django-select2 won't istall them twice; for example:
class MySelect2Widget():
"""
Avoid inclusion of select2 by django-select2 as a result of {{form.media}},
since we're already including everything in base.html
"""
def _get_media(self):
return None
media = property(_get_media)
class AlbumWidget(MySelect2Widget, ModelSelect2Widget):
model = Album
search_fields = [
'name__istartswith',
]
def build_attrs(self, base_attrs, extra_attrs=None):
attrs = super().build_attrs(base_attrs=base_attrs, extra_attrs=extra_attrs)
# "data-minimum-input-length";
# - either override build_attrs() here,
# - or provide as attr in the instance; for example:
# 'album': AlbumWidget(attrs={'data-minimum-input-length': 0,}),
attrs['data-minimum-input-length'] = 0
return attrs