django-infinite-scroll
Add infinite scroll to any django app.
Features
- Allows to add infinite scroll to any page.
- Works with Django's Queryset or any kind of lists.
- Requires no aditional javascript framework.
- Easy to install and set up.
Quicksetup
With docker compose:
git clone https://github.com/gsteixeira/django-infinite-scroll.git
cd django-infinite-scroll/example/
docker-compose up
Go to http://localhost:8000 and try it out. 8)
installation
Install module.
pip install django-infinite-scroll
Add to settings.py
INSTALLED_APPS = [
# ...
'infscroll',
]
First, let's make a view that will load the dynamic content:
def more(request):
# This is the list that will be paginated.
list_items = MyModel.objects.all()
return more_items(request, list_items,
# (optional) your custom template
template='more.html')
Add it to urls.py
path('more/', myapp.views.more, name='more'),
Finally, Add to the view you want to show the infinite scroll:
def my_view(request):
# The list of items to be paginated. It can be any list of queryset.
list_items = MyModel.objects.all()
paginated = get_pagination(request, list_items)
# we must declare the url where it will load more stuff
data = {
'more_posts_url': reverse('more'),
}
# update with paginated info
data.update(paginated)
return render(request, 'my_view.html', data)
Now add to your template:
{% load infinite_scroll %}
<html>
<body>
<p>Hellop>
{% infinite_scroll_box %}
{% set_infinite_scroll %}
body>
html>
Now go to the page of "my_view", and you should have infinite scroll!
(optional) If you want to use a custom "load_more" template
Here is an example:
{% load infinite_scroll %}
{% for item in feed %}
{{ item }}
{% endfor %}
{% infinite_scroll_tags %}
Just add this for loop to iterate the list and include the scroll tags
Settings
PAGINATION_STEPS - the amount of items each step will load. Default to 10.
Requirements
- python3
- django
5.5k Jan 06, 2023
4 Nov 26, 2021
35 Dec 02, 2022
162 Jan 03, 2023
54 Dec 10, 2022
2.5k Jan 03, 2023
223 Jun 17, 2022
5 Nov 24, 2022
487 Dec 06, 2022
1 Jun 30, 2022
1 Dec 09, 2021
384 Nov 23, 2022
1 Dec 17, 2021
980 Jan 06, 2023
4 May 25, 2022
1 Feb 22, 2022
5 Nov 15, 2022
11 Nov 10, 2022
8 Jun 25, 2021