jkofsky / yii2-scroll-top
This Yii 2 widget adds a simple scroll-to-top button to your site.
Installs: 38
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Type:yii2-extension
Requires
- yiisoft/yii2: *
This package is not auto-updated.
Last update: 2025-05-11 06:29:53 UTC
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 jkofsky/yii2-scroll-top "*"
or add
"jkofsky/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.
<?= \jkofsky\scrollTop\ScrollTop::widget() ?>
or
<?= \jkofsky\scrollTop\ScrollTop::widget([ 'btnColorClass' => 'btn-info', 'linkText' => 'Top', 'glyphicon' => 'glyphicon-circle-arrow-up', ]) ?>
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.