Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

Reusable application for Django nicely bridging client and server sides.

Project description

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

https://landscape.io/github/idlesign/django-xross/master/landscape.svg?style=flat

Description

Reusable application for Django nicely bridging client and server sides.

Streamline you server and client interaction using some declarative techniques in your HTML, and a couple of xross functions in your views.

Somewhere in your views.py:

from django.shortcuts import render
from xross.toolbox import xross_view, xross_listener  # That's all we need from xross.


def list_news(request):
    """This function will be used by xross to load news using AJAX."""
    news = ...  # Here we fetch some news from DB.
    return render(request, 'mytemplates/sub_news.html', {'news': news})


@xross_view(list_news)  # Decorate your view - instruct xross to use `list_news` when needed.
def index_page(request):
    """This is our view to streamline."""

    xross_listener()  # xross will handle AJAX calls from that moment.

    return render(request, 'mytemplates/index.html')

Now to your mytemplates/index.html:

<!DOCTYPE html>
<html>
<head>
    <!-- xross depends on jQuery. Include it. -->
    <script src="http://yandex.st/jquery/2.1.1/jquery.min.js"></script>

    <!-- Now xross itself. -->
    <script src="{{ STATIC_URL }}js/xross/xross.min.js"></script>
    <script type="text/javascript">
        xross.automate();  // Instruct xross to watch for page elements with `xross` class.
    </script>
</head>
<body>
    <div id="list_news" class="xross">
        <!--
            Contents of this div will be replaced with news from Django's `list_news()`
            automatically on page load.

            That's the default of xross, but it knows some other nice little tricks.
            Read the docs.
         -->
    </div>
</body>
</html>

At last mytemplates/sub_news.html (nothing special):

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

That’s not all, not at all. Read the docs!

Project details


Release history Release notifications

This version
History Node

0.6.0

History Node

0.5.1

History Node

0.5.0

History Node

0.4.0

History Node

0.3.0

History Node

0.2.0

History Node

0.1.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
django-xross-0.6.0.tar.gz (22.2 kB) Copy SHA256 hash SHA256 Source None Feb 21, 2016

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page