grptx/yii2-smooth-scroll

Smooth Scroll widget for Yii2

v2.0.0 2019-06-23 09:29 UTC

Requires

• bower-asset/smooth-scroll.js: *
• yiisoft/yii2: *

MIT

• grptx

• yii2
• yii2-widget
• smooth-scroll

README

Smooth Scroll component for Yii2 based on Smooth Scroll library

Install

Preferred way to install is through Composer:

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

Or, you may add

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

to the require section of your composer.json file and execute php composer.phar update.

Usage

To add the smooth scroll capability to a page add in the view:

use grptx\smoothscroll\SmoothScrollWidget;

SmoothScrollWidget::widget();

Options

Availables options for the widget are:

• selector (default a[href*="#"])
• name (the javascript var name of scroll, default scroll)
• options (array of options defined by the library cfr: https://github.com/cferdinandi/smooth-scroll#global-settings)

Example

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