Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fatrex/jquery-goup
A simple jQuery plugin that let users go back to the top of a web page.
https://github.com/fatrex/jquery-goup
Last synced: 3 months ago
JSON representation
A simple jQuery plugin that let users go back to the top of a web page.
- Host: GitHub
- URL: https://github.com/fatrex/jquery-goup
- Owner: fatrex
- Created: 2014-04-05T18:32:31.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2018-02-05T13:16:08.000Z (almost 7 years ago)
- Last Synced: 2024-07-29T09:23:41.522Z (4 months ago)
- Language: JavaScript
- Homepage:
- Size: 82 KB
- Stars: 104
- Watchers: 9
- Forks: 26
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# jQuery GoUp!
A simple jQuery plugin that let users go back to the top of a web page.
---
#### Easy Peasy
Download the minified version of the plugin, include it after jQuery and:
```
jQuery(document).ready(function(){
jQuery.goup();
});
```
### Demo
Yeah! You can see a live demo here: http://dnlnrs.github.io/jquery-goup/
### Options
| Name | Description | Type | Default |
|-------------------|------------------------------------------------------------------------------------------------|---------|----------------|
| `location` | On which side the button will be shown ("left" or "right") | String | right |
| `locationOffset` | How many pixel the button is distant from the edge of the screen, based on the location setted | Integer | 20 |
| `bottomOffset` | How many pixel the button is distant from the bottom edge of the screen | Integer | 10 |
| `containerSize` | The width and height of the button (minimum is 20) | Integer | 40 |
| `containerRadius` | Let you transform a square in a circle (yeah, it's magic!) | Integer | 10 |
| `containerClass` | The class name given to the button container | String | goup-container |
| `arrowClass` | The class name given to the arrow container | String | goup-arrow |
| `containerColor` | The color of the container (in hex format) | String | #000 |
| `arrowColor` | The color of the arrow (in hex format) | String | #fff |
| `trigger` | After how many scrolled down pixels the button must be shown (bypassed by `alwaysVisible`) | Integer | 500 |
| `entryAnimation` | The animation of the show and hide events of the button ("slide" or "fade") | String | fade |
| `alwaysVisible` | Set to true if u want the button to be always visible (bypass `trigger`) | Boolean | false |
| `goupSpeed` | The speed at which the user will be brought back to the top ("slow", "normal" or "fast") | String | slow |
| `hideUnderWidth` | The threshold of window width under which the button is permanently hidden | Integer | 500 |
| `title` | A text to show on the button mouse hover | String | '' |
| `titleAsText` | If true the hover title becomes a true text under the button | Boolean | false |
| `titleAsTextClass`| The class name given to the title text | String | goup-text |
| `zIndex` | Set the z-index | Integer | 1 |
### Changelog
#### v1.1.3 (08-31-2017)
* Added ESLint check
* Some code refactoring
#### v1.1.2 (08-09-2017)
* Some code refactoring
#### v1.1.1 (08-05-2017)
* Year and url update
#### v1.1.0 (05-08-2016)
* Added `zIndex` parameter
* Some code refactoring
For more changelog info check the `CHANGELOG.md` file.
### License and Copyright
jQuery GoUp! is dual licensed under the [GPL](http://www.gnu.org/licenses/gpl.html) and [MIT](http://www.opensource.org/licenses/mit-license.php) licenses.
(c) 2014-2018 Daniele Lenares