ue-scroll-js
Advanced tools
Lightweight JavaScript library for scroll up.
Demo and documentation: https://azrsix.github.io/ue-scroll-js/
$ npm install ue-scroll-js --save
$ yarn add ue-scroll-js
<link rel="stylesheet" href="//unpkg.com/ue-scroll-js@latest/dist/ue-scroll.min.css">
<script src="https://unpkg.com/ue-scroll-js"></script>
<html>
<head>
<!-- Read CSS and JS -->
<link rel="stylesheet" href="/path/to/ue-scroll-js/dist/ue-scroll.min.css">
<script src="/path/to/ue-scroll-js/dist/ue-scroll.min.js"></script>
</head>
<body>
<main>
Your main contents
</main>
<!-- Run this script -->
<div id="ue-scroll" class="ue-scroll btn-white arrow-black circle shadow"></div>
<script>
UeScroll.init();
</script>
</body>
</html>
<!-- Run this script -->
<div id="my-custom-id" class="ue-scroll btn-white arrow-black circle shadow"></div>
<script>
UeScroll.init({
element: '#my-custom-id',
scrollSpeed: 10
});
</script>
'use strict';
import ue from 'ue-scroll-js';
// Run this script
ue.init();
By the default, ue-scroll.js automatically detect element having '#ue-scroll'. It needs to be started after DOM is rendered.
| Key | Data Type | Default Value | Description |
|---|---|---|---|
| element | String | '#ue-scroll' | Specify an element with a CSS selector. |
| position | Number | 200 | Specify the scroll position where the button is displayed. |
| scrollSpeed | Number | 10 | Specify the speed of scrolling (Recommend 20 or less) |
| fadeSpeed | Number | 10 | Specify the speed of fade (Recommend 20 or less) |
| cancelByScroll | Boolean | true | Cancel scrolling when scroll down (This setting is ignored on touch devices) |
| cancelByClick | Boolean | true | Cancel scrolling when window clicking. |
| cancelByKeydown | Boolean | true | Cancel scrolling when pressed any key. |
In addition, You can freely change the color, design, position etc of buttons with CSS!
Please refer to the documentation.
FAQs
Lightweight JavaScript library for scroll up
The npm package ue-scroll-js receives a total of 37 weekly downloads. As such, ue-scroll-js popularity was classified as not popular.
We found that ue-scroll-js demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Multiple high-impact npm maintainers confirm they have been targeted in the same social engineering campaign that compromised Axios.
Security News
Axios compromise traced to social engineering, showing how attacks on maintainers can bypass controls and expose the broader software supply chain.
Security News
Node.js has paused its bug bounty program after funding ended, removing payouts for vulnerability reports but keeping its security process unchanged.