django-admin-rangefilter

Warnings

• breaking Version 0.13.0 introduced a change to the default range template and added support for collapsible filters (Django >= 4.1). If you have custom templates overriding `rangefilter/date_filter.html` or similar, they might require adjustments to work with this new version and take advantage of new features.
  Fix: Review any custom `rangefilter` templates for compatibility with changes introduced in v0.13.0, especially if targeting Django 4.1+ for collapsible filters.
• gotcha It's a common mistake to forget adding 'rangefilter' to your `INSTALLED_APPS` in `settings.py`. Without this, the custom filters will not be registered correctly and will not appear in the admin interface.
  Fix: Ensure 'rangefilter' is present in your `INSTALLED_APPS` list in `settings.py`.
• gotcha Prior to version 0.13.3, there was a bug that prevented users from clearing filters properly. This could lead to confusing UX where applied filters could not be reset.
  Fix: Upgrade to version 0.13.3 or newer to resolve the filter clearing issue.
• gotcha The `collapsible` filter option, introduced in v0.13.0, is only supported for Django versions 4.1 and higher. Attempting to use it with older Django versions will not have the desired effect and might lead to unexpected rendering.
  Fix: Only apply `collapsible=True` in `list_filter` for Django projects running version 4.1 or higher. Example: `('created_at', {'filter_class': DateRangeFilter, 'collapsible': True})`
• gotcha In versions prior to 0.12.2 (specifically fixed in 0.12.1 and 0.12.2), `DateTimeRangeFilter` might have incorrectly handled microsecond precision for upper time bounds, potentially excluding valid entries or providing incorrect range filtering for `DateTimeField`s.
  Fix: Upgrade to version 0.12.2 or newer to ensure correct microsecond handling in `DateTimeRangeFilter`.

Install

• pip install django-admin-rangefilter Install stable version

Imports

• DateRangeFilter

  from rangefilter.filters import DateRangeFilter

• DateTimeRangeFilter

  from rangefilter.filters import DateTimeRangeFilter

• NumericRangeFilter

  from rangefilter.filters import NumericRangeFilter

Quickstart

First, add 'rangefilter' to your `INSTALLED_APPS` in `settings.py`. Then, in your `admin.py`, import the desired filter classes (e.g., `DateRangeFilter`, `DateTimeRangeFilter`, `NumericRangeFilter`) and apply them to fields in your `ModelAdmin`'s `list_filter` attribute. For date/datetime fields, simply specify the field name and filter class. For numeric fields, specify the field name and `NumericRangeFilter`.

# settings.py
INSTALLED_APPS = [
    # ...
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    # ...
    'rangefilter',
    # ...
]

# models.py (example)
from django.db import models
class MyModel(models.Model):
    name = models.CharField(max_length=100)
    created_at = models.DateField(auto_now_add=True)
    updated_at = models.DateTimeField(auto_now=True)
    price = models.DecimalField(max_digits=10, decimal_places=2, default=0.00)
    def __str__(self):
        return self.name

# admin.py
from django.contrib import admin
from rangefilter.filters import DateRangeFilter, DateTimeRangeFilter, NumericRangeFilter
from .models import MyModel

@admin.register(MyModel)
class MyModelAdmin(admin.ModelAdmin):
    list_display = ('name', 'created_at', 'updated_at', 'price')
    list_filter = (
        ('created_at', DateRangeFilter),
        ('updated_at', DateTimeRangeFilter),
        ('price', NumericRangeFilter),
        # Add 'collapsible=True' for Django >= 4.1:
        # ('created_at', {'filter_class': DateRangeFilter, 'collapsible': True}),
    )