Scroll To Top
Floating scroll-to-top button that appears after a scroll threshold.
Preview
Hidden until the page is scrolled past its threshold.
Usage
views.py
python
from djust import LiveView
from djust.components import ScrollToTop
class MyView(LiveView):
template_name = "my_template.html"
def mount(self, request, **kwargs):
self.component = ScrollToTop()my_template.html
django
{{ component }}Needs its script on the page: <script src="{% static 'djust_components/scroll-to-top.js' %}"></script>. djust ships it; without it the markup renders but does not update in the browser.
Parameters
| Name | Type | Default |
|---|---|---|
| threshold | str | '300px' |
| label | str | 'Back to top' |
| custom_class | str | '' |
| **kwargs | — passed to `Component.__init__`: `name=` identifies the instance in the events it sends, `id=` sets `component.id`, and any other keyword is kept as state | — |
Source & styles
| File | Path | Notes |
|---|---|---|
| module | djust.components.components.scroll_to_top | Subclass it, or pass custom_class, to change how it renders. |
| css | djust_components/components.css | Defines 1 of this component's classes at line 1246. Override those rules, or the custom properties they read, in a stylesheet loaded after it. |