Server-side Datatable processing view mixin for Django
Project description
Django Serverside Datatable
This is a fork of Umesh Krishna's django-serverside-datable which was written for an older version of datatables. This updated version has been rewritten. Thanks to Umesh for the foundation to start from.
This is package that lets you easily extend views to work with DataTables.net server-side processing in your Django Project.
Supports datatable features such as Pagination, Search, filtering, etc...
Install
pip install django-datatable-serverside-mixin
How to use
Create a django View that inherits from ServerSideDatatableMixin. Example (backend):
# views.py
from django_serverside_datatable_mixin.views import ServerSideDatatableMixin
class PersonListView(ServerSideDatatableMixin):
queryset = Person.objects.all()
columns = ['person_name', 'person_code', 'person_description','person__building__name']
# urls.py
# add the following element to your urlpatterns array
path('data/', views.PersonListView.as_view()),
Example (frontend):
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<link rel="stylesheet" type="text/css" href="https://cdn.datatables.net/1.12.1/css/jquery.dataTables.min.css"/>
<script type="text/javascript" src="https://code.jquery.com/jquery-3.6.0.min.js"></script>
<script type="text/javascript" src="https://cdn.datatables.net/1.12.1/js/jquery.dataTables.min.js"></script>
</head>
<body>
<h1>People</h1>
<hr>
<table id="people-table">
<thead>
<tr>
<th>Name</th>
<th>Code</th>
<th>Description</th>
<th>Building Name</th>
</tr>
</thead>
<tbody></tbody>
</table>
<script src="https://code.jquery.com/jquery-3.3.1.min.js"></script>
<script src="https://cdn.datatables.net/1.10.19/js/jquery.dataTables.min.js"></script>
<script language="javascript">
$(document).ready(function () {
$('#people-table').dataTable({
serverSide: true,
sAjaxSource: "http://127.0.0.1:8000/data/", // new url
columns: [
{name: "name", data: "person_name"},
{name: "code", data: "person_code"},
{name: "description", data: "person_description"},
{name: "building", data: "person__building__name"},
],
});
});
</script>
</body>
</html>
The dataTables columns option must be configured in the dataTable initialization. Each column is required to have a data attribute coresponding to the view's columns array. Name is optional as of version 2.0.0 and is no longer used.
The data attribute must corespond to a valid field provided by the view and must ultimately match an attribute on records in your queryset. Use annotations on your queryset if you prefer data values that don't look like "person__building__name."
This is generally compatible with datatable features such as ColReorder and colvis.
For further customization of Datatable, you may refer the Datatable official documentation.
Updates
New in version 2.0.0:
- Fixed a bug where using a -1 for the pagination length would not work as expected (now provides all records)
- Implemented regex filtering
- Implemented column based filtering
- Wrote tests
- Refactored all code to streamline the process and speed up queries
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
Hashes for django_datatable_serverside_mixin-2.0.0.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8497a43ab9b320ca2127ed39a661abb899261b9cf00ebd896448d118fbe7c2ef |
|
| MD5 | 1225e163b035f62ebe1dff278e00eb85 |
|
| BLAKE2b-256 | 2bd66475b1fa13df85920459ed3931698a0e7e8f8474126d67dc847602b01a19 |
Hashes for django_datatable_serverside_mixin-2.0.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0c0beabb04c04b8d2b63298cd534d2b0f510c4b4b1ea4b6c6232a4c38e06e5f8 |
|
| MD5 | 75cdcb10a42c57ecdc357c6f30b5e26d |
|
| BLAKE2b-256 | 2149b3555029a3d1d23326bfbed2e8cc14e5aa0e14cad458fecc1457e8d42769 |
