Git Product home page Git Product logo

django-sequential-pagination's Introduction

django-sequential-pagination

Paginate ordered Django querysets sequentially with "Next" button. Fully compatible with django-el-pagination (but doesn't depend on it).

The pagination is performed by object ID (or any other set of fields that give strict linear order) rather than by page number. Instead of ?page=2, ?page=3, etc., it produces links like ?from=11, ?from=21 and so on. This gives the following benefits:

  • The pagination works extremely fast even on huge data sets. For example, on Postgres "normal" pagination may take seconds (or even minutes) on queries like ?page=1000000.
  • It prevents duplicates on next page when new data is injected at top and shifts page boundaries (this is especially important for AJAX pagination).

The drawback is that there is no navigation to arbitrary page number and no reverse navigation, it's always only the link to "Next page" (or nothing at the last page).

Installation

pip install django-sequential-pagination

Usage

Add django_sequential_pagination to INSTALLED_APPS:

# settings.py

INSTALLED_APPS = [
    ...
    'django_sequential_pagination',
]

Pass an ordered queryset to the template:

# views.py

def recent_posts(request):
    return render(request, "blog/posts.html", {
        'posts': Post.objects.all().order_by('-time', '-id'),
    })

Make sure that the ordering always has a tie breaker as the last key, otherwise you may get duplicates on page boundaries.

Now, paginate objects in the template:

{% load pagination %}

{% paginate posts per_page=10 as page %}

{% for post in page.objects %}
    <div>Post #{{ post.id }}</div>
{% endfor %}

{% if page.next_page_url %}
    <a href="{{ page.next_page_url }}">Next</a>
{% endif %}

Settings

You can override the default settings in your settings.py:

SEQUENTIAL_PAGINATION_PER_PAGE = 20
SEQUENTIAL_PAGINATION_KEY = 'from'  # querystring key to use, as in ?from=XXXX

django-el-pagination

You can enable endless pagination with django-el-pagination by putting this in the page template:

{% paginate posts per_page=10 key='page' as page %}

{% for post in page.objects %}
    <div>Post #{{ post.id }}</div>
{% endfor %}

{% if page.next_page_url %}
    <nav class="endless_container">
        <ul class="pagination"><!-- Bootstrap v3 styles -->
            <li>
                <a class="endless_more" href="{{ page.next_page_url }}" rel="{{ page.key }}">Show more</a>
            </li>
        </ul>
    </nav>
{% endif %}

<script>
    $.endlessPaginate({paginateOnScroll: true});
</script>

Make sure the pagination key (or SEQUENTIAL_PAGINATION_KEY) matches your AjaxListView.key. The defaults are different (from and page, respectively).

Jinja2

If Jinja2 is installed, django_sequential_pagination.templatetags.pagination will be a jinja2.contextfunction.

Additionally, if django_jinja is installed, it will be registered automatically as a global template function, so you can use it right away:

{% set page = paginate(posts, per_page=10) %}

{% for post in page.objects %}
    <div>Post #{{ post.id }}</div>
{% endfor %}

{% if page.next_page_url %}
    <a href="{{ page.next_page_url }}">Next</a>
{% endif %}

django-sequential-pagination's People

Contributors

ilyasemenov avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.