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., (*1)
Installation
The preferred way to install this extension is through composer., (*2)
Either run, (*3)
php composer.phar require --prefer-dist jkofsky/yii2-scroll-top "*"
or add, (*4)
"jkofsky/yii2-scroll-top": "*"
to the require section of your composer.json
file., (*5)
How to use
Add this line to your main layout so the widget gets loaded automatically into every page., (*6)
<?= \jkofsky\scrollTop\ScrollTop::widget() ?>
or, (*7)
<?=
\jkofsky\scrollTop\ScrollTop::widget([
'btnColorClass' => 'btn-info',
'linkText' => 'Top',
'glyphicon' => 'glyphicon-circle-arrow-up',
])
?>
By default your main layout should be located here:, (*8)
<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.
, (*9)