Infinite Scroll
Style-agnostic infinite scroll component.
Preview
No more items
python
infinite_scroll(load_event='load_more', finished=True)An invisible sentinel: when it scrolls into view it sends load_more, and your view appends the next page.
Usage
views.py
python
from djust import LiveView
from djust.decorators import event_handler
from djust.components import InfiniteScroll
class MyView(LiveView):
template_name = "my_template.html"
def mount(self, request, **kwargs):
self.component = InfiniteScroll(load_event='load_more', finished=True)
@event_handler()
def load_more(self, value=None, **kwargs):
pass # your app acts on 'load_more'; no component state movesmy_template.html
django
{{ component }}Events this component sends to the view: load_more.
Needs its script on the page: <script src="{% static 'djust_components/infinite-scroll.js' %}"></script>. djust ships it; without it the markup renders but does not update in the browser.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| load_event | str — renames the event; identity is `name` | 'load_more' | djust event to fire when threshold is reached |
| threshold | str | '200px' | Distance from bottom to trigger (default: "200px") |
| loading | bool | False | Whether currently loading more items |
| finished | bool | False | Whether all items have been loaded |
| 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.infinite_scroll | 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 1835, 1836, 1838. Override those rules, or the custom properties they read, in a stylesheet loaded after it. |