.. image:: https://img.shields.io/pypi/v/django-js-reverse.svg :target: https://pypi.python.org/pypi/django-js-reverse/
.. image:: https://img.shields.io/travis/ierror/django-js-reverse/master.svg :target: https://travis-ci.org/ierror/django-js-reverse
.. image:: https://coveralls.io/repos/github/vintasoftware/django-js-reverse/badge.svg?branch=master :target: https://coveralls.io/github/vintasoftware/django-js-reverse?branch=master
.. image:: https://img.shields.io/github/license/ierror/django-js-reverse.svg :target: https://raw.githubusercontent.com/vintasoftware/django-js-reverse/master/LICENSE
.. image:: https://img.shields.io/pypi/wheel/django-js-reverse.svg
Javascript url handling for Django that doesn’t hurt.
This package is now maintained by Vinta Software <https://vintasoftware.com.br>
but it was originally created by @ierror <https://github.com/ierror>
. Many thanks to you, Bernhard.
Django JS Reverse is a small django app that makes url handling of
named urls <https://docs.djangoproject.com/en/dev/topics/http/urls/#naming-url-patterns>
__ in javascript easy and non-annoying..
For example you can retrieve a named url:
urls.py:
::
url(r'^/betterliving/(?P<category_slug>[-\w]+)/(?P<entry_pk>\d+)/$', 'get_house', name='betterliving_get_house'),
in javascript like:
::
Urls.betterlivingGetHouse('house', 12)
Result:
::
/betterliving/house/12/
+----------------+--------------------+ | Python version | Django versions | +================+====================+ | 3.11 | 4.2, 4.1, 4.0, 3.2 | +----------------+--------------------+ | 3.10 | 4.2, 4.1, 4.0, 3.2 | +----------------+--------------------+ | 3.9 | 4.2, 4.1, 4.0, 3.2 | +----------------+--------------------+ | 3.8 | 4.2, 4.1, 4.0, 3.2 | +----------------+--------------------+
Install using pip
…
::
pip install django-js-reverse
… or clone the project from github.
::
git clone https://github.com/vintasoftware/django-js-reverse.git
Add 'django_js_reverse'
to your INSTALLED_APPS
setting.
::
INSTALLED_APPS = (
...
'django_js_reverse',
)
Install using npm
::
npm install --save django-js-reverse
Include none-cached view …
::
urlpatterns = patterns('',
url(r'^jsreverse.json$', 'django_js_reverse.views.urls_json', name='js_reverse'),
)
… or a cached one that delivers the urls JSON
::
from django_js_reverse import views
urlpatterns = patterns('',
url(r'^jsreverse.json$', cache_page(3600)(views.urls_json), name='js_reverse'),
)
Include JavaScript in your bundle:
::
// utils/djangoReverse.mjs
import _ from 'lodash/fp';
import djangoJsReverse from 'django-js-reverse';
export default _.once(
async () => {
const res = await fetch('/jsreverse.json');
const data = await res.json();
return djangoJsReverse(data);
}
)
::
// somePlace.mjs
import djangoReverse from './utils/djangoReverse';
(async () => {
const urls = await djangoReverse();
const url = urls.someViewName('some-arg');
...
})();
First generate static file by
::
./manage.py collectstatic_js_reverse
If you change some urls or add an app and want to update the reverse.js file, run the command again.
After this add the file to your template
::
<script src="https://github.com/vintasoftware/django-js-reverse/raw/develop/{% static 'django_js_reverse/js/reverse.js' %}"></script>
Include none-cached view …
::
urlpatterns = patterns('',
url(r'^jsreverse/$', 'django_js_reverse.views.urls_js', name='js_reverse'),
)
… or a cached one that delivers the urls javascript
::
from django_js_reverse.views import urls_js
urlpatterns = patterns('',
url(r'^jsreverse/$', cache_page(3600)(urls_js), name='js_reverse'),
)
Include javascript in your template
::
<script src="https://github.com/vintasoftware/django-js-reverse/raw/develop/{% url js_reverse %}" type="text/javascript"></script>
or, if you are using Django > 1.5
::
<script src="https://github.com/vintasoftware/django-js-reverse/raw/develop/{% url 'js_reverse' %}" type="text/javascript"></script>
Usage as template tag
You can place the js_reverse JavaScript inline into your templates,
however use of inline JavaScript is not recommended, because it
will make it impossible to deploy a secure Content Security Policy.
See django-csp <https://django-csp.readthedocs.io/>
__
::
{% load js_reverse %}
<script type="text/javascript" charset="utf-8">
{% js_reverse_inline %}
</script>
If your url names are valid javascript identifiers ([$A-Z_][-Z_$]*)i 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:
::
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 })
Optionally, you can overwrite the default javascript variable ‘Urls’ used to access the named urls by django setting
::
JS_REVERSE_JS_VAR_NAME = 'Urls'
Optionally, you can change the name of the global object the javascript variable
used to access the named urls is attached to. Default is :code:this
::
JS_REVERSE_JS_GLOBAL_OBJECT_NAME = 'window'
Optionally, you can disable the minfication of the generated javascript file by django setting
::
JS_REVERSE_JS_MINIFY = False
By default all namespaces are included
::
JS_REVERSE_EXCLUDE_NAMESPACES = []
To exclude any namespaces from the generated javascript file, add them to the JS_REVERSE_EXCLUDE_NAMESPACES
setting
::
JS_REVERSE_EXCLUDE_NAMESPACES = ['admin', 'djdt', ...]
If you want to include only specific namespaces add them to the JS_REVERSE_INCLUDE_ONLY_NAMESPACES
setting
tips:
::
JS_REVERSE_INCLUDE_ONLY_NAMESPACES = ['poll', 'calendar', ...]
If you run your application under a subpath, the collectstatic_js_reverse needs to take care of this. Define the prefix in your django settings:
::
JS_REVERSE_SCRIPT_PREFIX = '/myprefix/'
By default collectstatic_js_reverse writes its output (reverse.js) to your project's STATIC_ROOT. You can change the output path:
::
JS_REVERSE_OUTPUT_PATH = 'some_path'
::
tox
MIT <https://raw.github.com/vintasoftware/django-js-reverse/master/LICENSE>
__
This project is currently maintained by Vinta Software <https://vintasoftware.com>
. If you need support please contact us on contact@vintasoftware.com <mailto:contact@vintasoftware.com>
.
Enjoy!