dierrickus / yii2-pagesize-widget
用于在 GridView 中启用动态页面大小选择的 Widget
v2.0.3
2017-02-25 11:55 UTC
Requires
- yiisoft/yii2: *
Requires (Dev)
This package is not auto-updated.
Last update: 2024-09-14 20:03:59 UTC
README
PageSize widget 是 Yii2 GridView 的一个扩展,允许更改 GridView 中的页面大小。
安装
安装此扩展的首选方式是通过 composer。
运行以下命令之一
php composer.phar require --prefer-dist integready/yii2-pagesize-widget "*"
或
"integready/yii2-pagesize-widget": "*"
将其添加到您的 composer.json
文件的 require 部分。
使用方法
要使用此 widget 与 GridView,请将此 widget 添加到包含 GridView 的视图中
<?php echo \integready\pagesize\PageSize::widget(); ?>
并设置 GridView 的 filterSelector
属性,如下例所示。
<?= GridView::widget([ 'dataProvider' => $dataProvider, 'filterModel' => $searchModel, 'filterSelector' => 'select[name="per-page"]', 'columns' => [ ... ], ]); ?>
请注意,这里的 per-page
是用于 PageSize widget 的 pageSizeParam
设置的字符串。
配置
以下属性可用于自定义 widget。
label
: 标签的文本defaultPageSize
: 如果未选择页面大小,将使用此值pageSizeParam
: 用于网格视图分页 widget 的页面大小参数的名称sizes
: 用于页面大小的键值数组。键和值都应为整数template
: 用于渲染元素的模板字符串。默认为'{list} {label}'
options
:<select>
元素的 HTML 属性labelOptions
:<label>
元素的 HTML 属性encodeLabel
: 是否对标签文本进行编码