https://github.com/mvantellingen/django-rangepaginator

Paginator which shows a range of pages around the active one
https://github.com/mvantellingen/django-rangepaginator

django pagination paginator

Last synced: 3 months ago
JSON representation

Paginator which shows a range of pages around the active one

• Host: GitHub
• URL: https://github.com/mvantellingen/django-rangepaginator
• Owner: mvantellingen
• License: mit
• Created: 2016-08-27T14:43:04.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2019-12-27T05:42:25.000Z (about 5 years ago)
• Last Synced: 2024-10-14T16:59:51.470Z (3 months ago)
• Topics: django, pagination, paginator
• Language: Python
• Homepage: http://django-rangepaginator.readthedocs.io
• Size: 84 KB
• Stars: 43
• Watchers: 5
• Forks: 6
• Open Issues: 4
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES
  • License: LICENSE

Awesome Lists containing this project

• starred-awesome - django-rangepaginator - Paginator which shows a range of pages around the active one (Python)

README

        
=====================

django-rangepaginator

=====================

This Django app provides a templatetag to render pagination widgets which include a range of pages around the current active one.

.. image:: docs/_static/example.png?stop-caching-me

Status

======

.. image:: https://travis-ci.org/mvantellingen/django-rangepaginator.svg?branch=master

    :target: https://travis-ci.org/mvantellingen/django-rangepaginator

.. image:: http://codecov.io/github/mvantellingen/django-rangepaginator/coverage.svg?branch=master

    :target: http://codecov.io/github/mvantellingen/django-rangepaginator?branch=master

.. image:: https://img.shields.io/pypi/v/django-rangepaginator.svg

    :target: https://pypi.python.org/pypi/django-rangepaginator/

Installation

============

.. code-block:: shell

   pip install django_rangepaginator

Update your Django settings:

.. code-block:: python

    INSTALLED_APPS += [

        'django_rangepaginator'

    ]

    # Use bootstrap4 template

    RANGE_PAGINATOR_TEMPLATE = 'django_rangepaginator/bootstrap3.html'

    # Use bootstrap3 template (default)

    RANGE_PAGINATOR_TEMPLATE = 'django_rangepaginator/bootstrap4.html'

Usage

=====

.. code-block:: django

    {% load rangepaginator %}

    {% paginate page request=request %}

The following options are available:

- distance: number of pages around current active one (default = 2)

- edge: number of pages at the start and end (default = 1)

- extra_class: add extra css classes to the pagination div (default = '')

- text_labels: use strings for previous/next instead of symbols (default = True)

Demo

====

A sandbox environment is available in the repository, run the following:

.. code-block:: shell

   ./sandbox/manage.py migrate

   ./sandbox/manage.py runserver

Bugs/features

=============

Let me know! :-)