https://github.com/Log1x/pagi

A better WordPress pagination.
https://github.com/Log1x/pagi

pagination wordpress

Last synced: 1 day ago
JSON representation

A better WordPress pagination.

• Host: GitHub
• URL: https://github.com/Log1x/pagi
• Owner: Log1x
• License: mit
• Created: 2019-11-11T04:11:54.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-07-16T09:06:34.000Z (4 months ago)
• Last Synced: 2024-11-06T03:43:35.304Z (6 days ago)
• Topics: pagination, wordpress
• Language: PHP
• Homepage: https://github.com/Log1x/pagi
• Size: 40 KB
• Stars: 51
• Watchers: 6
• Forks: 8
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Pagi

![Latest Stable Version](https://img.shields.io/packagist/v/log1x/pagi?style=flat-square)

![Total Downloads](https://img.shields.io/packagist/dt/log1x/pagi?style=flat-square)

![Build Status](https://img.shields.io/github/actions/workflow/status/log1x/pagi/compatibility.yml?branch=master&style=flat-square)

A better WordPress pagination utilizing [Laravel's Pagination](https://laravel.com/docs/master/pagination).

## Requirements

- [Sage](https://github.com/roots/sage) >= 10.0

- [PHP](https://secure.php.net/manual/en/install.php) >= 8.0

- [Composer](https://getcomposer.org/download/)

## Installation

Install via Composer:

```bash

$ composer require log1x/pagi

```

## Usage

### Basic Usage

```php

use Log1x\Pagi\PagiFacade as Pagi;

$pagination = Pagi::build();

return $pagination->links();

```

### Customization

To customize the view, simply publish it:

```bash

$ wp acorn vendor:publish --provider='Log1x\Pagi\PagiServiceProvider'

```

To use the newly generated view:

```php

return $pagination->links('components.pagination');

```

For additional configuration, check out the [Laravel Pagination](https://laravel.com/docs/master/pagination) documentation.

## Bug Reports

If you discover a bug in Pagi, please [open an issue](https://github.com/log1x/pagi/issues).

## Contributing

Contributing whether it be through PRs, reporting an issue, or suggesting an idea is encouraged and appreciated.

## License

Pagi is provided under the [MIT License](https://github.com/log1x/pagi/blob/master/LICENSE.md).