ScrollTop
A flexible modern scroll-top js plugin.
Introduction
Installation
Yarn
yarn add @pluginjs/scroll-top
NPM
npm i @pluginjs/scroll-top
Getting Started
CDN:
Development:
<script src="https://unpkg.com/@pluginjs/scroll-top/dist/scroll-top.js"></script>
<link rel="stylesheet" href="https://unpkg.com/@pluginjs/scroll-top/dist/scroll-top.css">
Production:
<script src="https://unpkg.com/@pluginjs/scroll-top/dist/scroll-top.min.js"></script>
<link rel="stylesheet" href="https://unpkg.com/@pluginjs/scroll-top/dist/scroll-top.min.css">
Initialize
HTML:
<div class="element"></div>
ECMAScript Module:
import ScrollTop from "@pluginjs/scroll-top"
import "@pluginjs/scroll-top/dist/scroll-top.css"
ScrollTop.of(document.querySelector('.element'), options)
CommonJS:
require("@pluginjs/scroll-top/dist/scroll-top.css")
const ScrollTop = require("@pluginjs/scroll-top")
ScrollTop.of(document.querySelector('.element'), options)
Browser:
<link rel="stylesheet" href="https://unpkg.com/@pluginjs/scroll-top/dist/scroll-top.css">
<script src="https://unpkg.com/@pluginjs/scroll-top/dist/scroll-top.js"></script>
<script>
Pj.scrollTop('.element', options)
</script>
API
Options
Options are called on scrollTop instances through the scrollTop options itself. You can also save the instances to variable for further use.
Name | Description | Default |
---|---|---|
"trigger" |
Set trigger | null |
"target" |
Set target | null |
"distance" |
Set distance | 200 |
"duration" |
Set duretion | 1000 |
"easing" |
Set easing | linear |
"animation" |
Set animation | fade |
"animationDuration" |
Set animationDuration | 500 |
"mobile" |
Set mobile | {"width":768,"distance":100,"duration":1000,"easing":"easeInOutElastic","animation":"slide","animationDuration":200} |
"theme" |
Set plugin theme option | default |
"locale" |
Set locale environment | en |
"localeFallbacks" |
Set plugin is localeFallbacks or not | true |
"throttle" |
Set throttle | undefined |
Events
Events are called on scrollTop instances through the scrollTop events itself. You can also save the instances to variable for further use.
Name | Description |
---|---|
"update" |
Gets fired when plugin has destroy |
"ready" |
Gets fired when plugin has ready |
"enable" |
Gets fired when plugin has enabled |
"disable" |
Gets fired when plugin has disabled |
"destroy" |
Gets fired when plugin has destroy |
"jump" |
Gets fired when plugin has jump |
"hide" |
Gets fired when plugin has hide |
"show" |
Gets fired when plugin has show |
Methods
Methods are called on scrollTop instances through the scrollTop method itself. You can also save the instances to variable for further use.
Name | Description |
---|---|
"jump" |
Get value of jump |
"enable" |
Enabled plugin if plugin is disabled |
"disable" |
Disable plugin |
"show" |
Show plugin if it is hiden |
"hide" |
Hide plugin |
"destroy" |
Destroy plugin |
Classes
Name | Description | Default
--||
"NAMESPACE"
| Declare plugin namespace | pj-scrollTop
"THEME"
| Declare plugin theme | {namespace}--{theme}
"TRIGGER"
| Declare plugin trigger | {namespace}
"ANIMATION"
| Declare plugin animation | {namespace}-{animation}
"ANIMATING"
| Declare plugin animating | {namespace}-animating
"DISABLED"
| Announce plugin is disabled | {namespace}-disabled
"SHOW"
| Announce plugin is show | {namespace}-show
Translations
Name | EN | ZH
--||-
"label"
| Scroll To Top | 置顶
Browser support
Tested on all major browsers.
IE / Edge | Firefox | Chrome | Safari | Opera |
---|---|---|---|---|
IE11, Edge | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
License
@pluginjs/scroll-top is Licensed under the GPL-v3 license.
If you want to use @pluginjs/scroll-top project to develop commercial sites, themes, projects, and applications, the Commercial license is the appropriate license. With this option, your source code is kept proprietary.
For purchase an Commercial License, contact us purchase@thecreation.co.
Copyright
Copyright (C) 2022 Creation Studio Limited.