@brslv/scroll-progress
Advanced tools
A tiny vanilla custom component, which renders a small progress bar on the top of a vertical scrolling page.
A tiny vanilla custom component, which renders a small progress bar on the top of a vertical scrolling page.
Zero dependencies. 👌
No node, browser only.
Import the package.
import '@brslv/scroll-progress';
Then, simply use it in your DOM (just bellow the <body> tag, for example).
<body>
<scroll-progress></scroll-progress>
<!-- Other stuff... -->
</body>
That's it. 👍
Any valid css color prop. For example, red, #333 or #acacac.
Any valid css height prop: 5px, 10%, 5em.
top or bottom.
<scroll-progress color="#333222" height="3px" position="bottom"></scroll-progress>
Pause the scroll-progress updates.
const element = document.querySelector('scroll-progress');
element.pause();
Resume the scroll-progress updates.
element.resume();
Show the scroll-progress bar.
element.show();
Hide the scroll-progress bar.
element.hide();
Toggle the hidden status of the scroll-progress bar.
element.toggleHidden();
The <scroll-element> emits the following events:
Dispatches, when the scroll-progress detects a window scroll event.
Resulting event.detail object contains:
percentage - the scroll percentage, when the event occuredpaused - if the scroll-progress updates are being paused, when the event occuredhidden - if the scroll-progress bar is hiddenconst element = document.querySelector('scroll-progress');
element.addEventListener('scroll-detected', ({ detail }) => {
const { percentage, paused, hidden } = detail;
});
Dispatches, when the scroll-progress bar updates. The difference between scroll-detected and update events is that the update happens when the scroll-progress is not paused. If it's paused, then only scroll-detected is fired, but update is not.
Resulting event.detail object contains:
percentages - the scroll percentage, when the event occuredhidden - if the scroll-progress bar is hiddenconst element = document.querySelector('scroll-progress');
element.addEventListener('update', ({ detail }) => {
const { percentage, hidden } = detail;
/* You don't have the paused prop here (like in the "scroll-detected" event), because updates happen only when the scroll-progress is not being paused. */
});
Can I use this with React/Angular/Vue/Whatever-modern-framework?
Yep, you can. For example, in a react application, you can simply render this as any other built-in DOM element:
<div>
<scroll-progress></scroll-progress>
{/* Other components bellow */}
<MyCustomComponent />
</div>
Which browsers do you support.
This is built on top of the custom elements specification. That's why you should take into consideration the following browser support table for Custom Elements v1.
Enjoy! ⭐️
MIT License
Copyright (c) 2019 Borislav Grigorov
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
FAQs
A tiny vanilla custom component, which renders a small progress bar on the top of a vertical scrolling page.
We found that @brslv/scroll-progress 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
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.