Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shamanu4/dal_admin_filters
Django autocomplete light filters for django admin
https://github.com/shamanu4/dal_admin_filters
Last synced: about 2 months ago
JSON representation
Django autocomplete light filters for django admin
- Host: GitHub
- URL: https://github.com/shamanu4/dal_admin_filters
- Owner: shamanu4
- License: mit
- Created: 2016-08-30T13:03:51.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2021-07-04T10:50:09.000Z (about 3 years ago)
- Last Synced: 2024-07-23T08:38:32.449Z (2 months ago)
- Language: Python
- Size: 104 KB
- Stars: 64
- Watchers: 3
- Forks: 29
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# dal_admin_filters
## Django-autocomplete-light filters for django admin.
default select2 widget
widget with title as placeholder
## Requirements
This is extension for django-autocomplete-light so you need to install and configure it too.
Here will be minimum setup for example.
Refer to http://django-autocomplete-light.readthedocs.io/ for more detailed instructions.
## Installation
- Install using pip
```
pip install django-autocomplete-light dal_admin_filters
```
- Update INSTALLED_APPS, you need too put django-autocomplete-light before admin
```python
INSTALLED_APPS = [
'dal',
'dal_select2',
'dal_admin_filters',
#
'django.contrib.admin',
... other stuff there ...
]
```
## Configuration
- Create autocomplete view
- Let our models look like this
```python
class Country(models.Model):
name = models.CharField(max_length=100, unique=True)
def __str__(self):
return self.name
class Person(models.Model):
name = models.CharField(max_length=100, unique=True)
from_country = models.ForeignKey(Country)
def __str__(self):
return self.name
```
- Then autocomplete view for country selection will be similar to next
```python
from dal import autocomplete
from your_countries_app.models import Country
class CountryAutocomplete(autocomplete.Select2QuerySetView):
def get_queryset(self):
# Don't forget to filter out results depending on the visitor !
if not self.request.user.is_authenticated():
return Country.objects.none()
qs = Country.objects.all()
if self.q:
qs = qs.filter(name__istartswith=self.q)
return qs
```
- Register view in urls.py
```python
from your_countries_app.views import CountryAutocomplete
urlpatterns = [
url(
r'^country-autocomplete/$',
CountryAutocomplete.as_view(),
name='country-autocomplete',
),
url(r'^admin/', admin.site.urls),
]
```
- Use filter in your admin.py
```python
from django.contrib import admin
from your_countries_app.models import Country, Person
from dal_admin_filters import AutocompleteFilter
@admin.register(Country)
class CountryAdmin(admin.ModelAdmin):
pass
class CountryFilter(AutocompleteFilter):
title = 'Country from' # filter's title
field_name = 'from_country' # field name - ForeignKey to Country model
autocomplete_url = 'country-autocomplete' # url name of Country autocomplete view
class CountryPlaceholderFilter(AutocompleteFilter):
title = 'Country from' # filter's title
field_name = 'from_country' # field name - ForeignKey to Country model
autocomplete_url = 'country-autocomplete' # url name of Country autocomplete view
is_placeholder_title = True # filter title will be shown as placeholder
class CountryCustomPlaceholderFilter(AutocompleteFilter):
title = 'Country from' # filter's title
parameter_name = 'from_country' # field name - ForeignKey to Country model
autocomplete_url = 'country-autocomplete' # url name of Country autocomplete view
widget_attrs = {
'data-placeholder': 'Filter by country name'
}
@admin.register(Person)
class PersonAdmin(admin.ModelAdmin):
class Media: # Empty media class is required if you are using autocomplete filter
pass # If you know better solution for altering admin.media from filter instance
# - please contact me or make a pull request
list_filter = [CountryFilter]
```
If setup is done right, you will see the Select2 widget in admin filter in Person's changelist view.
## Define dependencies between filters (forward)
- Define forwards in the filter (example from the demo_project)
```python
from dal import forward
class PersonFilter(AutocompleteFilter):
autocomplete_url = 'person-autocomplete'
title = 'Owner'
field_name = 'owner'
forwards = [
forward.Field(
'from_country__id__exact', # Field name of filter input
'country_id' # Field name passed to the autocomplete_url endpoint
)
]
```
Read more at [https://django-autocomplete-light.readthedocs.io/](https://django-autocomplete-light.readthedocs.io/en/master/tutorial.html#filtering-results-based-on-the-value-of-other-fields-in-the-form)