Metadata-Version: 2.1
Name: fluentcms-pager
Version: 3.0
Summary: Bootstrap 3 Pager element for django-fluent-contents
Home-page: https://github.com/edoburu/fluentcms-pager
Author: Diederik van der Boor
Author-email: opensource@edoburu.nl
License: Apache 2.0
Download-URL: https://github.com/edoburu/fluentcms-pager/zipball/master
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Framework :: Django
Classifier: Framework :: Django :: 2.2
Classifier: Framework :: Django :: 3.1
Classifier: Framework :: Django :: 3.2
Classifier: Framework :: Django :: 4.0
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires: Django (>=2.2)
Requires-Dist: django-fluent-contents (>=2.0)

fluentcms-pager
===============

.. image:: https://img.shields.io/travis/django-fluent/fluentcms-pager/master.svg?branch=master
    :target: http://travis-ci.org/django-fluent/fluentcms-pager
.. image:: https://img.shields.io/pypi/v/fluentcms-pager.svg
    :target: https://pypi.python.org/pypi/fluentcms-pager/
.. image:: https://img.shields.io/badge/wheel-yes-green.svg
    :target: https://pypi.python.org/pypi/fluentcms-pager/
.. image:: https://img.shields.io/pypi/l/fluentcms-pager.svg
    :target: https://pypi.python.org/pypi/fluentcms-pager/
.. image:: https://img.shields.io/codecov/c/github/django-fluent/fluentcms-pager/master.svg
    :target: https://codecov.io/github/django-fluent/fluentcms-pager?branch=master

Displaying a Bootstrap 3 pager_ in a page

Features:

* Arrows
* Previous/next links
* Automatic title retrieval


Installation
============

First install the module, preferably in a virtual environment. It can be installed from PyPI:

.. code-block:: bash

    pip install fluentcms-pager

First make sure the project is configured for django-fluent-contents_.

Then add the following settings:

.. code-block:: python

    INSTALLED_APPS += (
        'fluentcms_pager',
    )

The database tables can be created afterwards:

.. code-block:: bash

    ./manage.py migrate


Frontend styling
================

The pager is renderd with the HTML that Bootstrap prescribes:

.. code-block:: html+django

    <ul class="pager">
      <li class="previous"><a href="#"><span aria-hidden="true">&larr;</span> Older</a></li>
      <li class="next"><a href="#">Newer <span aria-hidden="true">&rarr;</span></a></li>
    </ul>

The standard Bootstrap 3 CSS will provide a reasonable styling for this,
which can either be overwritten, or replaced in your own CSS files.


Contributing
------------

If you like this module, forked it, or would like to improve it, please let us know!
Pull requests are welcome too. :-)

.. _django-fluent-contents: https://github.com/django-fluent/django-fluent-contents
.. _pager: http://getbootstrap.com/components/#pagination-pager


