Skip to main content

Reusable application for Django bridging client and server sides

Project description

https://github.com/idlesign/django-siteajax

release lic ci coverage

Description

Reusable application for Django bridging client and server sides

Streamline you server and client interaction using declarative techniques in your HTML and helpful abstractions from siteajax in your Python code.

Usage

Somewhere in your views.py:

from django.shortcuts import redirect, render
from siteajax.toolbox import ajax_dispatch


def get_news(request):
    news = ...  # Here we fetch some news from DB.
    # We could access `request.ajax` object properties
    # or even drive client side with the help
    # of siteajax.toolbox.AjaxResponse but for this demo
    # simple rendering is enough.
    return render(request, 'sub_news.html', {'news': news})

@ajax_dispatch({
    # Map request source element id (see html below)
    # to a handler.
    'news-list': get_news,
})
def index_page(request):
    """Suppose this view is served at /"""
    return render(request, 'index.html')

Now to your index.html:

<!DOCTYPE html>
<html>
<head>
    <!-- Get client library js from CDN. -->
    {% include "siteajax/cdn.html" %}
</head>
<body>
    <div id="news-list" hx-get hx-trigger="load"></div>
    <!-- The contents of the above div will be replaced
        with the news from your server automatically fetched on page load.
        Notice `hx-*` attributes driving htmx JS library.
        Also notice how `id="news-list"` is used by `@ajax_dispatch`
        view decorator (shown above). -->
</body>
</html>

At last sub_news.html (nothing special):

{% for item in news %}<div>{{ item.title }}</div>{% endfor %}

Documentation

https://django-siteajax.readthedocs.org/

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

django-siteajax-0.5.0.tar.gz (16.4 kB view details)

Uploaded Source

Built Distribution

django_siteajax-0.5.0-py2-none-any.whl (13.5 kB view details)

Uploaded Python 2

File details

Details for the file django-siteajax-0.5.0.tar.gz.

File metadata

  • Download URL: django-siteajax-0.5.0.tar.gz
  • Upload date:
  • Size: 16.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Python-urllib/2.7

File hashes

Hashes for django-siteajax-0.5.0.tar.gz
Algorithm Hash digest
SHA256 737f1c0e43eeab3b58cbfe6b5cadae4d851c2d56a9f5cedaa9f4bf825e1f865a
MD5 034dcec6adf6dee8a40f48491ffb31bd
BLAKE2b-256 ef9e0b8836d3da01faefc1b9f5d4989e8d95b55c1570401897a0efa8fe53e6b2

See more details on using hashes here.

File details

Details for the file django_siteajax-0.5.0-py2-none-any.whl.

File metadata

File hashes

Hashes for django_siteajax-0.5.0-py2-none-any.whl
Algorithm Hash digest
SHA256 0c598ae9909ee44e753f3846de1051ed1d9df978e6698d8d62208ed0e98be10f
MD5 a2eaee08c538bb45a9469d44d4377b90
BLAKE2b-256 eb637384b1fa0e1c390da2f6f549fb3baebd36967c038ce6bc7cd24039e46ead

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page