{"id":5911,"library":"django-select2","title":"Django Select2 Integration","description":"django-select2 provides a robust Django integration for the popular Select2 JavaScript library, enhancing dropdowns with search, remote data loading, and custom rendering. The current version is 8.4.8, and it sees frequent minor updates and security patches, typically on a monthly or bi-monthly cadence.","status":"active","version":"8.4.8","language":"en","source_language":"en","source_url":"https://github.com/codingjoe/django-select2","tags":["django","select2","forms","widgets","autocomplete","frontend"],"install":[{"cmd":"pip install django-select2","lang":"bash","label":"Install stable version"}],"dependencies":[{"reason":"Core framework integration.","package":"Django","optional":false}],"imports":[{"symbol":"Select2Widget","correct":"from django_select2.forms import Select2Widget"},{"symbol":"Select2MultipleWidget","correct":"from django_select2.forms import Select2MultipleWidget"},{"note":"Used for AJAX-backed autocomplete fields, requiring additional URL/view setup.","symbol":"AutoSelect2Widget","correct":"from django_select2.forms import AutoSelect2Widget"},{"note":"Base view for handling AJAX requests from AutoSelect2Widget.","symbol":"Select2QuerySetView","correct":"from django_select2.views import Select2QuerySetView"},{"note":"Required to include `django-select2`'s JavaScript and CSS assets, and for AJAX views.","symbol":"django_select2.urls","correct":"from django.urls import include, path; path('select2/', include('django_select2.urls'))"}],"quickstart":{"code":"import os\nfrom django import forms\nfrom django.conf import settings\nfrom django.urls import path, include\nfrom django.http import HttpResponse\nfrom django.shortcuts import render\nfrom django_select2.forms import Select2Widget\n\n# Minimal Django settings for testing\nsettings.configure(\n INSTALLED_APPS=[\n 'django.contrib.admin',\n 'django.contrib.auth',\n 'django.contrib.contenttypes',\n 'django.contrib.sessions',\n 'django.contrib.messages',\n 'django.contrib.staticfiles',\n 'django_select2',\n # Add a placeholder app for templates\n 'my_app'\n ],\n TEMPLATES=[\n {\n 'BACKEND': 'django.template.backends.django.DjangoTemplates',\n 'DIRS': [os.path.join(os.path.dirname(__file__), 'templates')],\n 'APP_DIRS': True,\n 'OPTIONS': {\n 'context_processors': [\n 'django.template.context_processors.debug',\n 'django.template.context_processors.request',\n 'django.contrib.auth.context_processors.auth',\n 'django.contrib.messages.context_processors.messages',\n ],\n },\n },\n ],\n SECRET_KEY='a_very_secret_key_for_testing_only',\n DEBUG=True,\n STATIC_URL='/static/',\n STATICFILES_FINDERS=[\n 'django.contrib.staticfiles.finders.FileSystemFinder',\n 'django.contrib.staticfiles.finders.AppDirectoriesFinder',\n ],\n ROOT_URLCONF=__name__,\n)\n\n# Create a dummy templates directory and file for the quickstart\nif not os.path.exists('templates'):\n os.makedirs('templates')\nwith open('templates/quickstart_form.html', 'w') as f:\n f.write('''\n \n \n \n Select2 Quickstart\n {{ form.media.css }}\n \n \n Select2 Form
\n \n {{ form.media.js }}\n \n \n ''')\n\n# forms.py (conceptually)\nclass MyChoiceForm(forms.Form):\n fruit = forms.ChoiceField(\n choices=[\n ('apple', 'Apple'),\n ('banana', 'Banana'),\n ('orange', 'Orange'),\n ('grape', 'Grape'),\n ('strawberry', 'Strawberry'),\n ],\n widget=Select2Widget(attrs={'data-placeholder': 'Select a fruit'})\n )\n\n# views.py (conceptually)\ndef quickstart_view(request):\n if request.method == 'POST':\n form = MyChoiceForm(request.POST)\n if form.is_valid():\n return HttpResponse(f\"You selected: {form.cleaned_data['fruit']}\")\n else:\n form = MyChoiceForm()\n return render(request, 'quickstart_form.html', {'form': form})\n\n# urls.py (conceptually)\nurlpatterns = [\n path('select2/', include('django_select2.urls')),\n path('', quickstart_view, name='quickstart'),\n]\n\n# To run this, you'd typically have a manage.py and runserver,\n# but for a self-contained example:\n# from django.core.management import call_command\n# call_command('runserver', '0.0.0.0:8000')\n\nprint(\"To run this example:\")\nprint(\"1. Ensure you have django and django-select2 installed.\")\nprint(\"2. This code snippet directly configures Django for a basic test.\")\nprint(\"3. In a real project, you'd set up INSTALLED_APPS, URL patterns and templates normally.\")\nprint(\"4. Access '/' to see the form.\")\n","lang":"python","description":"This quickstart demonstrates how to integrate `django-select2` with a simple Django form. Key steps include adding `django_select2` to `INSTALLED_APPS`, including its URL patterns, defining a form with a `Select2Widget`, and ensuring `{{ form.media }}` is present in your template to load the necessary JavaScript and CSS assets."},"warnings":[{"fix":"Upgrade your Django project to Django 4.2+ and Python to 3.10+ before upgrading `django-select2` to 8.3.0 or later.","message":"Version 8.3.0 dropped official support for Django versions older than 4.2 LTS and Python versions older than 3.10. Users on older environments must either upgrade or stick to `django-select2` versions `< 8.3.0`.","severity":"breaking","affected_versions":"< 8.3.0"},{"fix":"Upgrade to `django-select2` version 8.4.1 or newer to patch this vulnerability.","message":"A security vulnerability (CVE-2025-48383 / GHSA-wjrh-hj83-3wh7) was reported where widget instance secret cache keys could leak across multiple requests with a single process.","severity":"security","affected_versions":"All versions < 8.4.1"},{"fix":"Ensure `django_select2` is in `settings.INSTALLED_APPS` and `path('select2/', include('django_select2.urls'))` is in your project's `urls.py`.","message":"Failure to include `django_select2` in `INSTALLED_APPS` and its URL patterns in `urls.py` will prevent assets from loading and AJAX functionality from working.","severity":"gotcha","affected_versions":"All"},{"fix":"Add `{{ form.media }}` (or `{{ form.media.css }}` and `{{ form.media.js }}` separately) to your template where the form is rendered. For best results, place `form.media.css` in the `` and `form.media.js` just before the `` closing tag.","message":"The JavaScript and CSS assets for Select2 are loaded via Django's `Media` class. For `django-select2` widgets to function correctly, `{{ form.media }}` must be included in your template, ideally in the `` for CSS and before `` for JavaScript.","severity":"gotcha","affected_versions":"All"},{"fix":"Create a `Select2QuerySetView` subclass in your `views.py` and map it to a URL pattern that the widget's `data-url` attribute can access.","message":"Using `AutoSelect2Widget` or `HeavySelect2Widget` requires setting up a dedicated view (inheriting from `Select2QuerySetView`) to handle the AJAX requests for data. Without this, the autocomplete functionality will not work.","severity":"gotcha","affected_versions":"All"}],"env_vars":null,"last_verified":"2026-04-14T00:00:00.000Z","next_check":"2026-07-13T00:00:00.000Z"}