nterms/yii2-listjs-widget

为 Yii2 优化的 List.js 小部件

维护者

详细信息

github.com/nterms/yii2-listjs-widget

主页

源代码

问题

安装: 240

依赖项: 0

建议者: 0

安全: 0

星级: 1

关注者: 2

分支: 3

公开问题: 0

类型:yii2-extension

dev-master 2014-12-19 12:15 UTC

Requires

MIT 46964a34ac067eabea29c5bdc6d5bf5c7daa2458

extensionlistwidgetyii2listjs

This package is not auto-updated.

Last update: 2024-09-24 02:32:05 UTC

README

为 Yii2 优化的 List.js 小部件。这个小部件使 List.js 功能在 Yii2 应用程序中的任何列表或表格中可用。访问 List.js 网站获取更多信息及示例。

安装

安装此扩展的首选方式是通过 composer。

运行

php composer.phar require --prefer-dist nterms/yii2-listjs-widget "*"

或添加

"nterms/yii2-listjs-widget": "*"

到您的 composer.json 文件的 require 部分。

使用

扩展安装完成后，只需在代码中通过

<?= \nterms\listjs\ListJs::begin([
	'id' => 'days-list',
	'search' => true,
	'sort' => [
		'name' => [
			'label' => Yii::t('app', 'Sort by name'),
		],
	],
	'clientOptions' => [
		'valueNames' => ['name'],
	],
]); ?>

<ul class="list">
	<li><div class="name">Sunday</div></li>
	<li><div class="name">Monday</div></li>
	<li><div class="name">Tuesday</div></li>
	<li><div class="name">Wednesday</div></li>
	<li><div class="name">Thursday</div></li>
	<li><div class="name">Friday</div></li>
	<li><div class="name">Saturday</div></li>
</ul>

<?= \nterms\listjs\ListJs::end(); ?>

配置

以下属性可用于自定义小部件。

  • options: 容器元素的 HTML 属性。
  • search: 是否显示搜索字段。
  • searchOptions: 搜索输入标签的 HTML 属性（键值对）。
  • sort: 用于渲染排序按钮列表的键值对列表。值是按钮的 HTML 属性。特殊参数 label 用作按钮文本
     ...
 'sort' => [
  'name' => [
 	 'class' => 'sort',
 	 'label' => Yii::t('app', 'Sort by name'),
  ],
 ],
 ...
  • clientOptions: List.js 的选项。阅读 此 获取选项列表。
  • content: HTML 内容，最好是一个列表或表格。如果小部件用于内容捕获模式，则此属性将被忽略。
  • view: 要渲染内容的视图文件名称。如果小部件用于内容捕获模式或已将字符串分配给 content 属性，则此属性将被忽略。
  • viewParams: 在渲染 view 时传递给 view 的参数。此属性仅在 view 被渲染以生成小部件内容时使用。

许可证

MIT