django-reverse-js

Django Reverse JS

JavaScript url handling for Django that doesn’t hurt.

Original idea from django-js-reverse.

Django Reverse JS is a small django app that makes url handling of named urls in JavaScript easy and confortable for django's users.

For example you can retrieve a named url:

path('/betterliving/<str:category_slug>/<int:entry_pk>/', 'get_house', name='betterliving_get_house')

in JavaScript it can be resolved like:

Urls.betterlivingGetHouse('house', 12)
// '/betterliving/house/12/'

Installation

Install using pip

pip install django-reverse-js

… or clone the project from github.

git clone https://github.com/sevdog/django-reverse-js.git

Add 'django_reverse_js' to your INSTALLED_APPS setting.

INSTALLED_APPS = (
    ...
    'django_js_reverse',
)

Usage

As a static file

First generate static file with createstatic_reversejs command

django-admin createstatic_reversejs

NOTE: If you change some urls or add an app and want to update the reverse.js file by running again the command.

After this add the file to your template

<script src="{% static 'django_reverse_js/js/reverse.js' %}"></script>

As view

Include view in your URLCONF (you may also cache this is needed):

urlpatterns = [
    ...,
    path('reverse.js', 'django_reverse_js.views.urls_js', name='reverse_js'),
]

Then include JavaScript in your template

<script src="{% url 'reverse_js' %}" type="text/javascript"></script>

As template tag

You can place the reverse_js JavaScript inline into your templates, however use of inline JavaScript is not recommended, because it may cause problems with Content Security Policy. See django-csp for further readings.

{% load reversejs %}

<script type="text/javascript" charset="utf-8">
    {% reverse_js %}
</script>

---

Use the resolver in JavaScript

If your url names are valid JavaScript identifiers you can access them by the dot notation:

Urls.betterlivingGetHouse('house', 12)

If the named url contains invalid identifiers use the square-bracket notation instead:

NOTE: ATM namespaced urls must be accessd in this way

Urls['betterliving-get-house']('house', 12)
Urls['namespace:betterliving-get-house']('house', 12)

You can also pass javascript objects to match keyword aguments like the examples bellow:

Urls['betterliving-get-house']({ category_slug: 'house', entry_pk: 12 })
Urls['namespace:betterliving-get-house']({ category_slug: 'house', entry_pk: 12 })

Settings

• REVERSEJS_VAR_NAME: name given to JavaScript variable used to access django urls; default Urls.

• REVERSEJS_GLOBAL_OBJECT_NAME: global JavaScript object to which bound resolver variable; default window.

• REVERSEJS_EXCLUDE_NAMESPACES: list of url namespaces to be excluded from JavaScript resolver; default [] (aka: all namespaces allowed).

• REVERSEJS_INCLUDE_ONLY_NAMESPACES: list of url namespaces to be included in JavaScript resolver; default [] (aka: all namespaces allowed).

  • use '' (empty string) to allow only url without a namespace
  • use 'foo\0' (namespace name terminated with null-char) to include only urls from 'foo' namespace and prevent any inner namespace to be extracted (ie: 'foo:bar')

• REVERSEJS_SCRIPT_PREFIX: path of application (when served behing a reverse-proxy), needed to return full-urls; default None.

• REVERSEJS_OUTPUT_PATH: path where to place file created by createstatic_reversejs command, if not provided STATIC_ROOT is used; defatul None.

• REVERSEJS_MINIFY: flag which indicates if the minified version of JS script should be used; default False.

NOTE: at the moment only one between REVERSEJS_INCLUDE_ONLY_NAMESPACES and REVERSEJS_EXCLUDE_NAMESPACES may be used.