letsjump / yii2-anchorjs

为您的Yii文档添加深度锚点链接

维护者

详细信息

github.com/letsjump/yii2-anchorjs

源代码

问题

安装: 16

依赖者: 0

建议者: 0

安全: 0

星星: 0

关注者: 2

分支: 0

开放问题: 0

v1.0.0 2020-02-15 15:37 UTC

Requires

MIT b6f18a12fe7898150aef04cdfec642d86a1bba7c

  • letsjump <letsjump.woop@gmail.com>

documentationjavascriptbloglinkanchoryii2

This package is auto-updated.

Last update: 2024-09-16 18:00:11 UTC

README

为AnchorJS提供的Yii2包装器，可向您的Yii文档添加深度锚点链接。

概述

AnchorJS让您能够在任何网页上添加深度锚点链接（就像这些一样），并轻松导航。

您不需要设置ID或担心URL。如果您的网站已有ID，AnchorJS会尊重它们；如果没有，它将生成它们。

默认情况下，它使用一个吸引人的链接图标，但您可以通过选项和CSS样式来自定义显示方式。以下示例展示了几个自定义想法。

最后，AnchorJS轻量级、易于访问且无依赖。

示例：[The bootstrap manual](https://bootstrap.ac.cn/docs/3.4/javascript/)

bootstrap

安装

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

运行以下命令

php composer.phar require --prefer-dist letsjump/yii2-anchorjs "*"

或

"letsjump/yii2-anchorjs": "*"

将以下内容添加到您的composer.json文件的require部分。

使用方法

一旦安装了扩展，只需在任何需要它的视图中添加此内容即可。有关更详细的用法指南，请参阅插件文档页面。

<?= \letsjump\AnchorJS\AnchorJS::widget([
        'add' => 'h1, h2',
        'options' => [
            'placement'=>'right', 
            'icon'=>'',
            // ... refer to https://www.bryanbraun.com/anchorjs/#options for any option available
        ], 
]); ?>

全局配置

您可以通过将选项添加到您的/app/config/params.php来设置全局配置。

<?php

return [
    'adminEmail' => 'admin@example.com',
    'anchorjs'   => [
        'placement' => 'left',
        'icon' => ''
        // ... refer to https://www.bryanbraun.com/anchorjs/#options for any option available
    ],
];

贡献