Skip to main content

Searchable and paginable ListView

Project description

Django-SearchableListView
=========================

[![Build Status](https://travis-ci.org/SchroterQuentin/django-search-listview.svg?branch=master)](https://travis-ci.org/SchroterQuentin/django-search-listview)
[![Coverage Status](https://coveralls.io/repos/github/SchroterQuentin/Django-SearchableListView/badge.svg)](https://coveralls.io/github/SchroterQuentin/Django-SearchableListView)
[![Code Health](https://landscape.io/github/SchroterQuentin/django-search-listview/master/landscape.svg?style=flat)](https://landscape.io/github/SchroterQuentin/django-search-listview/master)

ListView which can be searchable, paginate and which doesn't lose query parameter and page number

Installation
------------

This library need jQuery ( and Bootstrap for the frond-end )
To install it in your vitualenv on your django project

```{r, engine='bash', count_lines}
pip install django-search-listview
```

```python
INSTALLED_APPS = [
...
'search_listview',
]
```


Only paginate ListView
----------------------

```python
from search_listview.list import SearchableListView

class ListDevicePaginate(SearchableListView):
model = Device
template_name = "tests/list.html"
paginate_by = 10
```

Paginate + Searchable ListView
------------------------------

```python
from search_listview.list import SearchableListView

class ListDeviceSearchablePaginate(SearchableListView):
model = Device
template_name = "tests/list.html"
paginate_by = 10
searchable_fields = ["inventory_number", "model_device", "model_device__brand__provider",
"model_device__brand__name"]
specifications = {
"model_device__brand__name": "__icontains"
}
```

Put the parameter for the query in **searchable_fields** which will be use to filter the queryset. The specifications which be use in the same way.

In the template
---------------

- Where you want the pagination and the search box

```html
<div class="row">
{% include "search_listview/search_and_page.html" %}
</div>
```

- In the footer

```html
<!--Need jQuery-->
<script src="{% static 'search_listview/js/search_listview.js' %}"></script>
<script>
start_search()
</script>
```

Now you have a beautifull box with all the fields you need.

![Alt tag](/docs/search_box.png?raw=true "Search box")

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
django-search-listview-0.2.1.zip (12.0 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page