sjaakp / yii2-collapse
为 Yii 2.0 框架提供的折叠和手风琴小部件
Requires
- yiisoft/yii2: *
This package is auto-updated.
Last update: 2024-08-29 14:29:55 UTC
README
Yii2-collapse 为 Yii 2.0 PHP 框架提供三个小部件
-
折叠 渲染带有切换链接和可折叠面板的 Bootstrap 折叠 元素;
-
折叠组 包含两个或更多 折叠,其中只有一个可以打开;
-
手风琴 渲染带有多个面板的 Bootstrap 手风琴 元素,其中只有一个可以打开。本质上,手风琴 是一种 折叠组。不同之处在于,折叠 都是周围元素的直接子元素。
所有三个小部件都可以与 Bootstrap 3.x 或 Bootstrap 4.x 一起使用。
小部件的演示 在此。
安装
使用 Composer 以常规方式安装 yii2-collapse。将以下内容添加到您的 composer.json
文件的 require 部分
"sjaakp/yii2-collapse": "*"
或者运行
composer require sjaakp/yii2-collapse
您可以手动通过 下载 ZIP 格式的源代码 来安装 yii2-collapse。
使用折叠小部件
在 Yii2 视图文件中使用 折叠 小部件可以像这样简单:
<?php
use sjaakp\collapse\Collapse;
?>
...
<?php Collapse::begin('Details') ?>
<h4>Some more details</h4>
<p>The first detail... </p>
<?php Collapse::end() ?>
...
在 begin()
和 end()
之间的 HTML 可以是您想要的任何复杂程度。
除了使用标签文本初始化 折叠 之外,还可以使用几个选项的 array
初始化它,例如
<?php
use sjaakp\collapse\Collapse;
?>
...
<?php Collapse::begin([
'label' => 'Details',
'options' => [ 'class' => 'bg-info' ], // give the panel an extra class
'open' => true // initially open the panel
]) ?>
<h4>Some more details</h4>
<p>The first detail... </p>
<?php Collapse::end() ?>
...
使用折叠组小部件
可以像这样使用 折叠组 小部件
<?php
use sjaakp\collapse\CollapseGroup;
?>
...
<?php CollapseGroup::begin([/* options */]) ?>
...
<?php CollapseGroup::beginCollapse('Details) ?>
<h4>Some details</h4>
<p>The first detail... </p>
<?php CollapseGroup::endCollapse() ?>
...
<?php CollapseGroup::beginCollapse('More details) ?>
<h4>Some more details</h4>
<p>The first detail... </p>
<?php CollapseGroup::endCollapse() ?>
...
<?php CollapseGroup::end() ?>
...
beginCollapse()
也可以用 折叠 选项的 array
初始化。
使用手风琴小部件
如下使用 手风琴 小部件
<?php
use sjaakp\collapse\Accordion;
?>
...
<?php Accordion::begin('Details') ?>
<h4>Some details</h4>
<p>The first detail... </p>
<?php Accordion::next('More details') ?>
<h4>Some more details</h4>
<p>The tenth detail... </p>
<?php Accordion::next('Even more details') ?>
<h4>Even some more details</h4>
<p>The twentieth detail... </p>
<?php Accordion::end() ?>
...
与 折叠 一样,手风琴 也可以使用几个选项的 array
初始化。
常见选项
折叠 和 手风琴(但 不是 折叠组)都具有以下选项
- 标签
string
(第一个)标签的文本。 - 编码
bool
是否对标签(们)进行 HTML 编码。默认:true
。 - 打开
bool
(第一个)面板是否最初是打开的。默认:false
(折叠),true
(手风琴)。 - 切换选项
array
切换链接(们)的 HTML 选项。默认:['class' => 'btn-collapse']
。此类将三角形样式应用于切换链接。
折叠选项
- 选项
array
面板的 HTML 选项。'tag'
是一个特殊选项,定义 HTML 标签。如果没有设置,HTML 标签是'div'
。
折叠组选项
- 选项
array
包围元素的 HTML 选项。'tag'
是一个特殊选项,定义 HTML 标签。如果没有设置,HTML 标签是'div'
。
手风琴选项
-
选项
array
包围元素的 HTML 选项。'tag'
是一个特殊选项,定义 HTML 标签。如果没有设置,HTML 标签是'div'
。 -
面板选项
array
面板的 HTML 选项。