django-convenient-formsets

KO | EN

gitlite — search

#javascript #react #html #python #ios #postgresql #github-actions #api #deep-learning #ethereum #css #hacktoberfest

django-convenient-formsets

★ 15 Open GitHub ↗

Django dynamic formsets made convenient for users and developers alike.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Django Convenient Formsets

[![Python unit tests](https://github.com/tiesjan/django-convenient-formsets/actions/workflows/run_python_unit_tests.yml/badge.svg)](https://github.com/tiesjan/django-convenient-formsets/actions/workflows/run_python_unit_tests.yml)
[![End-to-end tests](https://github.com/tiesjan/django-convenient-formsets/actions/workflows/run_end_to_end_tests.yml/badge.svg)](https://github.com/tiesjan/django-convenient-formsets/actions/workflows/run_end_to_end_tests.yml)
[![Linters](https://github.com/tiesjan/django-convenient-formsets/actions/workflows/run_linters.yml/badge.svg)](https://github.com/tiesjan/django-convenient-formsets/actions/workflows/run_linters.yml)
[![TestingBot Test Status](https://testingbot.com/buildstatus/e67ac1c27fb0bd343c6f9ec32707a626)](https://testingbot.com/builds/e67ac1c27fb0bd343c6f9ec32707a626)

This Django app aims to make dynamic formsets convenient for users and
developers alike. It extends Django's built-in formset classes and includes
support for adding, deleting and ordering of forms in the browser. JavaScript
events are dispatched when forms are added, deleted or reordered, for executing
custom logic.

#### Supported platforms
- Django: 4.2+
- Python: 3.8+
- Tested desktop browsers: latest Chrome, latest Firefox, latest Edge,
  latest Opera, latest Safari

Other platform versions may work, but are not actively tested.

## Installation
1. Install using pip:

```shell
    $ pip install django-convenient-formsets
    ```

2. Add to `INSTALLED_APPS`:

```python
    INSTALLED_APPS = [
        # ...
        'convenient_formsets'
    ]
    ```

## Quick start
1. Create a formset in your Python code:

```python
    from convenient_formsets import ConvenientBaseFormSet
    from django import forms

class EmailForm(forms.Form):
        email = forms.EmailField()

EmailFormSet = forms.formset_factory(
        EmailForm,
        formset=ConvenientBaseFormSet,
        can_delete=True,
        can_order=True,
    )

email_formset = EmailFormSet(prefix='email-formset')
    ```

2. Render formset in your template and add JavaScript code for initialization:

```htmldjango
    <!doctype html>
    <html>
    <head>
        
        {{ email_formset.media }}

<script>
            window.addEventListener('load', function(event) {
                new ConvenientFormset({
                    'formsetPrefix': '{{ email_formset.prefix }}',
                    'formsContainerSelector': '#email-formset #email-forms-container',
                    'formSelector': '.email-form',

'canAddForms': true,
                    'addFormButtonSelector': '#email-formset #add-form-button',
                    'emptyFormTemplateSelector': '#email-formset #empty-form-template',

'canDeleteForms': true,
                    'deleteFormButtonSelector': '.delete-form-button',

'canOrderForms': true,
                    'moveFormDownButtonSelector': '.move-form-down-button',
                    'moveFormUpButtonSelector': '.move-form-up-button',
                });
            });
        </script>
    </head>

<body>
        
        <div id="email-formset">
            <div id="email-forms-container">
                {% for email_form in email_formset.forms %}
                <div class="email-form">
                    {{ email_form.email }}
                    {% if email_formset.can_delete %}
                        {{ email_form.DELETE }}
                        <input type="button" class="delete-form-button" value="Delete">
                    {% endif %}
                    {% if email_formset.can_order %}
                        {{ email_form.ORDER }}
                        <input type="button" class="move-form-up-button" value="Move up">
                        <input type="button" class="move-form-down-button" value="Move down">
                    {% endif %}
                </div>
                {% endfor %}
            </div>
            <div><input type="button" id="add-form-button" value="Add another"></div>
            <template id="empty-form-template">
                <div class="email-form">
                    {{ email_formset.empty_form.email }}
                    {% if email_formset.can_delete %}
                        <input type="button" class="delete-form-button" value="Delete">
                    {% endif %}
                    {% if email_formset.can_order %}
                        {{ email_form.ORDER }}
                        <input type="button" class="move-form-up-button" value="Move up">
                        <input type="button" class="move-form-down-button" value="Move down">
                    {% endif %}
                </div>
            </template>
            {{ email_formset.management_form }}
        </div>
    </body>
    </html>
    ```

## Usage

### Server side
The Python classes `ConvenientBaseFormSet`, `ConvenientBaseModelFormSet` and
`ConvenientBaseInlineFormSet` extend Django's built-in `BaseFormSet`,
`BaseModelFormSet` and `BaseInlineFormSet` by:
- Overriding `deletion_widget` for the `DELETE` field and `ordering_widget` for
  the `ORDER` field. They default to the `forms.HiddenInput` widget in order to
  hide them from the user.
- Including the JavaScript file in the formset's `media` attribute required
  for dynamic formsets.

### Client side
See the example in the Quick start guide above on how to render the formset in
your HTML template. Feel free to add some intermediate DOM elements if it suits
your template better, as long as you stick to the basic structure shown above.

It is important that both the visible forms and the empty form follow the same
structure. A form also needs to be contained inside a single parent element,
denoted by the _**formSelector**_ parameter:

```htmldjango

<div id="email-forms-container">
    <div class="email-form">
        
    </div>
</div>

<template id="empty-form-template">
    <div class="email-form">
        
    </div>
</template>
```

#### Configuration
Creating an instance of the JavaScript constructor function `ConvenientFormset`
allows a user to add, delete and reorder forms within the rendered formset.
When a user makes changes, the management form is updated accordingly. The
constructor function can be passed the parameters outlined below. In case
initialization fails, check the browser console for some helpful output.

###### GENERAL
<dl>
  <dt>formsetPrefix</dt>
  <dd>The formset's "prefix" attribute (required).</dd>
  <dt>formsContainerSelector</dt>
  <dd>CSS selector for the DOM element that contains all the forms (required).</dd>
  <dt>formSelector</dt>
  <dd>CSS selector for each form within "formsContainerSelector" (required).</dd>
</dl>

---

###### ADDING FORMS
<dl>
  <dt>canAddForms</dt>
  <dd>Enables adding of new forms (default: true).</dd>
  <dt>addFormButtonSelector</dt>
  <dd>CSS selector for the DOM element that may be clicked to add an empty form (required if "canAddForms" is set).</dd>
  <dt>emptyFormTemplateSelector</dt>
  <dd>CSS selector for the empty form &lt;template&gt; element (required if "canAddForms" is set).</dd>
  <dt>hideAddFormButtonOnMaxForms</dt>
  <dd>Hides the add button when reaching the maximum number of forms, by applying the "hidden" HTML attribute (default: true).</dd>
</dl>

---

###### DELETING FORMS
<dl>
  <dt>canDeleteForms</dt>
  <dd>Enables deleting of forms (default: false).</dd>
  <dt>deleteFormButtonSelector</dt>
  <dd>CSS selector for the DOM element within "formSelector" that may be clicked to delete a form (required if "canDeleteForms" is set).</dd>
</dl>

---

###### ORDERING FORMS
<dl>
  <dt>canOrderForms</dt>
  <dd>Enables ordering of forms (default: false).</dd>
  <dt>moveFormDownButtonSelector</dt>
  <dd>CSS selector for the DOM element within "formSelector" that may be clicked to move a form down among the visible forms (required if "canOrderForms" is set).</dd>
  <dt>moveFormUpButtonSelector</dt>
  <dd>CSS selector for the DOM element within "formSelector" that may be clicked to move a form up among the visible forms (required if "canOrderForms" is set).</dd>
</dl>

---

#### Events
When adding, deleting or reordering forms, custom JavaScript events are
dispatched to allow for executing custom JavaScript code:

<dl>
  <dt>convenient_formset:added</dt>
  <dd>Dispatched when a form is added to the formset.</dd>
  <dt>convenient_formset:removed</dt>
  <dd>Dispatched when a form is removed to the formset.</dd>
  <dt>convenient_formset:movedDown</dt>
  <dd>Dispatched when a form is moved downwards while reordering forms inside the formset.</dd>
  <dt>convenient_formset:movedUp</dt>
  <dd>Dispatched when a form is moved upwards while reordering forms inside the formset.</dd>
</dl>

All events will contain the `formsetPrefix` parameter value in the event's
`detail` property.

These events can be handled in the following way:

```javascript
document.addEventListener('convenient_formset:added', (event) => {
    if (event.detail.formsetPrefix === 'email-formset') {
        // Handle event for a specific formset on the webpage
    }
});

document.addEventListener('convenient_formset:removed', (event) => {
    // Handle event for any formset on the webpage
});
```

## Internals
**Form deletion** is handled in either of the following ways:
1. If a form includes a `DELETE` field, the field's value is updated and the
   form will be hidden by applying the "hidden" HTML attribute. The deletion
   will then be handled server side.
2. If the form _does not_ include a `DELETE` field, the form is removed from
   the DOM altogether and will not be submitted to the server.

**Form ordering** is handled by moving visible forms above the previous (up)
and below the next (down) for visual feedback, and by swapping the values of
their `ORDER` fields for the server side. This means that the original values
are kept, even when in-between forms are deleted. New forms will see the
initial value for their `ORDER` field set to the last visible form's `ORDER`
field value + 1, as they're added to the bottom of all forms.

## License
The scripts and documentation in this project are released under the
BSD-3-Clause License.

django-convenient-formsets

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README