============================
Django Bootstrap Modal Forms
============================
A Django plugin for creating AJAX driven forms in Bootstrap modal.
.. contents:: **Table of Contents**
:depth: 2
:local:
:backlinks: none
Live Demo
=========
Demo_
.. _Demo: http://trco.silkym.com/dbmf/
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.
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. 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
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
<head>
<link rel="stylesheet" href="{% static 'assets/css/bootstrap.css' %}">
</head>
<body>
<script src="{% static 'assets/js/bootstrap.js' %}"></script>
<!-- Bootstrap 4 -->
<script src="{% static 'assets/js/jquery-3.2.1.min.js' %}"></script>
<script src="{% static 'assets/js/popper.min.js' %}"></script>
<script src="{% static 'assets/js/bootstrap.min.js' %}"></script>
<!-- You can alternatively load the minified version -->
<script src="{% static 'js/jquery.bootstrap.modal.forms.js' %}"></script>
<!-- Bootstrap 5 -->
<script src="{% static 'assets/js/bootstrap.bundle.min.js' %}"></script>
<script src="{% static 'js/bootstrap5.modal.forms.js' %}"></script>
<!-- You can alternatively load the minified version -->
<script src="{% static 'js/bootstrap5.modal.forms.min.js' %}"></script>
</body>
How it works?
=============
.. code-block:: html
index.html
<script type="text/javascript">
// 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
});
}
});
</script>
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.
- Bootstrap 4 modal elements are used in this example.
- 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.
.. code-block:: html
book/create_book.html
<form method="post" action="">
{% csrf_token %}
<div class="modal-header">
<h5 class="modal-title">Create new Book</h5>
<button type="button" class="close" data-dismiss="modal" aria-label="Close">
<span aria-hidden="true">×</span>
</button>
</div>
<div class="modal-body">
{% for field in form %}
<div class="form-group{% if field.errors %} invalid{% endif %}">
<label for="{{ field.id_for_label }}">{{ field.label }}</label>
{{ field }}
{% for error in field.errors %}
<p class="help-block">{{ error }}</p>
{% endfor %}
</div>
{% endfor %}
</div>
<div class="modal-footer">
<button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
<button type="submit" class="btn btn-primary">Create</button>
</div>
</form>
3. 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')
4. 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'),
]
5. 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 ``<div class="modal-content"></div>`` and sets action attribute of the form to ``formURL`` set in #6.
.. code-block:: html+django
index.html
<div class="modal fade" tabindex="-1" role="dialog" id="modal">
<div class="modal-dialog" role="document">
<div class="modal-content"></div>
</div>
</div>
<!-- Create book button -->
<button id="create-book" class="btn btn-primary" type="button" name="button">Create book</button>
6. 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
<script type="text/javascript">
// 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' %}"
})
});
</script>
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
<!-- asyncSettings.dataElementId -->
<table id="books-table" class="table">
<thead>
...
</thead>
<tbody>
{% for book in books %}
<tr>
...
<!-- Update book buttons -->
<button type="button" class="update-book btn btn-sm btn-primary" data-form-url="{% url 'update_book' book.pk %}">
<span class="fa fa-pencil"></span>
</button>
...
</td>
</tr>
{% endfor %}
</tbody>
</table>
<script type="text/javascript">
$(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();
...
});
</script>
.. 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"``
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,
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 %}
<form method="post" action="">
{% csrf_token %}
<div class="modal-header">
<h3 class="modal-title">Sign up</h3>
<button type="button" class="close" data-dismiss="modal" aria-label="Close">
<span aria-hidden="true">×</span>
</button>
</div>
<div class="modal-body">
<div class="{% if form.non_field_errors %}invalid{% endif %} mb-2">
{% for error in form.non_field_errors %}
{{ error }}
{% endfor %}
</div>
{% for field in form %}
<div class="form-group">
<label for="{{ field.id_for_label }}">{{ field.label }}</label>
{% render_field field class="form-control" placeholder=field.label %}
<div class="{% if field.errors %} invalid{% endif %}">
{% for error in field.errors %}
<p class="help-block">{{ error }}</p>
{% endfor %}
</div>
</div>
{% endfor %}
</div>
<div class="modal-footer">
<button type="submit" class="btn btn-primary">Sign up</button>
</div>
</form>
.. 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
<div class="modal fade" tabindex="-1" role="dialog" id="modal">
<div class="modal-dialog" role="document">
<div class="modal-content"></div>
</div>
</div>
<button id="signup-btn" class="btn btn-primary" type="button" name="button">Sign up</button>
<script type="text/javascript">
$(function () {
// Sign up button
$("#signup-btn").modalForm({
formURL: "{% url 'signup' %}"
});
});
</script>
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 %}
<form method="post" action="">
{% csrf_token %}
<div class="modal-header">
<h3 class="modal-title">Log in</h3>
<button type="button" class="close" data-dismiss="modal" aria-label="Close">
<span aria-hidden="true">×</span>
</button>
</div>
<div class="modal-body">
<div class="{% if form.non_field_errors %}invalid{% endif %} mb-2">
{% for error in form.non_field_errors %}
{{ error }}
{% endfor %}
</div>
{% for field in form %}
<div class="form-group">
<label for="{{ field.id_for_label }}">{{ field.label }}</label>
{% render_field field class="form-control" placeholder=field.label %}
<div class="{% if field.errors %} invalid{% endif %}">
{% for error in field.errors %}
<p class="help-block">{{ error }}</p>
{% endfor %}
</div>
</div>
{% endfor %}
<!-- Hidden input field for custom redirection after successful login -->
<input type="hidden" name="next" value="{{ success_url }}">
</div>
<div class="modal-footer">
<button type="submit" class="btn btn-primary">Log in</button>
</div>
</form>
.. 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
<div class="modal fade" tabindex="-1" role="dialog" id="modal">
<div class="modal-dialog" role="document">
<div class="modal-content"></div>
</div>
</div>
<button id="login-btn" class="btn btn-primary" type="button" name="button">Sign up</button>
<script type="text/javascript">
$(function () {
// Log in button
$("#login-btn").modalForm({
formURL: "{% url 'login' %}"
});
});
</script>
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 %}
<form method="post" action="">
{% csrf_token %}
<div class="modal-header">
<h3 class="modal-title">Create Book</h3>
<button type="button" class="close" data-dismiss="modal" aria-label="Close">
<span aria-hidden="true">×</span>
</button>
</div>
<div class="modal-body">
<div class="{% if form.non_field_errors %}invalid{% endif %} mb-2">
{% for error in form.non_field_errors %}
{{ error }}
{% endfor %}
</div>
{% for field in form %}
<div class="form-group">
<label for="{{ field.id_for_label }}">{{ field.label }}</label>
{% render_field field class="form-control" placeholder=field.label %}
<div class="{% if field.errors %} invalid{% endif %}">
{% for error in field.errors %}
<p class="help-block">{{ error }}</p>
{% endfor %}
</div>
</div>
{% endfor %}
</div>
<div class="modal-footer">
<button type="submit" class="btn btn-primary">Create</button>
</div>
</form>
.. code-block:: html
update_book.html
{% load widget_tweaks %}
<form method="post" action="">
{% csrf_token %}
<div class="modal-header">
<h3 class="modal-title">Update Book</h3>
<button type="button" class="close" data-dismiss="modal" aria-label="Close">
<span aria-hidden="true">×</span>
</button>
</div>
<div class="modal-body">
<div class="{% if form.non_field_errors %}invalid{% endif %} mb-2">
{% for error in form.non_field_errors %}
{{ error }}
{% endfor %}
</div>
{% for field in form %}
<div class="form-group">
<label for="{{ field.id_for_label }}">{{ field.label }}</label>
{% render_field field class="form-control" placeholder=field.label %}
<div class="{% if field.errors %} invalid{% endif %}">
{% for error in field.errors %}
<p class="help-block">{{ error }}</p>
{% endfor %}
</div>
</div>
{% endfor %}
</div>
<div class="modal-footer">
<button type="submit" class="btn btn-primary">Update</button>
</div>
</form>
.. code-block:: html
read_book.html
{% load widget_tweaks %}
<div class="modal-header">
<h3 class="modal-title">Book details</h3>
<button type="button" class="close" data-dismiss="modal" aria-label="Close">
<span aria-hidden="true">×</span>
</button>
</div>
<div class="modal-body">
<div class="">
Title: {{ book.title }}
</div>
<div class="">
Author: {{ book.author }}
</div>
<div class="">
Price: {{ book.price }} €
</div>
</div>
<div class="modal-footer">
<button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
</div>
.. code-block:: html
{% load widget_tweaks %}
<form method="post" action="">
{% csrf_token %}
<div class="modal-header">
<h3 class="modal-title">Delete Book</h3>
<button type="button" class="close" data-dismiss="modal" aria-label="Close">
<span aria-hidden="true">×</span>
</button>
</div>
<div class="modal-body">
<p>Are you sure you want to delete book with title
<strong>{{ book.title }}</strong>?</p>
</div>
<div class="modal-footer">
<button type="submit" class="btn btn-danger">Delete</button>
</div>
</form>
.. 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/<int:pk>', views.BookUpdateView.as_view(), name='update_book'),
path('read/<int:pk>', views.BookReadView.as_view(), name='read_book'),
path('delete/<int:pk>', views.BookDeleteView.as_view(), name='delete_book')
]
.. code-block:: html
.html file containing modal, trigger elements and script instantiating modalForms
<!-- Modal 1 with id="create-book"-->
<div class="modal fade" id="create-modal" tabindex="-1" role="dialog" aria-hidden="true">
<div class="modal-dialog">
<div class="modal-content">
</div>
</div>
</div>
<!-- Modal 2 with id="modal" -->
<div class="modal fade" tabindex="-1" role="dialog" id="modal">
<div class="modal-dialog" role="document">
<div class="modal-content"></div>
</div>
</div>
<!-- Create book button -->
<button id="create-book" class="btn btn-primary" type="button" name="button">Create book</button>
{% for book in books %}
<div class="text-center">
<!-- Read book buttons -->
<button type="button" class="read-book bs-modal btn btn-sm btn-primary" data-form-url="{% url 'read_book' book.pk %}">
<span class="fa fa-eye"></span>
</button>
<!-- Update book buttons -->
<button type="button" class="update-book bs-modal btn btn-sm btn-primary" data-form-url="{% url 'update_book' book.pk %}">
<span class="fa fa-pencil"></span>
</button>
<!-- Delete book buttons -->
<button type="button" class="delete-book bs-modal btn btn-sm btn-danger" data-form-url="{% url 'delete_book' book.pk %}">
<span class="fa fa-trash"></span>
</button>
</div>
{% endfor %}
<script type="text/javascript">
$(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"
});
});
</script>
- 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 %}
<form method="post" action="">
{% csrf_token %}
<div class="modal-header">
<h3 class="modal-title">Filter Books</h3>
<button type="button" class="close" data-dismiss="modal" aria-label="Close">
<span aria-hidden="true">×</span>
</button>
</div>
<div class="modal-body">
<div class="{% if form.non_field_errors %}invalid{% endif %} mb-2">
{% for error in form.non_field_errors %}
{{ error }}
{% endfor %}
</div>
{% for field in form %}
<div class="form-group">
<label for="{{ field.id_for_label }}">{{ field.label }}</label>
{% render_field field class="form-control" placeholder=field.label %}
<div class="{% if field.errors %} invalid{% endif %}">
{% for error in field.errors %}
<p class="help-block">{{ error }}</p>
{% endfor %}
</div>
</div>
{% endfor %}
</div>
<div class="modal-footer">
<button type="submit" class="btn btn-primary">Filter</button>
</div>
</form>
.. 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
...
<button id="filter-book" class="filter-book btn btn-primary" type="button" name="button" data-form-url="{% url 'filter_book' %}">
<span class="fa fa-filter mr-2"></span>Filter books
</button>
...
<script type="text/javascript">
$(function () {
...
$("#filter-book").each(function () {
$(this).modalForm({formURL: $(this).data('form-url')});
});
...
});
</script>
License
=======
This project is licensed under the MIT License.
Raw data
{
"_id": null,
"home_page": "https://github.com/trco/django-bootstrap-modal-forms",
"name": "django-bootstrap-modal-forms",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Uros Trstenjak",
"author_email": "uros.trstenjak@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/a0/b1/eb596d3c07e5fed3182623df3c1baddc82ae93677f8377e42c328bd85f33/django-bootstrap-modal-forms-3.0.4.tar.gz",
"platform": null,
"description": "============================\nDjango Bootstrap Modal Forms\n============================\n\nA Django plugin for creating AJAX driven forms in Bootstrap modal.\n\n.. contents:: **Table of Contents**\n :depth: 2\n :local:\n :backlinks: none\n\nLive Demo\n=========\n\nDemo_\n\n.. _Demo: http://trco.silkym.com/dbmf/\n\n\nGeneral information\n===================\n\nOpening an issue\n****************\nWhen 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.\n\nContribute\n**********\nThis is an Open Source project and any contribution is highly appreciated.\n\n\nTest and experiment on your machine\n===================================\n\nThis 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. Follow the steps below to run the app::\n\n $ clone repository\n $ cd django-bootstrap-modal-forms\n $ docker compose up (use -d flag to run app in detached mode in the background)\n $ visit 0.0.0.0:8000\n\nTests\n=====\n\nRun unit and functional tests inside of project folder::\n\n $ python manage.py test\n\nInstallation\n============\n\n1. Install ``django-bootstrap-modal-forms``::\n\n $ pip install django-bootstrap-modal-forms\n\n2. Add ``bootstrap_modal_forms`` to your INSTALLED_APPS in settings.py::\n\n INSTALLED_APPS = [\n ...\n 'bootstrap_modal_forms',\n ...\n ]\n\n3. 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.\n\n.. code-block:: html+django\n\n <head>\n <link rel=\"stylesheet\" href=\"{% static 'assets/css/bootstrap.css' %}\">\n </head>\n\n <body>\n <script src=\"{% static 'assets/js/bootstrap.js' %}\"></script>\n\n <!-- Bootstrap 4 -->\n <script src=\"{% static 'assets/js/jquery-3.2.1.min.js' %}\"></script>\n <script src=\"{% static 'assets/js/popper.min.js' %}\"></script>\n <script src=\"{% static 'assets/js/bootstrap.min.js' %}\"></script>\n <!-- You can alternatively load the minified version -->\n <script src=\"{% static 'js/jquery.bootstrap.modal.forms.js' %}\"></script>\n\n <!-- Bootstrap 5 -->\n <script src=\"{% static 'assets/js/bootstrap.bundle.min.js' %}\"></script>\n <script src=\"{% static 'js/bootstrap5.modal.forms.js' %}\"></script>\n <!-- You can alternatively load the minified version -->\n <script src=\"{% static 'js/bootstrap5.modal.forms.min.js' %}\"></script>\n </body>\n\nHow it works?\n=============\n.. code-block:: html\n\n index.html\n\n <script type=\"text/javascript\">\n\n // BS4\n $(document).ready(function() {\n $(\"#create-book\").modalForm({\n formURL: \"{% url 'create_book' %}\"\n });\n });\n\n // BS5\n // instantiate single modal form\n document.addEventListener('DOMContentLoaded', (e) => {\n modalForm(document.getElementById('create-book'), {\n formURL: \"{% url 'create_book' %}\"\n })\n });\n\n // BS5\n // instantiate multiple modal forms with unique formUrls\n document.addEventListener('DOMContentLoaded', (e) => {\n var deleteButtons = document.getElementsByClassName(\"delete-book\");\n for (var index=0; index < deleteButtons.length; index++) {\n modalForm(deleteButtons[index], {\n formURL: deleteButtons[index][\"dataset\"][\"formUrl\"],\n isDeleteForm: true\n });\n }\n });\n\n </script>\n\n1. Click event on html element instantiated with ``modalForm`` opens modal\n2. Form at ``formURL`` is appended to the modal\n3. On submit the form is POSTed via AJAX request to ``formURL``\n4. **Unsuccessful POST request** returns errors, which are shown in modal\n5. **Successful POST request** submits the form and redirects to ``success_url`` and shows ``success_message``, which are both defined in related Django view\n\nUsage\n=====\n\n1. Form\n*******\n\nDefine BookModelForm and inherit built-in form ``BSModalModelForm``.\n\n.. code-block:: python\n\n forms.py\n\n from .models import Book\n from bootstrap_modal_forms.forms import BSModalModelForm\n\n class BookModelForm(BSModalModelForm):\n class Meta:\n model = Book\n fields = ['title', 'author', 'price']\n\n2. Form's html\n**************\n\nDefine form's html and save it as Django template.\n\n- Bootstrap 4 modal elements are used in this example.\n- Form will POST to ``formURL`` defined in #6.\n- Add ``class=\"invalid\"`` or custom ``errorClass`` (see paragraph **Options**) to the elements that wrap the fields.\n- ``class=\"invalid\"`` acts as a flag for the fields having errors after the form has been POSTed.\n\n.. code-block:: html\n\n book/create_book.html\n\n <form method=\"post\" action=\"\">\n {% csrf_token %}\n\n <div class=\"modal-header\">\n <h5 class=\"modal-title\">Create new Book</h5>\n <button type=\"button\" class=\"close\" data-dismiss=\"modal\" aria-label=\"Close\">\n <span aria-hidden=\"true\">×</span>\n </button>\n </div>\n\n <div class=\"modal-body\">\n {% for field in form %}\n <div class=\"form-group{% if field.errors %} invalid{% endif %}\">\n <label for=\"{{ field.id_for_label }}\">{{ field.label }}</label>\n {{ field }}\n {% for error in field.errors %}\n <p class=\"help-block\">{{ error }}</p>\n {% endfor %}\n </div>\n {% endfor %}\n </div>\n\n <div class=\"modal-footer\">\n <button type=\"button\" class=\"btn btn-default\" data-dismiss=\"modal\">Close</button>\n <button type=\"submit\" class=\"btn btn-primary\">Create</button>\n </div>\n\n </form>\n\n3. Class-based view\n*******************\n\nDefine 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``.\n\n.. code-block:: python\n\n views.py\n\n from django.urls import reverse_lazy\n from .forms import BookModelForm\n from .models import Book\n from bootstrap_modal_forms.generic import BSModalCreateView\n\n class BookCreateView(BSModalCreateView):\n template_name = 'examples/create_book.html'\n form_class = BookModelForm\n success_message = 'Success: Book was created.'\n success_url = reverse_lazy('index')\n\n4. URL for the view\n*******************\n\nDefine URL for the view in #3.\n\n.. code-block:: python\n\n from django.urls import path\n from books import views\n\n urlpatterns = [\n path('', views.Index.as_view(), name='index'),\n path('create/', views.BookCreateView.as_view(), name='create_book'),\n ]\n\n5. Bootstrap modal and trigger element\n**************************************\n\nDefine the Bootstrap modal window and html element triggering modal opening.\n\n- **Single modal** can be used for multiple ``modalForms`` in single template (see #6).\n- 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.\n- Trigger element (in this example button with ``id=\"create-book\"``) is used for instantiation of ``modalForm`` in #6.\n- Any element can be trigger element as long as ``modalForm`` is bound to it.\n- Click event on trigger element loads form's html from #2 within ``<div class=\"modal-content\"></div>`` and sets action attribute of the form to ``formURL`` set in #6.\n\n.. code-block:: html+django\n\n index.html\n\n <div class=\"modal fade\" tabindex=\"-1\" role=\"dialog\" id=\"modal\">\n <div class=\"modal-dialog\" role=\"document\">\n <div class=\"modal-content\"></div>\n </div>\n </div>\n\n <!-- Create book button -->\n <button id=\"create-book\" class=\"btn btn-primary\" type=\"button\" name=\"button\">Create book</button>\n\n6. modalForm\n************\n\nAdd 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``.\n\n- 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.\n- 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.\n\n.. code-block:: html\n\n index.html\n\n <script type=\"text/javascript\">\n\n // BS4\n $(document).ready(function() {\n $(\"#create-book\").modalForm({\n formURL: \"{% url 'create_book' %}\"\n });\n });\n\n // BS5\n document.addEventListener('DOMContentLoaded', (e) => {\n modalForm(document.getElementById('create-book'), {\n formURL: \"{% url 'create_book' %}\"\n })\n });\n\n </script>\n\nAsync create/update with or without modal closing on submit\n===========================================================\n\nSet ``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``.\nSee examples on how to properly reinstantiate modal forms for all CRUD buttons when using async options.\n\n.. code-block:: html\n\n index.html\n\n <!-- asyncSettings.dataElementId -->\n <table id=\"books-table\" class=\"table\">\n <thead>\n ...\n </thead>\n <tbody>\n {% for book in books %}\n <tr>\n ...\n <!-- Update book buttons -->\n <button type=\"button\" class=\"update-book btn btn-sm btn-primary\" data-form-url=\"{% url 'update_book' book.pk %}\">\n <span class=\"fa fa-pencil\"></span>\n </button>\n ...\n </td>\n </tr>\n {% endfor %}\n </tbody>\n </table>\n\n <script type=\"text/javascript\">\n $(function () {\n ...\n\n # asyncSettings.successMessage\n var asyncSuccessMessage = [\n \"<div \",\n \"style='position:fixed;top:0;z-index:10000;width:100%;border-radius:0;' \",\n \"class='alert alert-icon alert-success alert-dismissible fade show mb-0' role='alert'>\",\n \"Success: Book was updated.\",\n \"<button type='button' class='close' data-dismiss='alert' aria-label='Close'>\",\n \"<span aria-hidden='true'>×</span>\",\n \"</button>\",\n \"</div>\",\n \"<script>\",\n \"$('.alert').fadeTo(2000, 500).slideUp(500, function () {$('.alert').slideUp(500).remove();});\",\n \"<\\/script>\"\n ].join();\n\n # asyncSettings.addModalFormFunction\n function updateBookModalForm() {\n $(\".update-book\").each(function () {\n $(this).modalForm({\n formURL: $(this).data(\"form-url\"),\n asyncUpdate: true,\n asyncSettings: {\n closeOnSubmit: false,\n successMessage: asyncSuccessMessage\n dataUrl: \"books/\",\n dataElementId: \"#books-table\",\n dataKey: \"table\",\n addModalFormFunction: updateBookModalForm\n }\n });\n });\n }\n updateBookModalForm();\n \n ...\n });\n </script>\n\n.. code-block:: python\n\n urls.py\n\n from django.urls import path\n from . import views\n\n urlpatterns = [\n ...\n # asyncSettings.dataUrl\n path('books/', views.books, name='books'),\n ...\n ]\n\n.. code-block:: python\n\n views.py\n\n from django.http import JsonResponse\n from django.template.loader import render_to_string\n from .models import Book\n\n def books(request):\n data = dict()\n if request.method == 'GET':\n books = Book.objects.all()\n # asyncSettings.dataKey = 'table'\n data['table'] = render_to_string( \n '_books_table.html',\n {'books': books},\n request=request\n )\n return JsonResponse(data)\n\nmodalForm options\n=================\n\nmodalID\n Sets the custom id of the modal. ``Default: \"#modal\"``\n\nmodalContent\n 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\"``\n\nmodalForm\n Sets the custom form selector. ``Default: \".modal-content form\"``\n\nformURL\n Sets the url of the form's view and html. ``Default: null``\n\nisDeleteForm\n Defines if form is used for deletion. Should be set to ``true`` for deletion forms. ``Default: false``\n\nerrorClass\n Sets the custom class for the form fields having errors. ``Default: \".invalid\"``\n\nasyncUpdate\n Sets asynchronous content update after form submission. ``Default: false``\n\nasyncSettings.closeOnSubmit\n Sets whether modal closes or not after form submission. ``Default: false``\n\nasyncSettings.successMessage\n Sets successMessage shown after succesful for submission. Should be set to string defining message element. See ``asyncSuccessMessage`` example above. ``Default: null``\n\nasyncSettings.dataUrl\n Sets url of the view returning new queryset = all of the objects plus newly created or updated one after asynchronous update. ``Default: null``\n\nasyncSettings.dataElementId\n Sets the ``id`` of the element which rerenders asynchronously updated queryset. ``Default: null``\n\nasyncSettings.dataKey\n Sets the key containing asynchronously updated queryset in the data dictionary returned from the view providing updated queryset. ``Default: null``\n\nasyncSettings.addModalFormFunction\n Sets the method needed for reinstantiation of event listeners on buttons (single or all CRUD buttons) after asynchronous update. ``Default: null``\n\nmodalForm default settings object and it's structure\n****************************************************\n\n.. code-block:: html\n \n triggerElement.modalForm({\n modalID: \"#modal\",\n modalContent: \".modal-content\",\n modalForm: \".modal-content form\",\n formURL: null,\n isDeleteForm: false,\n errorClass: \".invalid\",\n asyncUpdate: false,\n asyncSettings: {\n closeOnSubmit: false,\n successMessage: null,\n dataUrl: null,\n dataElementId: null,\n dataKey: null,\n addModalFormFunction: null\n }\n });\n\nForms\n=====\n\nImport forms with ``from bootstrap_modal_forms.forms import BSModalForm``.\n\nBSModalForm\n Inherits PopRequestMixin and Django's forms.Form.\n\nBSModalModelForm\n Inherits PopRequestMixin, CreateUpdateAjaxMixin and Django's forms.ModelForm.\n\nMixins\n======\n\nImport mixins with ``from bootstrap_modal_forms.mixins import PassRequestMixin``.\n\nPassRequestMixin\n 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.\n\nPopRequestMixin\n 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.\n\nCreateUpdateAjaxMixin\n ModelForm Mixin which passes or saves object based on request type.\n\nDeleteMessageMixin\n 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.\n\nFormValidationMixin\n Generic View Mixin which saves object and redirects to success_url if request is not ajax request. Otherwise response 204 No content is returned.\n\nLoginAjaxMixin\n Generic View Mixin which authenticates user if request is not ajax request.\n\nGeneric views\n=============\n\nImport generic views with ``from bootstrap_modal_forms.generic import BSModalFormView``.\n\nBSModalLoginView\n Inhertis LoginAjaxMixin and Django's LoginView.\n\nBSModalFormView\n Inherits PassRequestMixin and Django's generic.FormView.\n\nBSModalCreateView\n Inherits PassRequestMixin, FormValidationMixin and generic.CreateView.\n\nBSModalUpdateView\n Inherits PassRequestMixin, FormValidationMixin and generic.UpdateView.\n\nBSModalReadView\n Inherits Django's generic.DetailView.\n\nBSModalDeleteView\n Inherits DeleteMessageMixin and Django's generic.DeleteView.\n\nExamples\n========\n\nTo see ``django-bootstrap-modal-forms`` in action clone the repository and run the examples locally::\n\n $ git clone https://github.com/trco/django-bootstrap-modal-forms.git\n $ cd django-bootstrap-modal-forms\n $ pip install -r requirements.txt\n $ python manage.py migrate\n $ python manage.py runserver\n\nExample 1: Signup form in Bootstrap modal\n*****************************************\n\nFor explanation how all the parts of the code work together see paragraph **Usage**. To test the working solution presented here clone and run **Examples**.\n\n.. code-block:: python\n\n forms.py\n\n from django.contrib.auth.forms import UserCreationForm\n from django.contrib.auth.models import User\n from bootstrap_modal_forms.mixins import PopRequestMixin, CreateUpdateAjaxMixin\n\n\n class CustomUserCreationForm(PopRequestMixin, CreateUpdateAjaxMixin,\n UserCreationForm):\n class Meta:\n model = User\n fields = ['username', 'password1', 'password2']\n\n.. code-block:: html\n\n signup.html\n\n {% load widget_tweaks %}\n\n <form method=\"post\" action=\"\">\n {% csrf_token %}\n\n <div class=\"modal-header\">\n <h3 class=\"modal-title\">Sign up</h3>\n <button type=\"button\" class=\"close\" data-dismiss=\"modal\" aria-label=\"Close\">\n <span aria-hidden=\"true\">×</span>\n </button>\n </div>\n\n <div class=\"modal-body\">\n\n <div class=\"{% if form.non_field_errors %}invalid{% endif %} mb-2\">\n {% for error in form.non_field_errors %}\n {{ error }}\n {% endfor %}\n </div>\n\n {% for field in form %}\n <div class=\"form-group\">\n <label for=\"{{ field.id_for_label }}\">{{ field.label }}</label>\n {% render_field field class=\"form-control\" placeholder=field.label %}\n <div class=\"{% if field.errors %} invalid{% endif %}\">\n {% for error in field.errors %}\n <p class=\"help-block\">{{ error }}</p>\n {% endfor %}\n </div>\n </div>\n {% endfor %}\n </div>\n\n <div class=\"modal-footer\">\n <button type=\"submit\" class=\"btn btn-primary\">Sign up</button>\n </div>\n\n </form>\n\n.. code-block:: python\n\n views.py\n\n from django.urls import reverse_lazy\n from bootstrap_modal_forms.generic import BSModalCreateView\n from .forms import CustomUserCreationForm\n\n class SignUpView(BSModalCreateView):\n form_class = CustomUserCreationForm\n template_name = 'examples/signup.html'\n success_message = 'Success: Sign up succeeded. You can now Log in.'\n success_url = reverse_lazy('index')\n\n.. code-block:: python\n\n urls.py\n\n from django.urls import path\n from . import views\n\n app_name = 'accounts'\n urlpatterns = [\n path('signup/', views.SignUpView.as_view(), name='signup')\n ]\n\n\n.. code-block:: html\n\n .html file containing modal, trigger element and script instantiating modalForm\n\n <div class=\"modal fade\" tabindex=\"-1\" role=\"dialog\" id=\"modal\">\n <div class=\"modal-dialog\" role=\"document\">\n <div class=\"modal-content\"></div>\n </div>\n </div>\n\n <button id=\"signup-btn\" class=\"btn btn-primary\" type=\"button\" name=\"button\">Sign up</button>\n\n <script type=\"text/javascript\">\n $(function () {\n // Sign up button\n $(\"#signup-btn\").modalForm({\n formURL: \"{% url 'signup' %}\"\n });\n });\n </script>\n\nExample 2: Login form in Bootstrap modal\n****************************************\n\nFor explanation how all the parts of the code work together see paragraph **Usage**. To test the working solution presented here clone and run **Examples**.\n\nYou can set the login redirection by setting the ``LOGIN_REDIRECT_URL`` in ``settings.py``.\n\nYou can also set the custom login redirection by:\n\n1. Adding ``success_url`` to the ``extra_context`` of ``CustomLoginView``\n2. Setting this ``success_url`` variable as a value of the ``hidden input field`` with ``name=\"next\"`` within the Login form html\n\n.. code-block:: python\n\n forms.py\n\n from django.contrib.auth.forms import AuthenticationForm\n from django.contrib.auth.models import User\n\n class CustomAuthenticationForm(AuthenticationForm):\n class Meta:\n model = User\n fields = ['username', 'password']\n\n.. code-block:: html\n\n login.html\n\n {% load widget_tweaks %}\n\n <form method=\"post\" action=\"\">\n {% csrf_token %}\n\n <div class=\"modal-header\">\n <h3 class=\"modal-title\">Log in</h3>\n <button type=\"button\" class=\"close\" data-dismiss=\"modal\" aria-label=\"Close\">\n <span aria-hidden=\"true\">×</span>\n </button>\n </div>\n\n <div class=\"modal-body\">\n\n <div class=\"{% if form.non_field_errors %}invalid{% endif %} mb-2\">\n {% for error in form.non_field_errors %}\n {{ error }}\n {% endfor %}\n </div>\n\n {% for field in form %}\n <div class=\"form-group\">\n <label for=\"{{ field.id_for_label }}\">{{ field.label }}</label>\n {% render_field field class=\"form-control\" placeholder=field.label %}\n <div class=\"{% if field.errors %} invalid{% endif %}\">\n {% for error in field.errors %}\n <p class=\"help-block\">{{ error }}</p>\n {% endfor %}\n </div>\n </div>\n {% endfor %}\n\n <!-- Hidden input field for custom redirection after successful login -->\n <input type=\"hidden\" name=\"next\" value=\"{{ success_url }}\">\n </div>\n\n <div class=\"modal-footer\">\n <button type=\"submit\" class=\"btn btn-primary\">Log in</button>\n </div>\n\n </form>\n\n.. code-block:: python\n\n views.py\n\n from django.urls import reverse_lazy\n from bootstrap_modal_forms.generic import BSModalLoginView\n from .forms import CustomAuthenticationForm\n\n class CustomLoginView(BSModalLoginView):\n authentication_form = CustomAuthenticationForm\n template_name = 'examples/login.html'\n success_message = 'Success: You were successfully logged in.'\n extra_context = dict(success_url=reverse_lazy('index'))\n\n.. code-block:: python\n\n urls.py\n\n from django.urls import path\n from . import views\n\n app_name = 'accounts'\n urlpatterns = [\n path('login/', views.CustomLoginView.as_view(), name='login')\n ]\n\n.. code-block:: html\n\n .html file containing modal, trigger element and script instantiating modalForm\n\n <div class=\"modal fade\" tabindex=\"-1\" role=\"dialog\" id=\"modal\">\n <div class=\"modal-dialog\" role=\"document\">\n <div class=\"modal-content\"></div>\n </div>\n </div>\n\n <button id=\"login-btn\" class=\"btn btn-primary\" type=\"button\" name=\"button\">Sign up</button>\n\n <script type=\"text/javascript\">\n $(function () {\n // Log in button\n $(\"#login-btn\").modalForm({\n formURL: \"{% url 'login' %}\"\n });\n });\n </script>\n\nExample 3: Django's forms.ModelForm (CRUD forms) in Bootstrap modal\n*******************************************************************\n\nFor explanation how all the parts of the code work together see paragraph **Usage**. To test the working solution presented here clone and run **Examples**.\n\n.. code-block:: python\n\n forms.py\n\n from .models import Book\n from bootstrap_modal_forms.forms import BSModalModelForm\n\n\n class BookModelForm(BSModalModelForm):\n class Meta:\n model = Book\n exclude = ['timestamp']\n\n.. code-block:: html\n\n create_book.html\n\n {% load widget_tweaks %}\n\n <form method=\"post\" action=\"\">\n {% csrf_token %}\n\n <div class=\"modal-header\">\n <h3 class=\"modal-title\">Create Book</h3>\n <button type=\"button\" class=\"close\" data-dismiss=\"modal\" aria-label=\"Close\">\n <span aria-hidden=\"true\">×</span>\n </button>\n </div>\n\n <div class=\"modal-body\">\n\n <div class=\"{% if form.non_field_errors %}invalid{% endif %} mb-2\">\n {% for error in form.non_field_errors %}\n {{ error }}\n {% endfor %}\n </div>\n\n {% for field in form %}\n <div class=\"form-group\">\n <label for=\"{{ field.id_for_label }}\">{{ field.label }}</label>\n {% render_field field class=\"form-control\" placeholder=field.label %}\n <div class=\"{% if field.errors %} invalid{% endif %}\">\n {% for error in field.errors %}\n <p class=\"help-block\">{{ error }}</p>\n {% endfor %}\n </div>\n </div>\n {% endfor %}\n </div>\n\n <div class=\"modal-footer\">\n <button type=\"submit\" class=\"btn btn-primary\">Create</button>\n </div>\n\n </form>\n\n.. code-block:: html\n\n update_book.html\n\n {% load widget_tweaks %}\n\n <form method=\"post\" action=\"\">\n {% csrf_token %}\n\n <div class=\"modal-header\">\n <h3 class=\"modal-title\">Update Book</h3>\n <button type=\"button\" class=\"close\" data-dismiss=\"modal\" aria-label=\"Close\">\n <span aria-hidden=\"true\">×</span>\n </button>\n </div>\n\n <div class=\"modal-body\">\n <div class=\"{% if form.non_field_errors %}invalid{% endif %} mb-2\">\n {% for error in form.non_field_errors %}\n {{ error }}\n {% endfor %}\n </div>\n\n {% for field in form %}\n <div class=\"form-group\">\n <label for=\"{{ field.id_for_label }}\">{{ field.label }}</label>\n {% render_field field class=\"form-control\" placeholder=field.label %}\n <div class=\"{% if field.errors %} invalid{% endif %}\">\n {% for error in field.errors %}\n <p class=\"help-block\">{{ error }}</p>\n {% endfor %}\n </div>\n </div>\n {% endfor %}\n </div>\n\n <div class=\"modal-footer\">\n <button type=\"submit\" class=\"btn btn-primary\">Update</button>\n </div>\n\n </form>\n\n.. code-block:: html\n\n read_book.html\n\n {% load widget_tweaks %}\n\n <div class=\"modal-header\">\n <h3 class=\"modal-title\">Book details</h3>\n <button type=\"button\" class=\"close\" data-dismiss=\"modal\" aria-label=\"Close\">\n <span aria-hidden=\"true\">×</span>\n </button>\n </div>\n\n <div class=\"modal-body\">\n <div class=\"\">\n Title: {{ book.title }}\n </div>\n <div class=\"\">\n Author: {{ book.author }}\n </div>\n <div class=\"\">\n Price: {{ book.price }} \u20ac\n </div>\n </div>\n\n <div class=\"modal-footer\">\n <button type=\"button\" class=\"btn btn-default\" data-dismiss=\"modal\">Close</button>\n </div>\n\n.. code-block:: html\n\n {% load widget_tweaks %}\n\n <form method=\"post\" action=\"\">\n {% csrf_token %}\n\n <div class=\"modal-header\">\n <h3 class=\"modal-title\">Delete Book</h3>\n <button type=\"button\" class=\"close\" data-dismiss=\"modal\" aria-label=\"Close\">\n <span aria-hidden=\"true\">×</span>\n </button>\n </div>\n\n <div class=\"modal-body\">\n <p>Are you sure you want to delete book with title\n <strong>{{ book.title }}</strong>?</p>\n </div>\n\n <div class=\"modal-footer\">\n <button type=\"submit\" class=\"btn btn-danger\">Delete</button>\n </div>\n\n </form>\n\n.. code-block:: python\n\n views.py\n\n from django.urls import reverse_lazy\n from django.views import generic\n from .forms import BookModelForm\n from .models import Book\n from bootstrap_modal_forms.generic import (\n BSModalCreateView,\n BSModalUpdateView,\n BSModalReadView,\n BSModalDeleteView\n )\n\n class Index(generic.ListView):\n model = Book\n context_object_name = 'books'\n template_name = 'index.html'\n\n # Create\n class BookCreateView(BSModalCreateView):\n template_name = 'examples/create_book.html'\n form_class = BookModelForm\n success_message = 'Success: Book was created.'\n success_url = reverse_lazy('index')\n\n # Update\n class BookUpdateView(BSModalUpdateView):\n model = Book\n template_name = 'examples/update_book.html'\n form_class = BookModelForm\n success_message = 'Success: Book was updated.'\n success_url = reverse_lazy('index')\n\n # Read\n class BookReadView(BSModalReadView):\n model = Book\n template_name = 'examples/read_book.html'\n\n # Delete\n class BookDeleteView(BSModalDeleteView):\n model = Book\n template_name = 'examples/delete_book.html'\n success_message = 'Success: Book was deleted.'\n success_url = reverse_lazy('index')\n\n.. code-block:: python\n\n urls.py\n\n from django.urls import path\n from books import views\n\n urlpatterns = [\n path('', views.Index.as_view(), name='index'),\n path('create/', views.BookCreateView.as_view(), name='create_book'),\n path('update/<int:pk>', views.BookUpdateView.as_view(), name='update_book'),\n path('read/<int:pk>', views.BookReadView.as_view(), name='read_book'),\n path('delete/<int:pk>', views.BookDeleteView.as_view(), name='delete_book')\n ]\n\n.. code-block:: html\n\n .html file containing modal, trigger elements and script instantiating modalForms\n\n <!-- Modal 1 with id=\"create-book\"-->\n <div class=\"modal fade\" id=\"create-modal\" tabindex=\"-1\" role=\"dialog\" aria-hidden=\"true\">\n <div class=\"modal-dialog\">\n <div class=\"modal-content\">\n </div>\n </div>\n </div>\n\n <!-- Modal 2 with id=\"modal\" -->\n <div class=\"modal fade\" tabindex=\"-1\" role=\"dialog\" id=\"modal\">\n <div class=\"modal-dialog\" role=\"document\">\n <div class=\"modal-content\"></div>\n </div>\n </div>\n\n <!-- Create book button -->\n <button id=\"create-book\" class=\"btn btn-primary\" type=\"button\" name=\"button\">Create book</button>\n\n {% for book in books %}\n <div class=\"text-center\">\n <!-- Read book buttons -->\n <button type=\"button\" class=\"read-book bs-modal btn btn-sm btn-primary\" data-form-url=\"{% url 'read_book' book.pk %}\">\n <span class=\"fa fa-eye\"></span>\n </button>\n <!-- Update book buttons -->\n <button type=\"button\" class=\"update-book bs-modal btn btn-sm btn-primary\" data-form-url=\"{% url 'update_book' book.pk %}\">\n <span class=\"fa fa-pencil\"></span>\n </button>\n <!-- Delete book buttons -->\n <button type=\"button\" class=\"delete-book bs-modal btn btn-sm btn-danger\" data-form-url=\"{% url 'delete_book' book.pk %}\">\n <span class=\"fa fa-trash\"></span>\n </button>\n </div>\n {% endfor %}\n\n <script type=\"text/javascript\">\n $(function () {\n\n // Read book buttons\n $(\".read-book\").each(function () {\n $(this).modalForm({formURL: $(this).data(\"form-url\")});\n });\n\n // Delete book buttons - formURL is retrieved from the data of the element\n $(\".delete-book\").each(function () {\n $(this).modalForm({formURL: $(this).data(\"form-url\"), isDeleteForm: true});\n });\n\n // Create book button opens form in modal with id=\"create-modal\"\n $(\"#create-book\").modalForm({\n formURL: \"{% url 'create_book' %}\",\n modalID: \"#create-modal\"\n });\n\n });\n </script>\n\n- See the difference between button triggering Create action and buttons triggering Read, Update and Delete actions.\n- 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.\n- These ``data-form-url`` URLs should than be set as ``formURLs`` for ``modalForms`` bound to the buttons.\n\nExample 4: Django's forms.Form in Bootstrap modal\n*************************************************\n\nFor explanation how all the parts of the code work together see paragraph **Usage**. To test the working solution presented here clone and run **Examples**.\n\n.. code-block:: python\n\n forms.py\n\n from bootstrap_modal_forms.forms import BSModalForm\n\n class BookFilterForm(BSModalForm):\n type = forms.ChoiceField(choices=Book.BOOK_TYPES)\n\n class Meta:\n fields = ['type']\n\n.. code-block:: html\n\n filter_book.html\n\n {% load widget_tweaks %}\n\n <form method=\"post\" action=\"\">\n {% csrf_token %}\n\n <div class=\"modal-header\">\n <h3 class=\"modal-title\">Filter Books</h3>\n <button type=\"button\" class=\"close\" data-dismiss=\"modal\" aria-label=\"Close\">\n <span aria-hidden=\"true\">×</span>\n </button>\n </div>\n\n <div class=\"modal-body\">\n <div class=\"{% if form.non_field_errors %}invalid{% endif %} mb-2\">\n {% for error in form.non_field_errors %}\n {{ error }}\n {% endfor %}\n </div>\n\n {% for field in form %}\n <div class=\"form-group\">\n <label for=\"{{ field.id_for_label }}\">{{ field.label }}</label>\n {% render_field field class=\"form-control\" placeholder=field.label %}\n <div class=\"{% if field.errors %} invalid{% endif %}\">\n {% for error in field.errors %}\n <p class=\"help-block\">{{ error }}</p>\n {% endfor %}\n </div>\n </div>\n {% endfor %}\n </div>\n\n <div class=\"modal-footer\">\n <button type=\"submit\" class=\"btn btn-primary\">Filter</button>\n </div>\n\n </form>\n\n.. code-block:: python\n\n views.py\n\n class BookFilterView(BSModalFormView):\n template_name = 'examples/filter_book.html'\n form_class = BookFilterForm\n\n def form_valid(self, form):\n self.filter = '?type=' + form.cleaned_data['type']\n response = super().form_valid(form)\n return response\n\n def get_success_url(self):\n return reverse_lazy('index') + self.filter\n\n.. code-block:: python\n\n urls.py\n\n from django.urls import path\n from . import views\n\n app_name = 'accounts'\n urlpatterns = [\n path('filter/', views.BookFilterView.as_view(), name='filter_book'),\n ]\n\n.. code-block:: html\n\n index.html\n \n ...\n <button id=\"filter-book\" class=\"filter-book btn btn-primary\" type=\"button\" name=\"button\" data-form-url=\"{% url 'filter_book' %}\">\n <span class=\"fa fa-filter mr-2\"></span>Filter books\n </button>\n ...\n\n <script type=\"text/javascript\">\n $(function () {\n ...\n $(\"#filter-book\").each(function () {\n $(this).modalForm({formURL: $(this).data('form-url')});\n });\n ...\n });\n </script>\n\nLicense\n=======\n\nThis project is licensed under the MIT License.\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "A Django plugin for creating AJAX driven forms in Bootstrap modal.",
"version": "3.0.4",
"project_urls": {
"Homepage": "https://github.com/trco/django-bootstrap-modal-forms"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "78644614a856f2f2330c41010a4d221bc141ec08574744142b429e01e878e05e",
"md5": "b68b04c00978ff09aea951fbfb817cd9",
"sha256": "47a4f303724182a5e4958da94772f5a6a7359fac6d6ae204442aadfd56c03133"
},
"downloads": -1,
"filename": "django_bootstrap_modal_forms-3.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b68b04c00978ff09aea951fbfb817cd9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 28837,
"upload_time": "2023-06-18T13:54:13",
"upload_time_iso_8601": "2023-06-18T13:54:13.839329Z",
"url": "https://files.pythonhosted.org/packages/78/64/4614a856f2f2330c41010a4d221bc141ec08574744142b429e01e878e05e/django_bootstrap_modal_forms-3.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a0b1eb596d3c07e5fed3182623df3c1baddc82ae93677f8377e42c328bd85f33",
"md5": "1ebdb5ba2eb23b189d9edb42db6c71ed",
"sha256": "ff33b9b89608c8bcb9eba811524e9fb7ec1c843a73bd78a7d38fbb94cc9bdd4a"
},
"downloads": -1,
"filename": "django-bootstrap-modal-forms-3.0.4.tar.gz",
"has_sig": false,
"md5_digest": "1ebdb5ba2eb23b189d9edb42db6c71ed",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 37109,
"upload_time": "2023-06-18T13:54:16",
"upload_time_iso_8601": "2023-06-18T13:54:16.242620Z",
"url": "https://files.pythonhosted.org/packages/a0/b1/eb596d3c07e5fed3182623df3c1baddc82ae93677f8377e42c328bd85f33/django-bootstrap-modal-forms-3.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-18 13:54:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "trco",
"github_project": "django-bootstrap-modal-forms",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Django",
"specs": [
[
"==",
"4.2.1"
]
]
},
{
"name": "django-widget-tweaks",
"specs": [
[
"==",
"1.4.12"
]
]
},
{
"name": "selenium",
"specs": [
[
"==",
"3.14"
]
]
}
],
"lcname": "django-bootstrap-modal-forms"
}
JSON
