Skip to main content

Edit ForeignKey, ManyToManyField and CharField in Django Admin using jQuery UI AutoComplete.

Project description

Edit ForeignKey, ManyToManyField and CharField in Django Admin using jQuery UI AutoComplete

Build Status PyPI version

This Django app glues Django Admin, jQuery UI together to enable searching and managing ForeignKey and ManyToMany relationships.

At the time it was created Django did not have any way to do this, and this solution glued together some technologies of the day.

If you are building a new project then you should not use this.

Django has built in support now: https://docs.djangoproject.com/en/3.2/ref/contrib/admin/#django.contrib.admin.ModelAdmin.autocomplete_fields


selecting

selected

Documentation

http://django-ajax-selects.readthedocs.org/en/latest/

Installation

pip install django-ajax-selects

Add the app:

# settings.py
INSTALLED_APPS = (
    ...
    'ajax_select',  # <-   add the app
    ...
)

Include the urls in your project:

# urls.py
from django.urls import path
from django.conf.urls import include

from django.conf.urls.static import static
from django.contrib import admin
from django.conf import settings
from ajax_select import urls as ajax_select_urls

admin.autodiscover()

urlpatterns = [
    # This is the api endpoint that django-ajax-selects will call
    # to lookup your model ids by name
    path("admin/lookups/", include(ajax_select_urls)),
    path("admin/", admin.site.urls),
] + static(settings.STATIC_URL, document_root=settings.STATIC_ROOT)

Quick Usage

Define a lookup channel:

# yourapp/lookups.py
from ajax_select import register, LookupChannel
from .models import Tag

@register('tags')
class TagsLookup(LookupChannel):

    model = Tag

    def get_query(self, q, request):
        return self.model.objects.filter(name__icontains=q).order_by('name')[:50]

    def format_item_display(self, item):
        return u"<span class='tag'>%s</span>" % item.name

Add field to a form:

# yourapp/forms.py
from ajax_select.fields import AutoCompleteSelectMultipleField

class DocumentForm(ModelForm):

    class Meta:
        model = Document

    tags = AutoCompleteSelectMultipleField('tags')

This will now work in the Django Admin.

To use a form outside, be sure to include form.media on the template where you place the form:

{{ form.media }}
{{ form }}

Read the full documention here: outside of the admin

Fully customizable

  • Customize search query
  • Query other resources besides Django ORM
  • Format results with HTML
  • Customize styling
  • Customize security policy
  • Add additional custom UI alongside widget
  • Integrate with other UI elements elsewhere on the page using the javascript API
  • Works in Admin as well as in normal views

Assets included by default

https://jquery.com/ 3.7.1 https://jqueryui.com/ 1.13.2

Customize jquery

To use a custom jQuery UI theme you can set:

# settings.py
AJAX_SELECT_JQUERYUI_THEME = "/static/path-to-your-theme/jquery-ui-min.css"

https://jqueryui.com/themeroller/

If you need to use a different jQuery or jQuery UI then turn off the default assets:

# settings.py
AJAX_SELECT_BOOTSTRAP = False

and include jquery and jquery-ui yourself, making sure they are loaded before the Django admin loads.

Compatibility

  • Django >=3.2
  • Python >=3.10

Contributors

Many thanks to all contributors and pull requesters !

https://github.com/crucialfelix/django-ajax-selects/graphs/contributors/

License

Dual licensed under the MIT and GPL licenses:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django_ajax_selects-3.0.3.tar.gz (427.0 kB view details)

Uploaded Source

Built Distribution

django_ajax_selects-3.0.3-py3-none-any.whl (443.0 kB view details)

Uploaded Python 3

File details

Details for the file django_ajax_selects-3.0.3.tar.gz.

File metadata

  • Download URL: django_ajax_selects-3.0.3.tar.gz
  • Upload date:
  • Size: 427.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.1 Linux/6.5.0-1025-azure

File hashes

Hashes for django_ajax_selects-3.0.3.tar.gz
Algorithm Hash digest
SHA256 650071c78c333139059e00a41e9aeff21234e026f2076965429594f5c5327f35
MD5 fa3a95e180512a5a60e9024cd8515c29
BLAKE2b-256 304abab3a28e94912f744d53624c2d9e192c73a6ae0fd8741edacd6d46ee09b5

See more details on using hashes here.

File details

Details for the file django_ajax_selects-3.0.3-py3-none-any.whl.

File metadata

  • Download URL: django_ajax_selects-3.0.3-py3-none-any.whl
  • Upload date:
  • Size: 443.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.1 Linux/6.5.0-1025-azure

File hashes

Hashes for django_ajax_selects-3.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 10c618dd3bbb2ca78b9d4625b1f64a225c00a6ad4bc13fbe87ad33f12a204e1b
MD5 d068794bef5f33dcad3bfaa40087dcea
BLAKE2b-256 47c4f3fdc8d629912040dbe2744e1fa97cdb529b868d1e9c29e40b4dc3fd998c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page