Django integration with jQuery DataTables.
Project description
Django DataTables Too
Author:Tim Santor tsantor@xstudios.agency
Overview
Handle server side processing for datatables 1.10.x.
Getting It
To install Django DataTables Too, just use pip:
$ pip install django-datatables-too
Usage
views.py
from django.http import JsonResponse
from django.views.generic import View
from django_datatables_too.mixins import DataTableMixin
class DataTablesAjaxPagination(DataTableMixin, View):
model = Report
queryset = Report.objects.all()
def _get_actions(self, obj):
"""Get action buttons w/links."""
return f'<a href="{obj.get_update_url()}" title="Edit" class="btn btn-primary btn-xs"><i class="fa fa-pencil"></i></a> <a data-title="{obj}" title="Delete" href="{obj.get_delete_url()}" class="btn btn-danger btn-xs btn-delete"><i class="fa fa-trash"></i></a>'
def filter_queryset(self, qs):
"""Return the list of items for this view."""
# If a search term, filter the query
if self.search:
return qs.filter(
Q(number__icontains=self.search) |
Q(title__icontains=self.search) |
Q(state__icontains=self.search) |
Q(year__icontains=self.search)
)
return qs
def prepare_results(self, qs):
# Create row data for datatables
data = []
for o in qs:
data.append({
'number': o.number,
'title': Truncator(o.title).words(10),
'state': o.state,
'year': o.year,
'published': o.published,
'modified': o.modified,
'actions': self._get_actions(o)
})
return data
def get(self, request, *args, **kwargs):
context_data = self.get_context_data(request)
return JsonResponse(context_data)
urls.py
from django.urls import path
from . import views
app_name = 'reports'
urlpatterns = [
...
path('ajax',
views.DataTablesAjaxPagination.as_view(), name='report-list-ajax'),
]
report_list.html
$('#report-table').DataTable({
columnDefs: [{
orderable: true,
targets: -1
}, ],
// Ajax for pagination
processing: true,
serverSide: true,
ajax: {
url: '{% url "reports:report-list-ajax" %}',
type: 'get',
},
columns: [
// data: json key from prepare_results, name: model field name
{ data: 'number', name: 'number'},
{ data: 'title', name: 'title' },
{ data: 'state', name: 'state' },
{ data: 'year', name: 'year' },
{ data: 'published', name: 'published' },
{ data: 'modified', name: 'modified' },
{ data: 'actions', name: 'actions' }
]
});
0.1.1 2018‑09‑25
- Initial release
0.1.2 2019‑08‑16
- Fixed bug when DataTable was set to
ordering: false
in JavaScript
0.1.3 2019‑08‑16
- Fixed fixed issue where HISTORY.rst was not included in the package causing it to fail upon install
0.1.4 2021-08-30
- Fixed sorting now actually works
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
Built Distribution
Close
Hashes for django-datatables-too-0.1.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6965009109b3a891564ecbdad3d892a1da2ec132a974068d14b686a3ebad3543 |
|
MD5 | 94c3139e4d76c96899c15a39c7d45789 |
|
BLAKE2b-256 | 227a762f688a5ddb7a17d23210959669f89b71a01785aec8a26cf72679916126 |
Close
Hashes for django_datatables_too-0.1.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cea8b7e81ddeea05c07b6e6a0f79d9b1116a5580bfeae50f5da2e5e6c0970c4c |
|
MD5 | 501519ccfc85624e04272986763edd1a |
|
BLAKE2b-256 | 77f14e60d79a47ef1e78c8d4df7cfe125b9f4ffad1b429134bbbfce2b2fe4e2a |