grptx/yii2-smooth-scroll

Smooth Scroll widget for Yii2

yii2-smooth-scroll

, _(*1)

Smooth Scroll component for Yii2 based on Smooth Scroll library, _(*2)

Install

Preferred way to install is through Composer:, _(*3)

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

Or, you may add, _(*4)

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

to the require section of your composer.json file and execute php composer.phar update., _(*5)

Usage

To add the smooth scroll capability to a page add in the view:, _(*6)

use grptx\smoothscroll\SmoothScrollWidget;

SmoothScrollWidget::widget();

Options

Availables options for the widget are:, _(*7)

• 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 ..
    ],
]);