Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stefangabos/Zebra_Pagination
A generic, Twitter Bootstrap compatible, pagination library for automatically generating navigation links
https://github.com/stefangabos/Zebra_Pagination
pagination pagination-generator pagination-library pagination-links pagination-script php
Last synced: 21 days ago
JSON representation
A generic, Twitter Bootstrap compatible, pagination library for automatically generating navigation links
- Host: GitHub
- URL: https://github.com/stefangabos/Zebra_Pagination
- Owner: stefangabos
- License: other
- Created: 2013-07-15T07:26:06.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2024-06-19T16:30:02.000Z (5 months ago)
- Last Synced: 2024-09-21T11:41:37.017Z (about 2 months ago)
- Topics: pagination, pagination-generator, pagination-library, pagination-links, pagination-script, php
- Language: PHP
- Homepage: https://stefangabos.github.io/Zebra_Pagination/Zebra_Pagination/Zebra_Pagination.html
- Size: 305 KB
- Stars: 113
- Watchers: 15
- Forks: 77
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Zebra Pagination [](https://twitter.com/intent/tweet?text=A+generic,+Twitter+Bootstrap+compatible,+pagination+library+that+automatically+generates+navigation+links&url=https://github.com/stefangabos/Zebra_Pagination&via=stefangabos&hashtags=php)
*A generic, Twitter Bootstrap compatible, pagination library that automatically generates navigation links*
[](https://packagist.org/packages/stefangabos/zebra_pagination) [](https://packagist.org/packages/stefangabos/zebra_pagination) [](https://packagist.org/packages/stefangabos/zebra_pagination) [](https://packagist.org/packages/stefangabos/zebra_pagination) [](https://packagist.org/packages/stefangabos/zebra_pagination)
A generic, [Twitter Bootstrap](http://getbootstrap.com) compatible (versions 3, 4 and 5), pagination script that automatically generates navigation links as well as next/previous page links, given the total number of records and the number of records to be shown per page. Useful for breaking large sets of data into smaller chunks, reducing network traffic and, at the same time, improving readability, aesthetics and usability.
Adheres to pagination best practices (provides large clickable areas, doesn't use underlines, the selected page is clearly highlighted, page links are spaced out, provides "previous page" and "next page" links, provides "first page" and "last page" links - as outlined in an article by Faruk Ates from 2007, which can now be found [here](https://gist.github.com/622561), can generate links both in natural as well as in reverse order, can be easily, localized, supports different positions for next/previous page buttons, supports page propagation via GET or via URL rewriting, is SEO-friendly, and the appearance is easily customizable through CSS.
> Please note that this is a *generic* pagination script, meaning that it does not display any records and it does not have any dependencies on database connections or SQL queries, making it very flexible! It is up to the developer to fetch the actual data and display it based on the information returned by this pagination script. The advantage is that it can be used to paginate over records coming from any source like arrays or databases.
The code is heavily commented and generates no warnings/errors/notices when PHP's error reporting level is set to E_ALL.
## Features
- it is a generic library: can be used to paginate records both from an array or from a database
- it automatically generates navigation links, given the total number of items and the number of items per page (examples of best practices are also included)
- navigation links can be generated in natural or in reverse order
- it is SEO-friendly - it solves the problem of duplicate content on the first page without navigation and the first page having the page number in the URL
- appearance is easily customizable through CSS
- compatible with [Twitter Bootstrap](http://getbootstrap.com) versions 3, 4 and 5
- code is heavily commented and generates no warnings/errors/notices when PHP's error reporting level is set to E_ALL
- has [awesome documentation](https://stefangabos.github.io/Zebra_Pagination/Zebra_Pagination/Zebra_Pagination.html)
## :notebook_with_decorative_cover: Documentation
Check out the [awesome documentation](https://stefangabos.github.io/Zebra_Pagination/Zebra_Pagination/Zebra_Pagination.html)!
## 🎂 Support the development of this project
Your support means a lot and it keeps me motivated to keep working on open source projects.
If you like this project please ⭐ it by clicking on the star button at the top of the page.
If you are feeling generous, you can buy me a coffee by donating through PayPal, or you can become a sponsor.
Either way - **Thank you!** 🎉
[
](https://github.com/stefangabos/Zebra_Pagination) [](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=SKXN7C6PPH6FL) [
](https://github.com/sponsors/stefangabos)
## Requirements
PHP 5+
## Installation
You can install Zebra Pagination via [Composer](https://packagist.org/packages/stefangabos/zebra_pagination)
```bash
# get the latest stable release
composer require stefangabos/zebra_pagination
# get the latest commit
composer require stefangabos/zebra_pagination:dev-master
```
Or you can install it manually by downloading the latest version, unpacking it, and then including it in your project
```php
require_once 'path/to/Zebra_Pagination.php';
```
## How to use
Make sure that in the of your page you have
```html
```
If you want to preserve hashes in the URL, also include the JavaScript file – simply including it will suffice;
(jQuery needs to also be loaded before loading this file)
```javascript
```
Paginate data from an array:
**The PHP**
```php
records(count($countries));
// records per page
$pagination->records_per_page($records_per_page);
// here's the magic: we need to display *only* the records for the current page
$countries = array_slice(
$countries,
(($pagination->get_page() - 1) * $records_per_page),
$records_per_page
);
?>
Country
$country): ?>
>
render();
```
Would result is something like
You can set the navigation links' position to the left or to the right of the pagination links using the [navigation_position()](https://stefangabos.github.io/Zebra_Pagination/Zebra_Pagination/Zebra_Pagination.html#methodnavigation_position) method:
```php
$pagination->navigation_position('left');
```
```php
$pagination->navigation_position('right');
```
Labels for "Previous" and "Next" links can be changed with the [labels()](https://stefangabos.github.io/Zebra_Pagination/Zebra_Pagination/Zebra_Pagination.html#methodlabels) method:
```php
$pagination->labels('Previous', 'Next');
```
You can also have HTML markup as labels making it easy to include font icons like the ones from [Font Awesome](https://fontawesome.com/)
```php
$pagination->labels('', '');
```
Using *condensed navigation* where only links to first, last, next and previous pages are available. Useful when there isn't enough space for a full blown pagination.
```php
$pagination->condensed();
```
Using *extra condensed navigation* where only links next and previous pages are available. Useful when there isn't enough space for a full blown pagination.
```php
$pagination->condensed(true);
```
Paginate data from MySQL:
```php
get_page() - 1) * $records_per_page) . ', ' . $records_per_page . '
';
// execute the MySQL query
// (you will use mysqli or PDO here, but you get the idea)
$result = mysqli_query($connection, $sql) or die(mysqli_error($connection));
// fetch the total number of records in the table
$rows = mysqli_fetch_assoc(mysqli_query($connection, 'SELECT COUNT(*) AS rows FROM countries'));
// pass the total number of records to the pagination class
$pagination->records($rows['rows']);
// records per page
$pagination->records_per_page($records_per_page);
?>
Country
>
render();
```
Paginate data from MySQL in reverse order:
```php
reverse(true);
// when showing records in reverse order, we need to know the total number
// of records from the beginning
$result = mysqli_query($connection, 'SELECT COUNT(*) AS rows FROM countries'))) or die (mysqli_error());
// pass the total number of records to the pagination class
$pagination->records(array_pop(mysqli_fetch_assoc($result)));
// records per page
$pagination->records_per_page($records_per_page);
// the MySQL statement to fetch the rows
// note the LIMIT - use it exactly like that!
// also note that we're ordering data descendingly - most important when we're
// showing records in reverse order!
$sql = '
SELECT
country
FROM
countries
ORDER BY
country DESC
LIMIT
' . (($pagination->get_pages() - $pagination->get_page()) * $records_per_page) . ', ' . $records_per_page . '
';
// run the query
mysqli_query($connection. $sql) or die(mysqli_error($connection));
?>
Country
>
render();
```
Would result in something like
