Ajax autocomplete list filter helper for Django admin. Uses Django’s built-in autocomplete widget! No extra package or install required!
Dropped support for Django 2 family. Works with Django 3 or higher!. master
branch is renamed to main... You can fix your existing clones via;
git branch -m master main
git fetch origin
git branch -u origin/main main
git remote set-head origin -a$ pip install django-admin-autocomplete-list-filterAdd djaa_list_filter to INSTALLED_APPS in your settings.py:
INSTALLED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
'djaa_list_filter',
]Now, let’s look at this example model:
# models.py
from django.conf import settings
from django.db import models
class Post(models.Model):
category = models.ForeignKey(to='Category', on_delete=models.CASCADE, related_name='posts')
author = models.ForeignKey(to=settings.AUTH_USER_MODEL, on_delete=models.CASCADE, related_name='posts')
title = models.CharField(max_length=255)
body = models.TextField()
tags = models.ManyToManyField(to='Tag', blank=True)
def __str__(self):
return self.title
class Category(models.Model):
title = models.CharField(max_length=255)
def __str__(self):
return self.title
class Tag(models.Model):
name = models.CharField(max_length=255)
def __str__(self):
return self.nameWe have 2 ForeignKey fields and one ManyToManyField to enable
autocomplete list filter feature on admin. All you need is to inherit from
AjaxAutocompleteListFilterModelAdmin which inherits from Django’s
admin.ModelAdmin.
Now we have an extra ModelAdmin method: autocomplete_list_filter. Uses
Django Admin’s search_fields logic. You need to enable search_fields
in the related ModelAdmin. To enable completion on Category relation,
CategoryAdmin should have search_fields that’s it!
from django.contrib import admin
from djaa_list_filter.admin import (
AjaxAutocompleteListFilterModelAdmin,
)
from .models import Category, Post, Tag
@admin.register(Post)
class PostAdmin(AjaxAutocompleteListFilterModelAdmin):
list_display = ('__str__', 'author', 'show_tags')
autocomplete_list_filter = ('category', 'author', 'tags')
def show_tags(self, obj):
return ' , '.join(obj.tags.values_list('name', flat=True))
@admin.register(Category)
class CategoryAdmin(admin.ModelAdmin):
search_fields = ['title']
ordering = ['title']
@admin.register(Tag)
class TagAdmin(admin.ModelAdmin):
search_fields = ['name']
ordering = ['name']You are very welcome to contribute, fix bugs or improve this project. We hope to help people who needs this feature. We made this package for our company project. Good appetite for all the Django developers out there!
This project is licensed under MIT
- Uğur "vigo" Özyılmazel - Author, Maintainer
- Can Adıyaman - Author, Maintainer
- Erdi Mollahüseyinoğlu - Author, Maintainer
- Guglielmo Celata - Contributor
- Joseph Bane - Contributor
- Ryohei Endo - Contributor
- Peter Farrell - Contributor
- Márton Salomváry - Contributor
All PR’s are welcome!
fork(https://github.com/demiroren-teknoloji/django-admin-autocomplete-list-filter/fork)- Create your
branch(git checkout -b my-features) commityours (git commit -am 'added killer options')pushyourbranch(git push origin my-features)- Than create a new Pull Request!
- Add unit tests
- Improve JavaScript code :)
2021-08-17
- Fix Django 3 compatibility changes
- Allow for more than one autocomplete field
- staticfiles fix
masterbranch is renamed tomain
2019-10-25
- Remove f-string for older Python versions, will change this on 1.0.0 version
2019-10-19
- Bump version: 0.1.2
- Add Python 3.5 supports, thanks to Peter Farrel
- Add animated gif :)
- Add future warning for f-strings
2019-10-11
- Add ManyToManyField support
- Initial release
2019-10-07
- Init repo...
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent