Infinite Scroll

Style-agnostic infinite scroll component.

python 6 params

Preview

loading
python
infinite_scroll(load_event='load_more')

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')

    @event_handler()
    def load_more(self, value=None, **kwargs):
        ...  # write to self.component; the re-render carries it
my_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

NameTypeDefault
load_eventstr — renames the event; identity is `name`'load_more'
thresholdstr'200px'
loadingboolFalse
finishedboolFalse
custom_classstr''
**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
FilePathNotes
moduledjust.components.components.infinite_scrollSubclass it, or pass custom_class, to change how it renders.
cssdjust_components/components.cssDefines 2 of this component's classes at line 1808, 1809. Override those rules, or the custom properties they read, in a stylesheet loaded after it.