This package adds the paginate route method to support pagination via custom routes instead of query strings. This also allows for easily translatable pagination routes ex. /news/page/2, /nieuws/pagina/2.
Via Composer
composer require web-ruslan/laravel-pretty-paginationFirst register the service provider and facade in your application.
// config/app.php
'providers' => [
...
'WebRuslan\PaginateRoute\PaginateRouteServiceProvider',
];
'aliases' => [
...
'PaginateRoute' => 'WebRuslan\PaginateRoute\PaginateRouteFacade',
];Then register the macros in App\Providers\RouteServiceProvider::boot().
// app/Providers/RouteServiceProvider.php
use WebRuslan\PaginateRoute\PaginateRouteFacade as PaginateRoute;
// ...
public function boot()
{
PaginateRoute::registerMacros(); // Add this line
parent::boot();
}The paginate route macro will register two routes for you.
// app/Http/routes.php
// Generates /users & /users/page/{page}
Route::paginate('users', 'UsersController@index');In your route's action you can just use Laravel's regular pagination methods.
// app/Http/Controllers/UsersController.php
public function index()
{
return view('users.index', ['users' => \App\User::simplePaginate(5)]);
}If you want to customize paginator base url just use setPath function
public function index()
{
$users = \App\User::simplePaginate(5);
$users->setPath('custom/url');
return view('users.index', ['users' => $users]);
}If you want to customize or add translations for the "page" url segment, you can publish the language files.
php artisan vendor:publish --provider="WebRuslan\PaginateRoute\PaginateRouteServiceProvider"Since Laravel's paginator url's will still use a query string, PaginateRoute has it's own url generator and page helper functions.
@if(PaginateRoute::hasPreviousPage())
<a href="{{ PaginateRoute::previousPageUrl() }}">Previous</a>
@endif
@if(PaginateRoute::hasNextPage($users))
<a href="{{ PaginateRoute::nextPageUrl($users) }}">Next</a>
@endif
The nextPage functions require the paginator instance as a parameter, so they can determine whether there are any more records.
/**
* @param \Illuminate\Contracts\Pagination\Paginator $paginator
* @return int|null
*/
public function nextPage(Paginator $paginator)/**
* @param \Illuminate\Contracts\Pagination\Paginator $paginator
* @return bool
*/
public function hasNextPage(Paginator $paginator)/**
* @param \Illuminate\Contracts\Pagination\Paginator $paginator
* @return string|null
*/
public function nextPageUrl(Paginator $paginator)/**
* @param \Illuminate\Contracts\Pagination\Paginator $paginator
* @return int|null
*/
public function previousPage(Paginator $paginator)/**
* @return bool
*/
public function hasPreviousPage()/**
* @param bool $full
* @return string|null
*/
public function previousPageUrl($full = false)/**
* @param \Illuminate\Contracts\Pagination\Paginator $paginator
* @param int $page
* @param bool $full
* @return string
*/
public function pageUrl(Paginator $paginator, $page, $full = false)If $full is true, the first page will be a fully qualified url. Ex. /users/page/1 instead if just /users (this is the default).
To retrieve the url of a specific page of a paginated route, that isn't the current route, there's the addPageQuery function.
/**
* @param string $url
* @param int $page
* @param bool $full
* @return string
*/
public function addPageQuery($url, $page, $full = false)You can also retrieve an array with all available urls. These can be rendered as a plain html list with page numbers. Note that these functions require a LengthAwarePaginator.
/**
* @param \Illuminate\Contracts\Pagination\LengthAwarePaginator $paginator
* @param bool $full
* @return array
*/
public function allUrls(LengthAwarePaginator $paginator, $full = false)/**
* @param \Illuminate\Contracts\Pagination\LengthAwarePaginator $paginator
* @param bool $full
* @param array $styles
* @param bool $additionalLinks
* @return string
*/
public function renderPageList(LengthAwarePaginator $paginator, $full = false, $styles = null, $additionalLinks = false)/**
* Example : {!! PaginateRoute::renderPageList($items,true,null,true) !!}
*/
<!-- Example output: -->
<ul>
<li><a href="http://example.com/news">1</a></li>
<li><a href="http://example.com/news/page/2">2</a></li>
<li class="active"><a href="http://example.com/news/page/3">3</a></li>
<li><a href="http://example.com/news/page/4">4</a></li>
<li><a href="http://example.com/news/page/4">»</a></li>
</ul>You can add styles for paginator like this:
/**
* Example : {!! PaginateRoute::renderPageList($companies, false,
* [
* 'ul' => 'pagination-list',
* 'li' => 'pagination-list-item',
* 'a' => 'pagination-list-link',
* 'previous_a' => 'pagination-prev',
* 'next_a' => 'pagination-next',
* 'active_a' => 'pagination-active',
* 'previous_label' => '<i class="fas fa-chevron-left"></i>',
* 'next_label' => '<i class="fas fa-chevron-right"></i>',
* ],
* true) !!}
*/
<!-- Example output: -->
<ul class="pagination-list">
<li class="pagination-list-item">
<a href="http://example.com/news" class="pagination-prev"><i class="fas fa-chevron-left"></i></a>
</li>
<li class="pagination-list-item">
<a href="http://example.com/news/page/2" class="pagination-list-link pagination-active">2</a>
</li>
<li class="pagination-list-item">
<a href="http://example.com/news/page/3" class="pagination-list-link">3</a>
</li>
<li class="pagination-list-item">
<a href="http://example.com/news/page/4" class="pagination-list-link">4</a>
</li>
<li class="pagination-list-item">
<a href="http://example.com/news/page/5" class="pagination-list-link">4</a>
</li>
<li class="pagination-list-item">
<a href="http://example.com/news/page/3" class="pagination-next"><i class="fas fa-chevron-right"></i></a>
</li>
</ul>You can render link tags to mark previous and next page for SEO. Note that these functions require a LengthAwarePaginator.
/**
* @param \Illuminate\Contracts\Pagination\LengthAwarePaginator $paginator
* @param bool $full
* @return string
*/
public function renderRelLinks(LengthAwarePaginator $paginator, $full = false)<!-- Example output: -->
<link rel="prev" href="http://example.com/news/page/2" />
<link rel="next" href="http://example.com/news/page/4" />The package contains some integration/smoke tests, set up with Orchestra. The tests can be run via phpunit.
$ phpunit
- Bootstrap 4.* supported pagination rendering.
Please see CONTRIBUTING for details.
If you discover any security related issues, please email webruslan@gmail.com instead of using the issue tracker.
The MIT License (MIT). Please see License File for more information.