This component is available on GitHub.
Stimulus Scroll Progress
A Stimulus controller to add a progress bar when scrolling.
Installation
$ yarn add stimulus-scroll-progress
And use it in your JS file:
// Probably in app/javascript/controllers/index.js
import { Application } from '@hotwired/stimulus'
import ScrollProgress from 'stimulus-scroll-progress'
const application = Application.start()
application.register('scroll-progress', ScrollProgress)
π Demo
See demo βUsage
Add a div
just after the body
opening tag:
In your view:
<body>
<div data-controller="scroll-progress" class="h-2 bg-indigo-400 fixed top-0"></div>
</body>
It's up to you to design it as you want.
π Configuration
To improve performance, the scroll
event is throttled.
Attribute | Default | Description | Optional |
---|---|---|---|
data-scroll-progress-throttle-delay-value | 15 | Delay in milliseconds to update the scroll position. (0 to disable). | β |
π Extending Controller
You can use inheritance to extend the functionality of any Stimulus component:
import ScrollProgress from 'stimulus-scroll-progress'
export default class extends ScrollProgress {
connect() {
super.connect()
console.log('Do what you want here.')
}
}
This controller will automatically have access to targets defined in the parent class.
If you override the connect
, disconnect
or any other methods from the parent, you'll
want to call super.method()
to make sure the parent functionality is executed.
βοΈ Sponsors
Stimulus Component is an MIT licensed open source project and completely free to use. However, the amount of effort needed to maintain and develop new features for the project is not sustainable without proper financial backing. You can support Stimulus Components development on Github Sponsors. π
π· Contributing
Do not hesitate to contribute to the project by adapting or adding features ! Bug reports or pull requests are welcome.
Donβt forget to drop a π on Github to support the project.
π License
This project is released under the MIT license.