README

基于 Smooth Scroll 库的 Yii2 平滑滚动组件

安装

推荐的安装方式是通过 Composer

php composer.phar require grptx/yii2-smooth-scroll:^1

或者，您可以在 composer.json 文件的 require 部分添加

"grptx/yii2-smooth-scroll": "^1"

并执行 php composer.phar update。

使用方法

要将平滑滚动功能添加到页面中，请在视图中添加

use grptx\smoothscroll\SmoothScrollWidget;

SmoothScrollWidget::widget();

选项

小部件可用选项如下

selector（默认 a[href*="#"]）
name（滚动的 JavaScript 变量名，默认 scroll）
options（由库定义的选项数组，cfr: https://github.com/cferdinandi/smooth-scroll#global-settings）

示例

SmoothScrollWidget::widget([
    'selector' => 'a[href*="#"]',
    'name' => 'myScroll',
    'options' => [
        'header' => ...
        'speed' => ...
        // etc ..
    ],
]);

grptx / yii2-smooth-scroll

维护者

详细信息

README

安装

使用方法

选项

示例