Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/trco/django-bootstrap-modal-forms
A Django plugin for creating AJAX driven forms in Bootstrap modal.
https://github.com/trco/django-bootstrap-modal-forms
ajax bootstrap-modal bootstrap3 bootstrap4 bootstrap5 django form jquery modal modal-form modal-forms popup popup-form-with-validation
Last synced: 5 days ago
JSON representation
A Django plugin for creating AJAX driven forms in Bootstrap modal.
- Host: GitHub
- URL: https://github.com/trco/django-bootstrap-modal-forms
- Owner: trco
- License: mit
- Created: 2018-05-27T18:24:54.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-12-06T19:34:14.000Z (about 2 months ago)
- Last Synced: 2025-01-09T16:52:29.333Z (12 days ago)
- Topics: ajax, bootstrap-modal, bootstrap3, bootstrap4, bootstrap5, django, form, jquery, modal, modal-form, modal-forms, popup, popup-form-with-validation
- Language: Python
- Homepage:
- Size: 947 KB
- Stars: 383
- Watchers: 9
- Forks: 142
- Open Issues: 26
-
Metadata Files:
- Readme: README.rst
- License: LICENSE.txt
Awesome Lists containing this project
README
============================
Django Bootstrap Modal Forms
============================
A Django plugin for creating AJAX driven forms in Bootstrap modal.
.. contents:: **Table of Contents**
:depth: 2
:local:
:backlinks: none
Test and experiment on your machine
===================================
This repository includes ``Dockerfile`` and ``docker-compose.yml`` files so you can easily setup and start to experiment with ``django-bootstrap-modal-forms`` running inside of a container on your local machine. Any changes you make in ``bootstrap_modal_forms``, ``examples`` and ``test`` folders are reflected in the container (see docker-compose.yml) and the data stored in sqlite3 database are persistent even if you remove stopped container.
Note that ``master branch`` contains Bootstrap 4 examples, while ``bootstrap5-examples branch`` contains Bootstrap 5 examples. To experiment with Bootstrap 5 examples simply switch the branch.
Follow the steps below to run the app::
$ clone repository
$ cd django-bootstrap-modal-forms
$ docker compose up (use -d flag to run app in detached mode in the background)
$ visit 0.0.0.0:8000
General information
===================
Opening an issue
****************
When reporting an issue for ``django-bootstrap-modal-forms`` package, please prepare a publicly available repository having the issue you are reporting. The clear reproduce is the optimal way towards resolution.
Contribute
**********
This is an Open Source project and any contribution is highly appreciated.
Tests
=====
Run unit and functional tests inside of project folder::
$ python manage.py test
Installation
============
1. Install ``django-bootstrap-modal-forms``::
$ pip install django-bootstrap-modal-forms
2. Add ``bootstrap_modal_forms`` to your INSTALLED_APPS in settings.py::
INSTALLED_APPS = [
...
'bootstrap_modal_forms',
...
]
3. Include Bootstrap, jQuery and ``jquery.bootstrap(5).modal.forms.js`` on every page where you would like to set up the AJAX driven Django forms in Bootstrap modal. **IMPORTANT:** Adjust Bootstrap and jQuery file paths to match yours, but include ``jquery.bootstrap.modal.forms.js`` exactly as in code bellow.
.. code-block:: html+django
How it works?
=============
.. code-block:: html
index.html
// BS4
$(document).ready(function() {
$("#create-book").modalForm({
formURL: "{% url 'create_book' %}"
});
});
// BS5
// instantiate single modal form
document.addEventListener('DOMContentLoaded', (e) => {
modalForm(document.getElementById('create-book'), {
formURL: "{% url 'create_book' %}"
})
});
// BS5
// instantiate multiple modal forms with unique formUrls
document.addEventListener('DOMContentLoaded', (e) => {
var deleteButtons = document.getElementsByClassName("delete-book");
for (var index=0; index < deleteButtons.length; index++) {
modalForm(deleteButtons[index], {
formURL: deleteButtons[index]["dataset"]["formUrl"],
isDeleteForm: true
});
}
});
1. Click event on html element instantiated with ``modalForm`` opens modal
2. Form at ``formURL`` is appended to the modal
3. On submit the form is POSTed via AJAX request to ``formURL``
4. **Unsuccessful POST request** returns errors, which are shown in modal
5. **Successful POST request** submits the form and redirects to ``success_url`` and shows ``success_message``, which are both defined in related Django view
Usage
=====
1. Form
*******
Define BookModelForm and inherit built-in form ``BSModalModelForm``.
.. code-block:: python
forms.py
from .models import Book
from bootstrap_modal_forms.forms import BSModalModelForm
class BookModelForm(BSModalModelForm):
class Meta:
model = Book
fields = ['title', 'author', 'price']
2. Form's html
**************
Define form's html and save it as Django template.
- Form will POST to ``formURL`` defined in #6.
- Add ``class="invalid"`` or custom ``errorClass`` (see paragraph **Options**) to the elements that wrap the fields
- ``class="invalid"`` acts as a flag for the fields having errors after the form has been POSTed.
- **IMPORTANT NOTE:** Bootstrap 4 modal elements are used in this example. ``class="invalid"`` is the default for Bootstrap 4. ``class="is-invalid"`` is the default for Bootstrap 5.
.. code-block:: html
book/create_book.html
{% csrf_token %}
Create new Book
×
{% for field in form %}
{{ field.label }}
{{ field }}
{% for error in field.errors %}
{{ error }}
{% endfor %}
{% endfor %}
3. Function-based view
**********************
Whilst `django-boostrap-modal-forms` is primarily designed for class based usage (see below), there may be reasons you want
to use its capabilities in classic function based views. To use them properly, you need to understand what exactly is going on
and how you can adapt this mechanic into your own view.
Your regular function based view might look like this
.. code-block:: python
...
if request.method == 'POST':
# do stuff
elif request.method == 'GET':
# do other stuff
else:
raise NotImplementedError('No stuff')
...
As you continue to develop your logic, you may see, that two POST requests are being send on your forms, even tho, the user only submitted it once:
- The **first** request can be used to verify your form's validity, let's call it the `ajax request` (you will see why).
- The **second** request can be used to save your form's data (depending on whether the validation was successful or not)
But how do you differentiate between these two requests? Using this handy method: `is_ajax` (https://github.com/trco/django-bootstrap-modal-forms/blob/dddf22e78aead693fedcabe94961fb1ddebc6db7/bootstrap_modal_forms/utils.py#L1)
So, your code may now look like this and is capable of handling both POST requests:
.. code-block:: python
...
if request.method == "POST":
if form.is_valid():
if not is_ajax(request.META):
form.save()
messages.success(
request,
msg_success
)
return HttpResponseRedirect(redirect_url)
...
4. Class-based view
*******************
Define a class-based view BookCreateView and inherit from built-in generic view ``BSModalCreateView``. BookCreateView processes the form defined in #1, uses the template defined in #2 and redirects to ``success_url`` showing ``success_message``.
.. code-block:: python
views.py
from django.urls import reverse_lazy
from .forms import BookModelForm
from .models import Book
from bootstrap_modal_forms.generic import BSModalCreateView
class BookCreateView(BSModalCreateView):
template_name = 'examples/create_book.html'
form_class = BookModelForm
success_message = 'Success: Book was created.'
success_url = reverse_lazy('index')
5. URL for the view
*******************
Define URL for the view in #3.
.. code-block:: python
from django.urls import path
from books import views
urlpatterns = [
path('', views.Index.as_view(), name='index'),
path('create/', views.BookCreateView.as_view(), name='create_book'),
]
6. Bootstrap modal and trigger element
**************************************
Define the Bootstrap modal window and html element triggering modal opening.
- **Single modal** can be used for multiple ``modalForms`` in single template (see #6).
- When using **multiple modals** on the same page each modal should have unique ``id`` and the same value should also be set as ``modalID`` option when instantiating ``modalForm`` on trigger element.
- Trigger element (in this example button with ``id="create-book"``) is used for instantiation of ``modalForm`` in #6.
- Any element can be trigger element as long as ``modalForm`` is bound to it.
- Click event on trigger element loads form's html from #2 within ``
`` and sets action attribute of the form to ``formURL`` set in #6.
.. code-block:: html+django
index.html
Create book
7. modalForm
************
Add script to the template from #5 and bind the ``modalForm`` to the trigger element. Set BookCreateView URL defined in #4 as ``formURL`` property of ``modalForm``.
- If you want to create **more modalForms in single template using the single modal window** from #5, repeat steps #1 to #4, create new trigger element as in #5 and bind the new ``modalForm`` with unique URL to it.
- Default values for ``modalID``, ``modalContent``, ``modalForm`` and ``errorClass`` are used in this example, while ``formURL`` is customized. If you customize any other option adjust the code of the above examples accordingly.
.. code-block:: html
index.html
// BS4
$(document).ready(function() {
$("#create-book").modalForm({
formURL: "{% url 'create_book' %}"
});
});
// BS5
document.addEventListener('DOMContentLoaded', (e) => {
modalForm(document.getElementById('create-book'), {
formURL: "{% url 'create_book' %}"
})
});
Async create/update with or without modal closing on submit
===========================================================
Set ``asyncUpdate`` and ``asyncSettings`` settings to create or update objects without page redirection to ``successUrl`` and define whether a modal should close or stay opened after form submission. See comments in example below and paragraph **modalForm options** for explanation of ``asyncSettings``.
See examples on how to properly reinstantiate modal forms for all CRUD buttons when using async options.
.. code-block:: html
index.html
...
{% for book in books %}
...
...
{% endfor %}
$(function () {
...
# asyncSettings.successMessage
var asyncSuccessMessage = [
"<div ",
"style='position:fixed;top:0;z-index:10000;width:100%;border-radius:0;' ",
"class='alert alert-icon alert-success alert-dismissible fade show mb-0' role='alert'>",
"Success: Book was updated.",
"<button type='button' class='close' data-dismiss='alert' aria-label='Close'>",
"<span aria-hidden='true'>×</span>",
"</button>",
"</div>",
"<script>",
"$('.alert').fadeTo(2000, 500).slideUp(500, function () {$('.alert').slideUp(500).remove();});",
"<\/script>"
].join();
# asyncSettings.addModalFormFunction
function updateBookModalForm() {
$(".update-book").each(function () {
$(this).modalForm({
formURL: $(this).data("form-url"),
asyncUpdate: true,
asyncSettings: {
closeOnSubmit: false,
successMessage: asyncSuccessMessage
dataUrl: "books/",
dataElementId: "#books-table",
dataKey: "table",
addModalFormFunction: updateBookModalForm
}
});
});
}
updateBookModalForm();
...
});
.. code-block:: python
urls.py
from django.urls import path
from . import views
urlpatterns = [
...
# asyncSettings.dataUrl
path('books/', views.books, name='books'),
...
]
.. code-block:: python
views.py
from django.http import JsonResponse
from django.template.loader import render_to_string
from .models import Book
def books(request):
data = dict()
if request.method == 'GET':
books = Book.objects.all()
# asyncSettings.dataKey = 'table'
data['table'] = render_to_string(
'_books_table.html',
{'books': books},
request=request
)
return JsonResponse(data)
modalForm options
=================
modalID
Sets the custom id of the modal. ``Default: "#modal"``
modalContent
Sets the custom class of the element to which the form's html is appended. If you change ``modalContent`` to the custom class, you should also change ``modalForm`` accordingly. To keep Bootstrap's modal style you should than copy Bootstrap's style for ``modal-content`` and set it to your new modalContent class. ``Default: ".modal-content"``
modalForm
Sets the custom form selector. ``Default: ".modal-content form"``
formURL
Sets the url of the form's view and html. ``Default: null``
isDeleteForm
Defines if form is used for deletion. Should be set to ``true`` for deletion forms. ``Default: false``
errorClass
Sets the custom class for the form fields having errors. ``Default: ".invalid" for Boostrap 4 and ".is-invalid" for Bootstrap 5.``
asyncUpdate
Sets asynchronous content update after form submission. ``Default: false``
asyncSettings.closeOnSubmit
Sets whether modal closes or not after form submission. ``Default: false``
asyncSettings.successMessage
Sets successMessage shown after succesful for submission. Should be set to string defining message element. See ``asyncSuccessMessage`` example above. ``Default: null``
asyncSettings.dataUrl
Sets url of the view returning new queryset = all of the objects plus newly created or updated one after asynchronous update. ``Default: null``
asyncSettings.dataElementId
Sets the ``id`` of the element which rerenders asynchronously updated queryset. ``Default: null``
asyncSettings.dataKey
Sets the key containing asynchronously updated queryset in the data dictionary returned from the view providing updated queryset. ``Default: null``
asyncSettings.addModalFormFunction
Sets the method needed for reinstantiation of event listeners on buttons (single or all CRUD buttons) after asynchronous update. ``Default: null``
modalForm default settings object and it's structure
****************************************************
.. code-block:: html
triggerElement.modalForm({
modalID: "#modal",
modalContent: ".modal-content",
modalForm: ".modal-content form",
formURL: null,
isDeleteForm: false,
// ".invalid" is the default for Bootstrap 4. ".is-invalid" is the default for Bootstrap 5.
errorClass: ".invalid",
asyncUpdate: false,
asyncSettings: {
closeOnSubmit: false,
successMessage: null,
dataUrl: null,
dataElementId: null,
dataKey: null,
addModalFormFunction: null
}
});
Forms
=====
Import forms with ``from bootstrap_modal_forms.forms import BSModalForm``.
BSModalForm
Inherits PopRequestMixin and Django's forms.Form.
BSModalModelForm
Inherits PopRequestMixin, CreateUpdateAjaxMixin and Django's forms.ModelForm.
Mixins
======
Import mixins with ``from bootstrap_modal_forms.mixins import PassRequestMixin``.
PassRequestMixin
Form Mixin which puts the request into the form's kwargs. Note: Using this mixin requires you to pop the `request` kwarg out of the dict in the super of your form's `__init__`. See PopRequestMixin.
PopRequestMixin
Form Mixin which pops request out of the kwargs and attaches it to the form's instance. Note: This mixin must precede forms.ModelForm/forms.Form. The form is not expecting these kwargs to be passed in, so they must be popped off before anything else is done.
CreateUpdateAjaxMixin
ModelForm Mixin which passes or saves object based on request type.
DeleteMessageMixin
Generic View Mixin which adds message to BSModalDeleteView and only calls the post method if request is not ajax request. In case request is ajax post method calls delete method, which redirects to success url.
FormValidationMixin
Generic View Mixin which saves object and redirects to success_url if request is not ajax request. Otherwise response 204 No content is returned.
LoginAjaxMixin
Generic View Mixin which authenticates user if request is not ajax request.
Generic views
=============
Import generic views with ``from bootstrap_modal_forms.generic import BSModalFormView``.
BSModalLoginView
Inhertis LoginAjaxMixin and Django's LoginView.
BSModalFormView
Inherits PassRequestMixin and Django's generic.FormView.
BSModalCreateView
Inherits PassRequestMixin, FormValidationMixin and generic.CreateView.
BSModalUpdateView
Inherits PassRequestMixin, FormValidationMixin and generic.UpdateView.
BSModalReadView
Inherits Django's generic.DetailView.
BSModalDeleteView
Inherits DeleteMessageMixin and Django's generic.DeleteView.
Examples
========
To see ``django-bootstrap-modal-forms`` in action clone the repository and run the examples locally::
$ git clone https://github.com/trco/django-bootstrap-modal-forms.git
$ cd django-bootstrap-modal-forms
$ pip install -r requirements.txt
$ python manage.py migrate
$ python manage.py runserver
Example 1: Signup form in Bootstrap modal
*****************************************
For explanation how all the parts of the code work together see paragraph **Usage**. To test the working solution presented here clone and run **Examples**.
.. code-block:: python
forms.py
from django.contrib.auth.forms import UserCreationForm
from django.contrib.auth.models import User
from bootstrap_modal_forms.mixins import PopRequestMixin, CreateUpdateAjaxMixin
class CustomUserCreationForm(PopRequestMixin, CreateUpdateAjaxMixin,
UserCreationForm):
class Meta:
model = User
fields = ['username', 'password1', 'password2']
.. code-block:: html
signup.html
{% load widget_tweaks %}
{% csrf_token %}
Sign up
×
{% for error in form.non_field_errors %}
{{ error }}
{% endfor %}
{% for field in form %}
{{ field.label }}
{% render_field field class="form-control" placeholder=field.label %}
{% for error in field.errors %}
{{ error }}
{% endfor %}
{% endfor %}
.. code-block:: python
views.py
from django.urls import reverse_lazy
from bootstrap_modal_forms.generic import BSModalCreateView
from .forms import CustomUserCreationForm
class SignUpView(BSModalCreateView):
form_class = CustomUserCreationForm
template_name = 'examples/signup.html'
success_message = 'Success: Sign up succeeded. You can now Log in.'
success_url = reverse_lazy('index')
.. code-block:: python
urls.py
from django.urls import path
from . import views
app_name = 'accounts'
urlpatterns = [
path('signup/', views.SignUpView.as_view(), name='signup')
]
.. code-block:: html
.html file containing modal, trigger element and script instantiating modalForm
Sign up
$(function () {
// Sign up button
$("#signup-btn").modalForm({
formURL: "{% url 'signup' %}"
});
});
Example 2: Login form in Bootstrap modal
****************************************
For explanation how all the parts of the code work together see paragraph **Usage**. To test the working solution presented here clone and run **Examples**.
You can set the login redirection by setting the ``LOGIN_REDIRECT_URL`` in ``settings.py``.
You can also set the custom login redirection by:
1. Adding ``success_url`` to the ``extra_context`` of ``CustomLoginView``
2. Setting this ``success_url`` variable as a value of the ``hidden input field`` with ``name="next"`` within the Login form html
.. code-block:: python
forms.py
from django.contrib.auth.forms import AuthenticationForm
from django.contrib.auth.models import User
class CustomAuthenticationForm(AuthenticationForm):
class Meta:
model = User
fields = ['username', 'password']
.. code-block:: html
login.html
{% load widget_tweaks %}
{% csrf_token %}
Log in
×
{% for error in form.non_field_errors %}
{{ error }}
{% endfor %}
{% for field in form %}
{{ field.label }}
{% render_field field class="form-control" placeholder=field.label %}
{% for error in field.errors %}
{{ error }}
{% endfor %}
{% endfor %}
.. code-block:: python
views.py
from django.urls import reverse_lazy
from bootstrap_modal_forms.generic import BSModalLoginView
from .forms import CustomAuthenticationForm
class CustomLoginView(BSModalLoginView):
authentication_form = CustomAuthenticationForm
template_name = 'examples/login.html'
success_message = 'Success: You were successfully logged in.'
extra_context = dict(success_url=reverse_lazy('index'))
.. code-block:: python
urls.py
from django.urls import path
from . import views
app_name = 'accounts'
urlpatterns = [
path('login/', views.CustomLoginView.as_view(), name='login')
]
.. code-block:: html
.html file containing modal, trigger element and script instantiating modalForm
Sign up
$(function () {
// Log in button
$("#login-btn").modalForm({
formURL: "{% url 'login' %}"
});
});
Example 3: Django's forms.ModelForm (CRUD forms) in Bootstrap modal
*******************************************************************
For explanation how all the parts of the code work together see paragraph **Usage**. To test the working solution presented here clone and run **Examples**.
.. code-block:: python
forms.py
from .models import Book
from bootstrap_modal_forms.forms import BSModalModelForm
class BookModelForm(BSModalModelForm):
class Meta:
model = Book
exclude = ['timestamp']
.. code-block:: html
create_book.html
{% load widget_tweaks %}
{% csrf_token %}
Create Book
×
{% for error in form.non_field_errors %}
{{ error }}
{% endfor %}
{% for field in form %}
{{ field.label }}
{% render_field field class="form-control" placeholder=field.label %}
{% for error in field.errors %}
{{ error }}
{% endfor %}
{% endfor %}
.. code-block:: html
update_book.html
{% load widget_tweaks %}
{% csrf_token %}
Update Book
×
{% for error in form.non_field_errors %}
{{ error }}
{% endfor %}
{% for field in form %}
{{ field.label }}
{% render_field field class="form-control" placeholder=field.label %}
{% for error in field.errors %}
{{ error }}
{% endfor %}
{% endfor %}
.. code-block:: html
read_book.html
{% load widget_tweaks %}
Book details
×
Title: {{ book.title }}
Author: {{ book.author }}
Price: {{ book.price }} €
.. code-block:: html
{% load widget_tweaks %}
{% csrf_token %}
Delete Book
×
Are you sure you want to delete book with title
{{ book.title }}?
.. code-block:: python
views.py
from django.urls import reverse_lazy
from django.views import generic
from .forms import BookModelForm
from .models import Book
from bootstrap_modal_forms.generic import (
BSModalCreateView,
BSModalUpdateView,
BSModalReadView,
BSModalDeleteView
)
class Index(generic.ListView):
model = Book
context_object_name = 'books'
template_name = 'index.html'
# Create
class BookCreateView(BSModalCreateView):
template_name = 'examples/create_book.html'
form_class = BookModelForm
success_message = 'Success: Book was created.'
success_url = reverse_lazy('index')
# Update
class BookUpdateView(BSModalUpdateView):
model = Book
template_name = 'examples/update_book.html'
form_class = BookModelForm
success_message = 'Success: Book was updated.'
success_url = reverse_lazy('index')
# Read
class BookReadView(BSModalReadView):
model = Book
template_name = 'examples/read_book.html'
# Delete
class BookDeleteView(BSModalDeleteView):
model = Book
template_name = 'examples/delete_book.html'
success_message = 'Success: Book was deleted.'
success_url = reverse_lazy('index')
.. code-block:: python
urls.py
from django.urls import path
from books import views
urlpatterns = [
path('', views.Index.as_view(), name='index'),
path('create/', views.BookCreateView.as_view(), name='create_book'),
path('update/', views.BookUpdateView.as_view(), name='update_book'),
path('read/', views.BookReadView.as_view(), name='read_book'),
path('delete/', views.BookDeleteView.as_view(), name='delete_book')
]
.. code-block:: html
.html file containing modal, trigger elements and script instantiating modalForms
Create book
{% for book in books %}
{% endfor %}
$(function () {
// Read book buttons
$(".read-book").each(function () {
$(this).modalForm({formURL: $(this).data("form-url")});
});
// Delete book buttons - formURL is retrieved from the data of the element
$(".delete-book").each(function () {
$(this).modalForm({formURL: $(this).data("form-url"), isDeleteForm: true});
});
// Create book button opens form in modal with id="create-modal"
$("#create-book").modalForm({
formURL: "{% url 'create_book' %}",
modalID: "#create-modal"
});
});
- See the difference between button triggering Create action and buttons triggering Read, Update and Delete actions.
- Within the for loop in .html file the ``data-form-url`` attribute of each Update, Read and Delete button should be set to relevant URL with pk argument of the object to be updated, read or deleted.
- These ``data-form-url`` URLs should than be set as ``formURLs`` for ``modalForms`` bound to the buttons.
Example 4: Django's forms.Form in Bootstrap modal
*************************************************
For explanation how all the parts of the code work together see paragraph **Usage**. To test the working solution presented here clone and run **Examples**.
.. code-block:: python
forms.py
from bootstrap_modal_forms.forms import BSModalForm
class BookFilterForm(BSModalForm):
type = forms.ChoiceField(choices=Book.BOOK_TYPES)
class Meta:
fields = ['type']
.. code-block:: html
filter_book.html
{% load widget_tweaks %}
{% csrf_token %}
Filter Books
×
{% for error in form.non_field_errors %}
{{ error }}
{% endfor %}
{% for field in form %}
{{ field.label }}
{% render_field field class="form-control" placeholder=field.label %}
{% for error in field.errors %}
{{ error }}
{% endfor %}
{% endfor %}
.. code-block:: python
views.py
class BookFilterView(BSModalFormView):
template_name = 'examples/filter_book.html'
form_class = BookFilterForm
def form_valid(self, form):
self.filter = '?type=' + form.cleaned_data['type']
response = super().form_valid(form)
return response
def get_success_url(self):
return reverse_lazy('index') + self.filter
.. code-block:: python
urls.py
from django.urls import path
from . import views
app_name = 'accounts'
urlpatterns = [
path('filter/', views.BookFilterView.as_view(), name='filter_book'),
]
.. code-block:: html
index.html
...
Filter books
...
$(function () {
...
$("#filter-book").each(function () {
$(this).modalForm({formURL: $(this).data('form-url')});
});
...
});
License
=======
This project is licensed under the MIT License.