Django Admin Inline Paginator

Warnings

• breaking The original `django-admin-inline-paginator` project is no longer actively maintained by its original author, who is looking for new maintainers. Its last release was in April 2023. An actively maintained fork, `django-admin-inline-paginator-plus`, exists and offers new features, including AJAX pagination and broader compatibility with modern Django and Python versions. Users should consider using the `plus` fork for ongoing support and new features.
  Fix: Consider migrating to `django-admin-inline-paginator-plus` (pip install django-admin-inline-paginator-plus) for active development and new features.
• gotcha The `django-admin-inline-paginator` package was last updated in April 2023 and officially requires Python >=3.3. However, newer versions of Django (e.g., Django 4.x, 5.x) require Python 3.8+ or higher. Using this original package with recent Django versions may lead to compatibility issues or unexpected behavior due to API changes over time.
  Fix: Ensure your Django and Python versions are compatible with the last release of this package (0.4.0, Python >=3.3). For modern Django/Python, the `django-admin-inline-paginator-plus` fork is recommended as it explicitly supports newer Django versions and Python >=3.8.
• gotcha The `django-admin-inline-paginator` library implements pagination by reloading the entire admin page for each page navigation, which can impact user experience, especially with many inlines or slow connections. It does not support AJAX-based pagination.
  Fix: If AJAX pagination is a requirement for a smoother user experience, use the `django-admin-inline-paginator-plus` fork, which explicitly adds AJAX support.
• gotcha When dealing with a very large number of inline fields (even if paginated), Django's `DATA_UPLOAD_MAX_NUMBER_FIELDS` setting might be exceeded during form submission, leading to "TooManyFieldsSent" errors. This is a Django core limitation, but relevant when using inline pagination.
  Fix: If you encounter "TooManyFieldsSent" errors, you may need to increase the `DATA_UPLOAD_MAX_NUMBER_FIELDS` setting in your Django project's `settings.py` file. Be mindful of potential security implications when increasing this value excessively.

Install

• pip install django-admin-inline-paginator Install stable version

Imports

• TabularInlinePaginated

  from django_admin_inline_paginator.admin import TabularInlinePaginated

  Used for paginating tabular inlines.
• StackedInlinePaginated

  from django_admin_inline_paginator.admin import StackedInlinePaginated

  Used for paginating stacked inlines. Less commonly featured in basic examples, but available.

Quickstart

To quickly integrate inline pagination, add `django_admin_inline_paginator` to your `INSTALLED_APPS`. Then, define your inline admin classes by inheriting from `TabularInlinePaginated` or `StackedInlinePaginated` and set the `per_page` attribute. Finally, include these paginated inlines in your main `ModelAdmin`.

from django.contrib import admin
from django.db import models

# Assuming you have a model named `YourModel` and another `ModelWithFK`
# linked by a ForeignKey from ModelWithFK to YourModel.
# Example Models:
# class YourModel(models.Model):
#     name = models.CharField(max_length=100)

# class ModelWithFK(models.Model):
#     your_model = models.ForeignKey(YourModel, on_delete=models.CASCADE)
#     name = models.CharField(max_length=100)

# 1. Add 'django_admin_inline_paginator' to INSTALLED_APPS in settings.py
# INSTALLED_APPS = [
#     ...,
#     'django_admin_inline_paginator',
#     ...
# ]

# 2. Create your model inline using TabularInlinePaginated
from django_admin_inline_paginator.admin import TabularInlinePaginated

class ModelWithFKAdminInline(TabularInlinePaginated):
    model = 'ModelWithFK' # Replace with your actual FK model
    fields = ('name',)
    per_page = 5 # Number of items per page
    # pagination_key = 'page-model' # Optional: required for multiple paginated inlines

# 3. Register your main model admin and use the inline
@admin.register('YourModel') # Replace with your actual main model
class YourModelAdmin(admin.ModelAdmin):
    model = 'YourModel'
    fields = ('name',)
    inlines = (ModelWithFKAdminInline,)