django-query-params

Django app providing template tags and JavaScript functions for query string management.

Template Tag Library

To install the app, type:

(venv)$ pip install django-query-params

Then add "query_params" to the INSTALLED_APPS in the settings.

To use the template tags in templates:

{% load query_params_tags %}

{% modify_query ["only_query_string"] "param_to_remove" "another_param_to_remove" param_to_change="new-value" another_param_to_change="new-value" %}

{% add_to_query ["only_query_string"] "param_to_remove" "another_param_to_remove" param_to_add="new-value" another_param_to_add="new-value" %}

{% remove_from_query ["only_query_string"] "param_to_remove" another_param_to_remove="value" %}

JavaScript Library

{% load static %}
<script src="{% static 'query_params/js/query_params.js' %}"></script>

<script>
var url1 = modify_query(
    location, 
    ['param_to_remove', 'another_param_to_remove'], 
    {
        param_to_change: 'new-value',
        another_param_to_change: 'new-value'
    },
    only_query_string=false
);

var url2 = add_to_query(
    location,
    ['param_to_remove', 'another_param_to_remove'],
    {
        param_to_add: 'new-value',
        another_param_to_add: 'new-value'
    },
    only_query_string=false
);

var url3 = remove_from_query(
    location,
    ['param_to_remove'],
    {
        another_param_to_remove: 'value'
    },
    only_query_string=false
);
</script>

Example

Let's say the current URL is:
https://example.com/posts/?page=2&sort=by-date&tag=environment&tag=sustainability

modify_query

{% modify_query "page" tag="ecological" %}

will render:

/posts/?sort=by-date&tag=ecological

and

{% modify_query "only_query_string" "page" tag="ecological" %}

will render:

?sort=by-date&tag=ecological

add_to_query

{% add_to_query "page" tag="ecological" %}

will render:

/posts/?sort=by-date&tag=ecological&tag=environment&tag=sustainability

and

{% add_to_query "only_query_string" "page" tag="ecological" %}

will render:

?sort=by-date&tag=ecological&tag=environment&tag=sustainability

remove_from_query

{% remove_from_query "page" tag="environment" %}

will render:

/posts/?sort=by-date&tag=sustainability

and

{% remove_from_query "only_query_string" "page" tag="environment" %}

will render:

?sort=by-date&tag=sustainability