README

This Yii 2 widget adds a simple scroll-to-top button to your site. It uses a glyphicon, some CSS and the .animate jQuery function. All these are part of Yii 2 by default so no other dependencies are required.

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist bluezed/yii2-scroll-top "*"

or add

"bluezed/yii2-scroll-top": "*"

to the require section of your composer.json file.

How to use

Add this line to your main layout so the widget gets loaded automatically into every page.

<?= \bluezed\scrollTop\ScrollTop::widget() ?>

To customize the class of the i and a-tags generated by the widget use the following syntax:

<?= \bluezed\scrollTop\ScrollTop::widget([
      'i_class' => 'glyphicon glyphicon-menu-up bluezed-scroll-top-circle my_custom_class', 
      'a_class' => 'bluezed-scroll-top my_other_custom_class') ?>

By default your main layout should be located here:

<Project-Folder>/views/layouts/main.php

Screenshot

The button appears in the bottom right corner of the page once you have scrolled down at least 150px.