1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
|
Tutorial
~~~~~~~~
This is a step-by-step guide to learn how to install and use django-tables2 using Django 2.0 or later.
1. ``pip install django-tables2``
2. Start a new Django app using `python manage.py startapp tutorial`
3. Add both ``"django_tables2"`` and ``"tutorial"`` to your ``INSTALLED_APPS`` setting in ``settings.py``.
Now, add a model to your ``tutorial/models.py``::
# tutorial/models.py
class Person(models.Model):
name = models.CharField(max_length=100, verbose_name="full name")
Create the database tables for the newly added model::
$ python manage.py makemigrations tutorial
$ python manage.py migrate tutorial
Add some data so you have something to display in the table::
$ python manage.py shell
>>> from tutorial.models import Person
>>> Person.objects.bulk_create([Person(name="Jieter"), Person(name="Bradley")])
[<Person: Person object>, <Person: Person object>]
Now use a generic ``ListView`` to pass a ``Person`` QuerySet into a template.
Note that the context name used by `ListView` is `object_list` by default::
# tutorial/views.py
from django.views.generic import ListView
from .models import Person
class PersonListView(ListView):
model = Person
template_name = 'tutorial/people.html'
Add the view to your ``urls.py``::
# urls.py
from django.urls import path
from django.contrib import admin
from tutorial.views import PersonListView
urlpatterns = [
path("admin/", admin.site.urls),
path("people/", PersonListView.as_view())
]
Finally, create the template::
{# tutorial/templates/tutorial/people.html #}
{% load render_table from django_tables2 %}
<!doctype html>
<html>
<head>
<title>List of persons</title>
</head>
<body>
{% render_table object_list %}
</body>
</html>
You should be able to load the page in the browser (http://localhost:8000/people/ by default),
you should see:
.. figure:: /_static/tutorial.png
:align: center
:alt: An example table rendered using django-tables2
This view supports pagination and ordering by default.
While simple, passing a QuerySet directly to ``{% render_table %}`` does not
allow for any customization. For that, you must define a custom `.Table` class::
# tutorial/tables.py
import django_tables2 as tables
from .models import Person
class PersonTable(tables.Table):
class Meta:
model = Person
template_name = "django_tables2/bootstrap.html"
fields = ("name", )
You will then need to instantiate and configure the table in the view, before
adding it to the context::
# tutorial/views.py
from django_tables2 import SingleTableView
from .models import Person
from .tables import PersonTable
class PersonListView(SingleTableView):
model = Person
table_class = PersonTable
template_name = 'tutorial/people.html'
Rather than passing a QuerySet to ``{% render_table %}``, instead pass the
table instance::
{# tutorial/templates/tutorial/people.html #}
{% load render_table from django_tables2 %}
<!doctype html>
<html>
<head>
<title>List of persons</title>
<link rel="stylesheet" href="file:///usr/share/javascript/bootstrap/css/bootstrap.min.css" />
</head>
<body>
{% render_table table %}
</body>
</html>
This results in a table rendered with the bootstrap3 style sheet:
.. figure:: /_static/tutorial-bootstrap.png
:align: center
:alt: An example table rendered using django-tables2 with the bootstrap template
At this point you have only changed the columns rendered in the table and the template.
There are several topic you can read into to further customize the table:
- Table data
- :ref:`Populating the table with data <table_data>`,
- :ref:`Filtering table data <filtering>`
- Customizing the rendered table
- :ref:`Headers and footers <column-headers-and-footers>`
- :ref:`pinned_rows`
- :ref:`api-public`
If you think you don't have a lot customization to do and don't want to make
a full class declaration use ``django_tables2.tables.table_factory``.
|
