Scroll Spy
Style-agnostic scroll spy component.
Preview
Arguments
scroll_spy(sections=['overview', 'features', 'pricing'], active='overview')
Usage
views.py
python
from djust import LiveView
from djust.decorators import event_handler
from djust.components import ScrollSpy
class MyView(LiveView):
template_name = "my_template.html"
def mount(self, request, **kwargs):
self.component = ScrollSpy(sections=['overview', 'features', 'pricing'], active='overview')
@event_handler()
def section_changed(self, value=None, **kwargs):
pass # your app acts on 'section_changed'; no component state movesmy_template.html
django
{{ component }}Events this component sends to the view: section_changed.
Needs its script on the page: <script src="{% static 'djust_components/scroll-spy.js' %}"></script>. djust ships it; without it the markup renders but does not update in the browser.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| sections | list | None | None | List of section IDs to observe |
| active | str | '' | Currently active section ID |
| active_event | str — renames the event; identity is `name` | 'section_changed' | djust event fired when active section changes |
| offset | str | '0px' | Offset from top for intersection (default: "0px") |
| custom_class | str | '' | Additional CSS classes |
| **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_spy | Subclass it, or pass custom_class, to change how it renders. |
| css | djust_components/components.css | Defines 3 of this component's classes at line 1867, 1868, 1870. Override those rules, or the custom properties they read, in a stylesheet loaded after it. |