Skip to main content

Generate pagination links in Django Templates

Project description

Generate pagination links for Django

Instead of displaying links to all the pages at once, django-smart-pagination calculates a limited subset of them.

Works with Django Templates and Jinja2.

Usage

First add smart_pagination to your installed apps:

INSTALLED_APPS = [
    'smart_pagination'
]

Use a pagination block passing the Page object, the number of links (literal of variable) and the name to associate the smart_pagination.Paginator object.

{% load pagination_tags %}
{% paginate page_obj num_links paging %}
<ul>
    {% for page in paging.pages %}
    <li class="{% if page.is_current %}current{% endif %}">{{ page.number }}</li>
    {% endfor %}
</ul>
{% endpaginate %}

The Paginator object contains the following properties:

first

First Page. Will be None if it is already the first page.

prev

Previous Page. Will be None if there is no previous page.

pages

List of pages.

next

Next Page. Will be None if there is no next page.

last

Last Page. Will be None if it is already the last page.

{% load pagination_tags %}
{% paginate page_obj num_links paging %}
<ul>
    {% if paging.first %}
    <li>First - {{ paging.first.number }}</li>
    {% endif %}

    {% if paging.prev %}
    <li>Previous - {{ paging.prev.number }}</li>
    {% endif %}

    {% for page in paging.pages %}
    <li class="{% if page.is_current %}current{% endif %}">{{ page.number }}</li>
    {% endfor %}

    {% if paging.next %}
    <li>Next - {{ paging.next.number }}</li>
    {% endif %}

    {% if paging.last %}
    <li>Last - {{ paging.last.number }}</li>
    {% endif %}
</ul>
{% endpaginate %}

If you are sending the page_kwarg as a query parameter, you can optionally pass a fourth argument with the name of the page_kwarg and the Paginator will provide the query string without the page_kwarg:

{% load pagination_tags %}
{% paginate page_obj num_links paging 'page' %}
<ul>
    {% for page in paging.pages %}
    <li><a href="?page={{ page.number }}&{{ paging.query }}">{{ page.number }}</a></li>
    {% endfor %}
</ul>
{% endpaginate %}

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

django-smart-pagination-1.0.1.tar.gz (5.4 kB view details)

Uploaded Source

Built Distribution

django_smart_pagination-1.0.1-py2.py3-none-any.whl (7.6 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django-smart-pagination-1.0.1.tar.gz.

File metadata

File hashes

Hashes for django-smart-pagination-1.0.1.tar.gz
Algorithm Hash digest
SHA256 e36adedd406fbcb3776f88c5c16a564938c426904423f847274d526a6123d4d9
MD5 a8e23b5d8f53e3c662e529ef4709602e
BLAKE2b-256 d67f97008db56406cd4d1f871c61cb34843ea9f9e19b9f8a893996801a6f544c

See more details on using hashes here.

File details

Details for the file django_smart_pagination-1.0.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for django_smart_pagination-1.0.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d6f388227cd967d1ae6b153d517b5e0faf90a4fea3ca28a192a0c183d4f45bed
MD5 f98b83e3a5ac6de5e7626990c44b9856
BLAKE2b-256 1c26a76eeddbbe3ad20492641c91e5360dc1ec15e7be8bdcefb0fb1a45044963

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