README

Cycle2 jQuery 幻灯片展示组件，适用于 Yii 2.0

yii2-cycle2 是一个组件，用于在 Yii 2.0 PHP 框架中渲染优秀的 Cycle2 jQuery 幻灯片组件。类似于 GridView，其数据来自一个 ActiveDataProvider（或更一般地，来自继承自 BaseDataProvider 的类）。

Yii2-cycle2 的演示在此处：http://www.sjaakpriester.nl/software/cycle。

安装

使用 Composer 安装 yii2-cycle2。您可以将以下内容添加到您的 composer.json 文件的 require 部分：

"sjaakp/yii2-cycle2": "*"

或者运行

composer require sjaakp/yii2-cycle2 "*"

您可以通过下载 ZIP 格式的源代码来手动安装 yii2-cycle2。

使用 yii2-cycle2

yii2-cycle2 实现了 Cycle 类的组件。它从 ActiveDataProvider、ArrayDataProvider 或其他继承自 BaseDataProvider 的类中获取数据。使用它的方法类似于使用 GridView。例如，在控制器中您可能会有如下代码：

<?php
// ...
public function actionPie()	{
	$dataProvider = new ActiveDataProvider([
		'query' => NicePlace::find(),
	    'pagination' => false
	]);
	
	return $this->render('cycle', [
		'dataProvider' => $dataProvider
	]);
}
// ...
?>

为了在视图中渲染 Cycle，我们可以使用以下代码：

<?php
use sjaakp\cycle\Cycle;
?>
...
<?= Cycle::widget([
    'dataProvider' => $dataProvider,
	'imgAttribute' => 'photo',
    'captionAttributes' => [
        'name',
        'country'
    ],
    'overlayAttributes' => [
        'description'
    ],
    'options' => [
        'speed' => 2000
    ],
]) ?>
...

选项

Cycle 具有以下选项：

dataProvider

组件的数据提供者。此属性是必需的。在大多数情况下，它将是一个 ActiveDataProvider 或一个 ArrayDataProvider。

imgAttribute

图片属性，必需。

string：包含幻灯片图片源 URL 的属性的名称。注意，这可能是一个虚拟属性。
callable：一个具有签名 function($model, $widget) 的可调用函数，返回幻灯片图片的源 URL。

urlAttribute

链接 URL 属性，可选。

null：幻灯片不包含链接（默认）。
string：包含幻灯片链接 URL 的属性的名称。注意，这可能是一个虚拟属性。
callable：一个具有签名 function($model, $widget) 的可调用函数，返回幻灯片的链接 URL。

tooltipAttribute

工具提示属性，可选。

null：幻灯片没有工具提示（默认）。
string：包含幻灯片工具提示文本或 HTML 的属性的名称。注意，这可能是一个虚拟属性。
callable：一个具有签名 function($model, $widget) 的可调用函数，返回幻灯片工具提示的文本或 HTML。

显示在标题或覆盖层中的属性，包括 captionAttributes 和 overlayAttributes

请参阅 Cycle2 文档。

成员可以是以下之一：

string：包含标题或覆盖层元素文本或 HTML 的属性的名称；
<key> => <value> 其中 <key> 是名称，<value> 是
- 属性名称；
- 或者一个具有签名 function($model, $widget) 的可调用函数，返回文本或 HTML。

属性值将在 Cycle 的标题或覆盖 div 中渲染，每个值都在自己的 span 元素内，元素类名为 "slide-<key>"。

内容

除了幻灯片、标题和覆盖之外，Cycle 容器中的额外元素。可以填充如 '<div class="cycle-pager"></div>'（见：Cycle2 分页器）等元素。

插件

Cycle2 jQuery 小部件的插件。**注意**，yii2-cycle2 尝试自动加载所需的插件。

选项

底层 Cycle2 jQuery 小部件的客户端选项。**注意**，选项名称必须为驼峰式。

htmlOptions

Cycle 容器的 HTML 选项。如果您想明确设置 ID，请使用此选项。

slideOptions

每个幻灯片的 HTML 选项。一个用途是将此设置为：[ 'target' => '_blank' ]

sjaakp / yii2-cycle2

维护者

详细信息