Skip to content

Add pageSizeOptions and goToPageLabel options for LinkPager #102

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
taobig wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add pageSizeOptions and goToPageLabel options for LinkPager #102

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e720f58
Add pageSizeOptions and goToPageLabel options for LinkPager
taobig Jul 7, 2025
29c6b03
Update pageSizeOptions documentation for clarity
taobig Jul 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 59 additions & 0 deletions src/LinkPager.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@

namespace yii\bootstrap5;

use Yii;
use yii\base\InvalidConfigException;
use yii\data\Pagination;
use yii\helpers\ArrayHelper;
Expand Down Expand Up @@ -148,6 +149,17 @@ class LinkPager extends Widget
*/
public $disableCurrentPageButton = false;

/**
* @var array Options array for records per page in the pager dropdown. If empty, the page size selection dropdown will not be shown.
* e.g. [5 => '5 per page', 10 => '10 per page', 20 => '20 per page', 50 => '50 per page'] The key is the page size, and the value is the display text.
*/
public $pageSizeOptions = [];

/**
* @var string|bool the text label for the "goto" page area. Note that this will NOT be HTML-encoded.
* If this property is false, the "goto" page area will not be displayed.
*/
public $goToPageLabel = false;

/**
* Initializes the pager.
Expand Down Expand Up @@ -208,6 +220,8 @@ protected function renderPageButtons(): string
}

$buttons = [];
$buttons[] = $this->renderSelectPageSize();

$currentPage = $this->pagination->getPage();

// first page
Expand Down Expand Up @@ -274,12 +288,57 @@ protected function renderPageButtons(): string
);
}

$buttons[] = $this->renderGoToPage();

$options = $this->listOptions;
$tag = ArrayHelper::remove($options, 'tag', 'ul');

return Html::tag($tag, implode("\n", $buttons), $options);
}

protected function renderSelectPageSize(): string
{
$html = '';
if (!empty($this->pageSizeOptions)) {
$html .= '<li class="me-2">';
$html .= Html::dropDownList(
$this->pagination->pageSizeParam,
$this->pagination->getPageSize(),
$this->pageSizeOptions,
[
'class' => 'form-select',
'onchange' => "location.href='" . $this->pagination->createUrl(0) . "&" . $this->pagination->pageSizeParam . "=' + this.value;",
],
);
$html .= '</li>';
}
return $html;
}

protected function renderGoToPage(): string
{
$currentPage = $this->pagination->getPage();
$totalPages = $this->pagination->getPageCount();

$html = '';
if ($this->goToPageLabel !== false) {
$text = $this->goToPageLabel === true ? Yii::t('yii', 'View') : $this->goToPageLabel;
$html .= '<li class="d-flex ms-2">';
$html .= Html::input('number', 'page', $currentPage + 1, [
'class' => 'form-control form-control-sm',
'min' => 1,
'max' => $totalPages,
'id' => 'custom-page-input',
]);
$html .= Html::button($text, [
'class' => 'form-control btn btn-outline-secondary',
'onclick' => "location.href='" . $this->pagination->createUrl(0) . "&" . $this->pagination->pageParam . "=' + (this.parentElement.querySelector('input').value);",
]);
$html .= '</li>';
}
return $html;
}

/**
* Renders a page button.
* You may override this method to customize the generation of page buttons.
Expand Down
Loading