kartik-v/yii2-widget-affix

一个用于突出显示页面部分的滚动跟踪和固定增强导航(从 yii2-widgets 分离的子存储库)

安装次数: 2,950,876

依赖者: 5

建议者: 0

安全性: 0

星级: 15

关注者: 4

分支: 4

开放问题: 1

类型:yii2-extension

v1.0.0 2014-11-09 04:56 UTC

This package is auto-updated.

Last update: 2024-08-29 03:42:08 UTC


README

Latest Stable Version License Total Downloads Monthly Downloads Daily Downloads

扩展 Yii 菜单小部件。此小部件提供了一种 滚动跟踪固定 增强导航(最多2级),以突出显示每个页面的部分和二级部分。固定小部件可以用来生成

  • 侧边栏菜单:将滚动跟踪/固定导航菜单显示为侧边栏,或者
  • 主体内容:根据传递的章节和副章节标题和内容显示主要部分。

注意:如果您将 header 部分固定在顶部,您必须将 CSS 类 kv-header 添加到头部容器中。同样,对于固定页脚,您必须将类 kv-footer 添加到您的页脚容器中。这将确保固定小部件在页面上的正确定位。

要传递的参数是

  • type 固定内容类型。必须是 menubody。默认为 menu
  • items:固定内容项作为数组。查看 固定组合使用 获取详细示例。

注意:此扩展是 yii2-widgets 的子存储库分离出来的。自 2014 年 11 月 8 日起进行分割,以便开发人员在需要时可以单独安装此特定小部件。也可以像以前一样使用整个 yii2-widgets 套件。

安装

安装此扩展的最佳方式是通过 composer。请查看此扩展的 composer.json 文件以获取此扩展的要求和依赖关系。阅读此 网络提示/维基 了解如何为您的应用程序的 composer.json 设置 minimum-stability 设置。

要安装,请运行以下命令之一:

$ php composer.phar require kartik-v/yii2-widget-affix "*"

或将其添加到您的 composer.json 文件的 require 部分:

"kartik-v/yii2-widget-affix": "*"

最新版本

注意:该模块的最新版本是于 2014 年 11 月 8 日发布的 v1.0.0。有关详细信息,请参阅 更改日志

演示

您可以在 使用说明和演示 中查阅有关扩展的详细信息。

使用方法

use kartik\affix\Affix;

$content = 'Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet dolore magna aliquam erat volutpat.';
$items = [[
	'url' => '#sec-1',
	'label' => 'Section 1',
	'icon' => 'play-circle',
	'content' => $content,
	'items' => [
		['url' => '#sec-1-1', 'label' => 'Section 1.1', 'content' => $content],
		['url' => '#sec-1-2', 'label' => 'Section 1.2', 'content' => $content],
		['url' => '#sec-1-3', 'label' => 'Section 1.3', 'content' => $content],
		['url' => '#sec-1-4', 'label' => 'Section 1.4', 'content' => $content],
		['url' => '#sec-1-5', 'label' => 'Section 1.5', 'content' => $content],
	],
]];

// Displays sidebar menu
echo Affix::widget([
	'items' => $items, 
	'type' => 'menu'
]);

// Displays body sections
echo Affix::widget([
	'items' => $items, 
	'type' => 'body'
]);

许可证

yii2-widget-affix 在 BSD 3-Clause 许可证下发布。有关详细信息,请参阅附带 LICENSE.md 文件。