django-js-routes 0.2.0

Main requirements

Python 3.6+, Django 3.2+.

Installation

To install Django-js-routes, please use the pip command as follows:

$ pip install django-js-routes

Once the package is installed, you’ll have to add the application to INSTALLED_APPS in your project’s settings module:

INSTALLED_APPS = (
    # all other apps...
    'js_routes',
)

You can then define which URL patterns or URL namespaces you want to expose to the client side by setting the JS_ROUTES_INCLUSION_LIST setting. This setting allows to define which URLs should be serialized and made available to the client side through the generated and / or exported Javascript helper. This list should contain only URL pattern names or namespaces. Here is an example:

JS_ROUTES_INCLUSION_LIST = [
    'home',
    'catalog:product_list',
    'catalog:product_detail',
]

Note that if a namespace is included in this list, all the underlying URLs will be made available to the client side through the generated Javascript helper. Django-js-routes is safe by design in the sense that only the URLs that you configure in this inclusion list will be publicly exposed on the client side.

Once the list of URLs to expose is configured, you can add the {% js_routes %} tag to your base template in order to ensure that the Javascript helper is available to you when you need it:

{% load js_routes_tags %}
<html>
    <head>
    </head>
    <body>
        <!-- At the bottom of the document's body... -->
        {% js_routes %}
    </body>
</html>

Usage

The URL patterns you configured through the JS_ROUTES_INCLUSION_LIST setting can then be reversed using the generated window.reverseUrl function, which can be used pretty much the “same” way you’d use reverse on the Django side:

window.reverseUrl('home');
window.reverseUrl('catalog:product_list');
window.reverseUrl('catalog:product_detail', productId);
window.reverseUrl('catalog:product_detail', { pk: productId });

Settings

JS_ROUTES_INCLUSION_LIST

Default: []

The JS_ROUTES_INCLUSION_LIST setting allows to define the URL patterns and URL namespaces that should be exposed to the client side through the generated Javascript helper.

Advanced features

{% js_routes routes_only=True %}
<script src="{% static 'js/routes/resolver.js' %}"></script>

$ python manage.py dump_routes_resolver --format=default --output=my_exported_resolver.js

License

MIT. See LICENSE for more details.