Searchable and paginable ListView
Project description
Django-SearchableListView
=========================
[![Build Status](https://travis-ci.org/SchroterQuentin/Django-SearchableListView.svg?branch=master)](https://travis-ci.org/SchroterQuentin/Django-SearchableListView)
[![Coverage Status](https://coveralls.io/repos/github/SchroterQuentin/Django-SearchableListView/badge.svg)](https://coveralls.io/github/SchroterQuentin/Django-SearchableListView)
ListView which can be searchable, paginate and which don'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_model
```
Only paginate ListView
----------------------
```python
class ListDevicePaginate(SearchableListView):
model = Device
template_name = "tests/list.html"
paginate_by = 10
```
Paginate + Searchable ListView
------------------------------
```python
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 'js/django_search_model.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")
=========================
[![Build Status](https://travis-ci.org/SchroterQuentin/Django-SearchableListView.svg?branch=master)](https://travis-ci.org/SchroterQuentin/Django-SearchableListView)
[![Coverage Status](https://coveralls.io/repos/github/SchroterQuentin/Django-SearchableListView/badge.svg)](https://coveralls.io/github/SchroterQuentin/Django-SearchableListView)
ListView which can be searchable, paginate and which don'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_model
```
Only paginate ListView
----------------------
```python
class ListDevicePaginate(SearchableListView):
model = Device
template_name = "tests/list.html"
paginate_by = 10
```
Paginate + Searchable ListView
------------------------------
```python
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 'js/django_search_model.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.
Source Distribution
Close
Hashes for django-search-listview-0.1.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 46f728b4e0e5e0938a567b1dedaa8e27819d1eecbbf340e68a94cc81c8cd1d02 |
|
MD5 | 264fb645ea2dc19dd7944443d5a494be |
|
BLAKE2b-256 | 51b6ff5a7ac3861974bef9df1a9556ed50bfcd14c92ec292827fba9ea13fc249 |