Skip to main content

A Django app to add Ajax capabilities to django-tables2

This app is an enhancement for django-tables2. It adds Ajax capability to allow tables to be sorted and paged without reloading the entire page.

Requirements

Installation

Install with pip:

pip install django-ajax-tables

Add django_ajax_tables to the settings.py installed_apps:

INSTALLED_APPS = (
    ...,
    "django_ajax_tables",
)

Features

This app adds a new Django template tag {% ajax_table %}. This is a replacement for the django-tables2 {% render_table %} tag.

To implement the Ajax functionality you will need to add a view which returns the raw table html (example shown below). The {% ajax_table %} tag will use that html to render the table on the page. It will also configure the table sorting and pagination links to perform Ajax calls and in-place updates of the table. This will allow you to sort and page through the table without the entire webpage refreshing on each click.

This will not affect any LinkColumns that have been added to the table layout.

Example

Create a django-tables2 table and wire it to a model as normal:

import django_tables2 as tables

class SimpleTable(tables.Table):
    class Meta:
        model = Simple

Create a view that exposes the table as raw html:

from django.http import HttpResponse
from django_tables2 import RequestConfig

def simple_view(request):
    simple_table = SimpleTable(Simple.objects.all())
    RequestConfig(request).configure(simple_table)
    return HttpResponse(simple_table.as_html(request))

Create a url mapping for the view:

urlpatterns = [
    ...,
    url(r'^simple_url$', simple_view, name='simple_url_name'),

Place ajax_table tags where tables are to be displayed:

{% ajax_table "unique_div_id" "simple_url_name" %}

Usage

The ajax_table tag requires at least two parameters.

  • The first parameter is a unique id. This id should not used for any other element on the page. The ajax_table tag will create a div element with this id to contain the table.
  • The second parameter is the name of the url that is mapped to the table view.
  • Any additional non-keyword arguments will be passed as positional arguments to the url. If used this will prevent the passing of keyword arguments to the url.
  • The template keyword argument can be used to replace the django-ajax-tables javascript with custom javascript.
  • Any additional keyword arguments will be passed as keyword aguments to the url but only if there were no positional arguments passed to the url.

Example with positional arguments

{% ajax_table "unique_div_id" "simple_url_name" arg1 arg2 %}

Example with keyword arguments

{% ajax_table "unique_div_id" "simple_url_name" filter1=arg1 filter2=arg2 %}

Javascript API

The table loading function can also be caled direcly in javascript. This can be useful if the data needs to be refreshed. The function name will be in the form of update_<id> where <id> is the unique id parameter that was pased in to the ajax_table tag.

The function can take two optional parameters. The first parameter is a query string which will appened to the url. This defaults to an empty string. The second parameter is a url which will be used by the ajax call to fetch the table data. This defaults to the original url as created by the ajax_table tag.

Together these two parameters allow the table data to be loaded with different query parameters or from entirly different urls.

Metadata

Release files for django-ajax-tables 1.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for django-ajax-tables 1.1.1
File Size Uploaded Provenance Actions
django_ajax_tables-1.1.1.tar.gz 4.5 kB Without provenance Details for django_ajax_tables-1.1.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for django-ajax-tables 1.1.1
File Interpreter ABI Platform Actions
django_ajax_tables-1.1.1-py3-none-any.whl Python 3 none any Details for django_ajax_tables-1.1.1-py3-none-any.whl

Total release size: 9.8 kB

Release files / django_ajax_tables-1.1.1.tar.gz

Download URL django_ajax_tables-1.1.1.tar.gz
Size 4.5 kB
Tags Source
SHA-256 checksum
How to use checksums
5a7e7bc7940aa6332a564916cde22010a858a3d29fc1090ce8061010ec76337c
BLAKE2b-256 checksum
How to use checksums
12f70240d6694bb29be34ada44364e5459d0ce318e5b34b850fd4a6b576847ef
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.0.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.6.9

Release files / django_ajax_tables-1.1.1-py3-none-any.whl

Download URL django_ajax_tables-1.1.1-py3-none-any.whl
Size 5.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
62e0138949153c0a994eefbf469f5496b1ad98bc073e170bc021a1aada7a32d0
BLAKE2b-256 checksum
How to use checksums
7830e152372e9b629648566e24236a0044d7e35367eef6db22a240318073dadc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.0.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.6.9

Security for django-ajax-tables 1.1.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.1.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page