1. Requirements
2. Installation
3. Usage
4. Resources

Yii2 Extension which is a wrapper for jQuery plugin scrollup

Requirements ¶

Yii 2.x

Installation ¶

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist ibrarturi/yii2-scrollup "dev-master"

or add

"ibrarturi/yii2-scrollup": "dev-master"

to the require section of your composer.json file.

Usage ¶

Once the extension is installed, simply use it in your code by :

• Default Usage

<?= \ibrarturi\scrollup\ScrollUp::widget(); ?>

• Usage with theme parameter

<?= \ibrarturi\scrollup\ScrollUp::widget([
	'theme' => 'tab',   // pill, link, image, tab
]); ?>

• Usage with default optional parameters

<?= \ibrarturi\scrollup\ScrollUp::widget([
    'options' => [
        'scrollName' => 'scrollUp',      // Element ID
        'scrollDistance' => 300,         // Distance from top/bottom before showing element (px)
        'scrollFrom' => 'top',           // 'top' or 'bottom'
        'scrollSpeed' => 300,            // Speed back to top (ms)
        'easingType' => 'linear',        // Scroll to top easing (see http://easings.net/)
        'animation' => 'fade',           // Fade, slide, none
        'animationSpeed' => 200,         // Animation speed (ms)
        'scrollTrigger' => false,        // Set a custom triggering element. Can be an HTML string or jQuery object
        'scrollTarget' => false,         // Set a custom target element for scrolling to. Can be element or number
        'scrollText' => 'Scroll to top', // Text for element, can contain HTML
        'scrollTitle' => false,          // Set a custom <a> title if required.
        'scrollImg' => false,            // Set true to use image
        'activeOverlay' => false,        // Set CSS color to display scrollUp active point, e.g '#00FFFF'
        'zIndex' => 2147483647,          // Z-Index for the overlay
    ]
]); ?>

Resources ¶

• Github Page
• Project Page
• Demo