Skip to main content

Extend Django formsets with JavaScript

Project description

A wrapper for a JavaScript formset helper.

Installing

Install via pip:

pip install django-formset-js

Then add it and its dependancies django-jquery-js to your INSTALLED_APPS:

INSTALLED_APPS += (
    'django.contrib.staticfiles',
    'jquery',
    'djangoformsetjs',
)

Using

Include the djangoformsetjs.utils.formset_media_js files in your form Media, and render it on the page:

from djangoformsetsjs.utils import formset_media_js

class MyForm(forms.Form):
    class Media(object):
        js = formset_media_js + (
            # Your form media here
        )

MyFormSet = formset_factory(MyForm)

To activate it in the page, you must include the Media of the form:

{% block extra_script %}
    {{ form.media }}
{% endblock %}

Alternatively, simply add the script tag:

<script src="{{ STATIC_URL }}js/jquery.formset.js"></script>

Then render your formset. Certain blocks of your formset need to be marked up so the formset library can find them. Note the data-formset-... attributes in the code below:

{% load formset_tags %}

<div id="#formset" data-formset-prefix="{{ formset.prefix }}">
    {{ formset.management_form }}

    <div data-formset-body>
        <!-- New forms will be inserted in here -->
        {% for form in formset %}
            <div data-formset-form>
                {{ form }}
                <a data-formset-delete-button>Delete form</a>
            </div>
        {% endfor %}
    </div>

    <!-- The empty form template. By wrapping this in a <script> tag, the
    __prefix__ placeholder can easily be replaced in both attributes and
    any scripts -->
    <script type="form-template" data-formset-empty-form>
        {% escapescript %}
            <div data-formset-form>
                {{ formset.empty_form }}
            </div>
        {% escapescript %}
    </script>

    <!-- This button will add a new form when clicked -->
    <input type="button" value="Add another" data-formset-add>

    <script>jQuery(function($) {
        $("#formset").formset();
    });</script>

</div>

The data attributes are as follows:

data-formset-prefix

The value of {{ formset.prefix }}. This is used to find the management form.

data-formset-body

This indicates where all the child forms are. New forms are inserted in here.

data-formset-empty-form

The element that contains the empty form template. For best results, use a <script> tag.

data-formset-add

A button that adds a new form.

data-formset-delete-button

A button that deletes that form.

The empty form template is wrapped in a <script> to stop any JavaScript attached to widgets from running upon page load, and to make finding and replacing the __prefix__ placeholder easier. The contents of the <script> should be wrapped in a {% escapescript %} block to prevent any script tags inside from closing the wrapping script tag prematurely.

If the forms can be deleted, and contain a delete button, the forms will be hidden from view when deleted. The DELETE field should be hidden if the delete button is used. The delete button is identified by the data-formset-delete-button attribute:

{% for form in formset %}
    <div data-formset-form>
        {{ form.name }}
        {{ form.age }}

        <div class="hidden">{{ form.DELETE }}</div>
        <a data-formset-delete-button>Delete form</a>
    </div>
{% endfor %}

Project details


Download files

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

Source Distribution

django-formset-js-0.3.0.tar.gz (6.1 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page