How do I use pagination with Django class based generic ListViews?

by

I think you ask for information about using pagination with the new class based views since, with traditional function based views, it is easy to find. I found that just by setting the paginate_by variable is enough to activate the pagination. See in Class-based generic views.

For example, in your views.py:

import models
from django.views.generic import ListView

class CarListView(ListView):
    model = models.Car      # shorthand for setting queryset = models.Car.objects.all()
    template_name="app/car_list.html"  # optional (the default is app_name/modelNameInLowerCase_list.html; which will look into your templates folder for that path and file)
    context_object_name = "car_list"    #default is object_list as well as model's_verbose_name_list and/or model's_verbose_name_plural_list, if defined in the model's inner Meta class
    paginate_by = 10  #and that's it !!

In your template (car_list.html), you can include a pagination section like this (we have some context variables available: is_paginated, page_obj, and paginator).

{# .... **Normal content list, maybe a table** .... #}
{% if car_list %}
    <table id="cars">
        {% for car in car_list %}
            <tr>
                <td>{{ car.model }}</td>
                <td>{{ car.year }}</td>
                <td><a href="https://stackoverflow.com/car/{{ car.id }}/" class="see_detail">detail</a></td>
            </tr>
        {% endfor %}
    </table>
    {# .... **Now the pagination section** .... #}
    {% if is_paginated %}
        <div class="pagination">
            <span class="page-links">
                {% if page_obj.has_previous %}
                    <a href="http://stackoverflow.com/cars?page={{ page_obj.previous_page_number }}">previous</a>
                {% endif %}
                <span class="page-current">
                    Page {{ page_obj.number }} of {{ page_obj.paginator.num_pages }}.
                </span>
                {% if page_obj.has_next %}
                    <a href="http://stackoverflow.com/cars?page={{ page_obj.next_page_number }}">next</a>
                {% endif %}
            </span>
        </div>
    {% endif %}
{% else %}
    <h3>My Cars</h3>
    <p>No cars found!!! :(</p>
{% endif %}
{# .... **More content, footer, etc.** .... #}

The page to display is indicated by a GET parameter, simply adding ?page=n, to the URL.

More Related Contents:

  1. Extending the User model with custom fields in Django
  2. log all sql queries
  3. How can I get the full/absolute URL (with domain) in Django?
  4. Django stops working with RuntimeError: populate() isn’t reentrant
  5. How to define two fields “unique” as couple
  6. Creating a extended user profile
  7. Django 1.11 Annotating a Subquery Aggregate
  8. Django File upload size limit
  9. Django ModelForm: What is save(commit=False) used for?
  10. Navigation in django
  11. Inline Form Validation in Django
  12. Django custom managers – how do I return only objects created by the logged-in user?
  13. Django data migration when changing a field to ManyToMany
  14. CSRF Failed: CSRF token missing or incorrect
  15. Django templates: value of dictionary key with a space in it
  16. How can I list urlpatterns (endpoints) on Django?
  17. how to show datepicker calendar on datefield
  18. Order by count of a ForeignKey field?
  19. Django {% static ‘path’ %} in javascript file
  20. Django removing object from ManyToMany relationship
  21. Byte Ranges in Django [closed]
  22. Django ORM: Group by and Max
  23. Log in / Sign up directly on home page
  24. What is the right way to validate if an object exists in a django view without returning 404?
  25. Authorization Credentials Stripped — django, elastic beanstalk, oauth
  26. Django Order By Date, but have “None” at end?
  27. Django query case-insensitive list match
  28. How to limit file types on file uploads for ModelForms with FileFields?
  29. Django: access the parent instance from the Inline model admin
  30. Django: Using F arguments in datetime.timedelta inside a query

Leave a Comment