Skip to main content

Customize the template for autocomplete lookups.

Project description

django-grappelli-custom-autocomplete
=======================

This library gives you the ability to customize the display of the grappelli FK / M2M autocomplete lookup.

Customize the dropdown contents and preview contents in an FK Autocomplete:
![Screenshot of custom FK lookup](/../master/docs/screenshots/fk_selection.png?raw=true "Screenshot of custom FK lookup")

Customize the dropdown contents and preview contents in an M2M Autocomplete:
![Screenshot of custom M2M lookup](/../master/docs/screenshots/m2m_selection.png?raw=true "Screenshot of custom M2M lookup")

Improved UX for deletion on M2M:
![Better M2M delete display](/../master/docs/screenshots/delete_ux.png?raw=true "Screenshot of M2M delete")

Requirements
=====
Requires Django and django-grappelli

Installation
=====
1. pip install django-grappelli-custom-autocomplete
2. Add 'django_grappelli_custom_autocomplete' to your INSTALLED_APPS list in your project's settings.py
3. Add to custom urls to urls.py: url(r'^grappelli_custom_autocomplete/', include('django_grappelli_custom_autocomplete.urls')),

Usage
=====
```python

#models.py
class Image( BaseImage ):

#...Your fields here...


"""
1. Define the following three functions on the model to return custom
autocomplete markup:
"""
def custom_related_dropdown_label(self):
#This is the HTML that gets used in the dropdown selector.
return "%s<br /><img src='%s' width='100' />" % (self.title, self.thumbnail.url)


def custom_related_fk_selected_display(self):
#This is the HTML that gets inserted next to the FK selector to
return "<img src='%s' width='100' />" % (self.thumbnail.url)

def custom_related_m2m_selected_display(self):
#This is the HTML that gets used in the M2M list
return "<img src='%s' height='35' /> %s " % (self.thumbnail.url, self.title)

#admin.py
from django_grappelli_custom_autocomplete.admin import CustomAutocompleteMixin, CustomAutocompleteTabularMixin

class PageAdmin(CustomAutocompleteMixin, admin.ModelAdmin):
"""
2. Add the admin mixin "CustomAutocompleteMixin" to your admin class.
3. Define "custom_autocomplete_lookup_fields" as you would with the
"autocomplete_lookup_fields."
"""

fields = ['title', 'thumbnail', 'slides']
raw_id_fields = ['thumbnail', 'slides']
custom_autocomplete_lookup_fields = {
'fk':['thumbnail'],
'm2m': ['slides']
}

class SlideInlineAdmin(CustomAutocompleteTabularMixin, admin.TabularInline):

fields = ['title', 'thumbnail', 'slides']
raw_id_fields = ['thumbnail', 'slides']
custom_autocomplete_lookup_fields = {
'fk':['thumbnail'],
'm2m': ['slides']
}

```

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

File details

Details for the file django-grappelli-custom-autocomplete-1.3.tar.gz.

File metadata

File hashes

Hashes for django-grappelli-custom-autocomplete-1.3.tar.gz
Algorithm Hash digest
SHA256 efaac9885a96871779c59181cf4cb593cb1d7654048c770ca60f54067da90370
MD5 3867c040a5607cff2cdedcc4507f7cc6
BLAKE2b-256 9187807d3e39ac9a1e2bf368a4da2b1db0cd4a90130bf198873ece4ab0444e98

See more details on using hashes here.

Supported by

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