https://github.com/raoul2000/yii2-scrollup-widget
Wrapper around "Scroll Up" jQuery plugin
https://github.com/raoul2000/yii2-scrollup-widget
Last synced: 2 months ago
JSON representation
Wrapper around "Scroll Up" jQuery plugin
- Host: GitHub
- URL: https://github.com/raoul2000/yii2-scrollup-widget
- Owner: raoul2000
- License: bsd-3-clause
- Created: 2014-07-06T15:54:36.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2017-11-17T07:05:54.000Z (over 7 years ago)
- Last Synced: 2025-03-19T03:41:35.861Z (3 months ago)
- Language: JavaScript
- Size: 145 KB
- Stars: 11
- Watchers: 4
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGE.md
- License: LICENSE.md
Awesome Lists containing this project
README
yii2-scrollup-widget
==========================
Wrapper around "Scroll Up", a "*lightweight jQuery plugin to create a customisable "Scroll to top" feature that will work with any website, with ease*.
Check out the [ScrollUp Demo page](http://markgoodyear.com/labs/scrollup/) for demo of the Plugin and don't forget to have a look
to the [scrollUp jQuery plugin Home page](http://markgoodyear.com/2013/01/scrollup-jquery-plugin/).
Installation
------------
The preferred way to install this extension is through [composer](http://getcomposer.org/download/).
Either run
```
php composer.phar require --prefer-dist raoul2000/yii2-scrollup-widget "*"
```
or add
```
"raoul2000/yii2-scrollup-widget": "*"
```
to the require section of your `composer.json` file.
Usage
-----
Once the extension is installed, simply use it in your code by :
```php
Scrollup::THEME_IMAGE,
'pluginOptions' => [
'scrollText' => "To top", // Text for element
'scrollName'=> 'scrollUp', // Element ID
'topDistance'=> 400, // Distance from top before showing element (px)
'topSpeed'=> 3000, // Speed back to top (ms)
'animation' => Scrollup::ANIMATION_SLIDE, // Fade, slide, none
'animationInSpeed' => 200, // Animation in speed (ms)
'animationOutSpeed'=> 200, // Animation out speed (ms)
'activeOverlay' => false, // Set CSS color to display scrollUp active point, e.g '#00FFFF'
]
]);
?>
```
If you wish to use your own styling for the scroll-up, just remove the 'theme' option and provide the required CSS style.
For more information on the plugin options and usage, please refer to [scrollUp jQuery plugin Home page](http://markgoodyear.com/2013/01/scrollup-jquery-plugin/).
License
-------
**yii2-scrollup-widget** is released under the BSD 3-Clause License. See the bundled `LICENSE.md` for details.