jg

jquery-goup

A simple jQuery plugin that let users go back to the top of a web page.

Showing:

Popularity

Downloads/wk

39

GitHub Stars

108

Maintenance

Last Commit

4yrs ago

Contributors

2

Package

Dependencies

0

Size (min+gzip)

1.2KB

License

Type Definitions

Tree-Shakeable

No?

Categories

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:

<script>
jQuery(document).ready(function(){
    jQuery.goup();
});
</script>

Demo

Yeah! You can see a live demo here: http://dnlnrs.github.io/jquery-goup/

Options

NameDescriptionTypeDefault
locationOn which side the button will be shown ("left" or "right")Stringright
locationOffsetHow many pixel the button is distant from the edge of the screen, based on the location settedInteger20
bottomOffsetHow many pixel the button is distant from the bottom edge of the screenInteger10
containerSizeThe width and height of the button (minimum is 20)Integer40
containerRadiusLet you transform a square in a circle (yeah, it's magic!)Integer10
containerClassThe class name given to the button containerStringgoup-container
arrowClassThe class name given to the arrow containerStringgoup-arrow
containerColorThe color of the container (in hex format)String#000
arrowColorThe color of the arrow (in hex format)String#fff
triggerAfter how many scrolled down pixels the button must be shown (bypassed by alwaysVisible)Integer500
entryAnimationThe animation of the show and hide events of the button ("slide" or "fade")Stringfade
alwaysVisibleSet to true if u want the button to be always visible (bypass trigger)Booleanfalse
goupSpeedThe speed at which the user will be brought back to the top ("slow", "normal" or "fast")Stringslow
hideUnderWidthThe threshold of window width under which the button is permanently hiddenInteger500
titleA text to show on the button mouse hoverString''
titleAsTextIf true the hover title becomes a true text under the buttonBooleanfalse
titleAsTextClassThe class name given to the title textStringgoup-text
zIndexSet the z-indexInteger1

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.

jQuery GoUp! is dual licensed under the GPL and MIT licenses.

(c) 2014-2018 Daniele Lenares

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial