Skip to content

feat: Add loading states and comprehensive modal accessibility #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 23, 2025
Merged

feat: Add loading states and comprehensive modal accessibility #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5b58ee8
feat: Add loading states and comprehensive modal accessibility
Oct 23, 2025
04f77fc
ruff
Mng-dev-ai Oct 23, 2025
7180a70
fix: Resolve StaleElementReferenceException in loading state tests
Oct 23, 2025
e438b62
ruff
Mng-dev-ai Oct 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 68 additions & 0 deletions django_modal_actions/static/django_modal_actions/css/modal_actions.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,3 +246,71 @@
font-size: 0.8rem;
}
}

.dma-spinner {
display: none;
width: 14px;
height: 14px;
margin-left: 8px;
border: 2px solid rgba(255, 255, 255, 0.3);
border-top-color: #fff;
border-radius: 50%;
animation: dma-spin 0.6s linear infinite;
vertical-align: middle;
}

@media (prefers-color-scheme: light) {
.dma-spinner {
border: 2px solid rgba(0, 0, 0, 0.3);
border-top-color: #000;
}
}

@keyframes dma-spin {
0% {
transform: rotate(0deg);
}
100% {
transform: rotate(360deg);
}
}

.dma-button.dma-loading {
opacity: 0.7;
cursor: not-allowed;
pointer-events: none;
}

.dma-button.dma-loading .dma-btn-text {
opacity: 0.8;
}

.dma-button.dma-loading .dma-spinner {
display: inline-block;
}

.dma-button:disabled,
.dma-button[disabled] {
opacity: 0.6;
cursor: not-allowed;
background-color: var(--button-bg);
}

.dma-button:disabled:hover,
.dma-button[disabled]:hover {
transform: none;
box-shadow: none;
background-color: var(--button-bg);
}

.dma-sr-only {
position: absolute;
width: 1px;
height: 1px;
padding: 0;
margin: -1px;
overflow: hidden;
clip: rect(0, 0, 0, 0);
white-space: nowrap;
border-width: 0;
}
156 changes: 132 additions & 24 deletions django_modal_actions/static/django_modal_actions/js/modal_actions.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
(function ($) {
$(document).ready(function () {
var $modal = $(
'<div id="dma-modal-action" class="dma-modal"><div class="dma-modal-content"></div></div>',
'<div id="dma-modal-action" class="dma-modal" role="dialog" aria-modal="true"><div class="dma-modal-content"></div></div>',
).appendTo("body");
var $modalContent = $modal.find(".dma-modal-content");
var lastFocusedElement = null;

// Function to handle conditional fields visibility
function handleConditionalFields() {
Expand Down Expand Up @@ -31,17 +32,17 @@
// For radio buttons and checkboxes
if ($dependentField.is(':radio') || $dependentField.is(':checkbox')) {
var currentValue = $form.find('[name="' + config.dependent_field + '"]:checked').val();
toggleFieldVisibility($fieldContainer, currentValue, config.show_on_values);
_toggleFieldVisibility($fieldContainer, currentValue, config.show_on_values);
}
// For select elements
else if ($dependentField.is('select')) {
var currentValue = $dependentField.val();
toggleFieldVisibility($fieldContainer, currentValue, config.show_on_values);
_toggleFieldVisibility($fieldContainer, currentValue, config.show_on_values);
}
// For other input types
else {
var currentValue = $dependentField.val();
toggleFieldVisibility($fieldContainer, currentValue, config.show_on_values);
_toggleFieldVisibility($fieldContainer, currentValue, config.show_on_values);
}

// Add event listener to the dependent field
Expand All @@ -54,24 +55,76 @@
newValue = $(this).val();
}

toggleFieldVisibility($fieldContainer, newValue, config.show_on_values);
_toggleFieldVisibility($fieldContainer, newValue, config.show_on_values);
});
}
}
});
}

// Helper function to toggle field visibility
function toggleFieldVisibility($field, currentValue, showOnValues) {
if (showOnValues.includes(currentValue)) {
$field.show();
} else {
$field.hide();
function _toggleFieldVisibility($field, currentValue, showOnValues) {
if (showOnValues.includes(currentValue)) {
$field.show();
} else {
$field.hide();
}
}

function _getFocusableElements($container) {
return $container.find(
'button, [href], input, select, textarea, [tabindex]:not([tabindex="-1"])'
).filter(':visible');
}

function _trapFocus() {
var focusableElements = _getFocusableElements($modal);
if (focusableElements.length === 0) {
$modal.off('keydown.focustrap');
return;
}

if (focusableElements.length === 1) {
$modal.off('keydown.focustrap').on('keydown.focustrap', function(e) {
if (e.key === 'Tab' || e.keyCode === 9) {
e.preventDefault();
}
});
return;
}

var firstFocusable = focusableElements.first();
var lastFocusable = focusableElements.last();

$modal.off('keydown.focustrap').on('keydown.focustrap', function(e) {
if (e.key === 'Tab' || e.keyCode === 9) {
if (e.shiftKey) {
if (document.activeElement === firstFocusable[0]) {
e.preventDefault();
lastFocusable.focus();
}
} else {
if (document.activeElement === lastFocusable[0]) {
e.preventDefault();
firstFocusable.focus();
}
}
}
});
}

function _closeModal() {
$modal.hide();
$modal.off('keydown.focustrap');
$(document).off('keydown.dmaModal');
if (lastFocusedElement) {
lastFocusedElement.focus();
lastFocusedElement = null;
}
}

$(document).on("click", ".dma-modal-action-button", function (e) {
e.preventDefault();
lastFocusedElement = this;
var url = $(this).attr("href");
var isListAction = url.includes("list-modal-action");

Expand All @@ -84,18 +137,45 @@
}
$.get(url, function (data) {
if (data.success !== undefined) {
// Skip confirmation case - action was executed directly
if (data.success) {
location.reload();
} else if (data.errors) {
displayErrors(data.errors);
_displayErrors(data.errors);
}
} else if (data.content) {
// Normal case - show modal with confirmation
$modalContent.html(data.content);

var $heading = $modalContent.find("h2");
if ($heading.length) {
var headingId = "dma-modal-heading-" + Date.now();
$heading.attr("id", headingId);
$modal.attr("aria-labelledby", headingId);
} else {
$modal.removeAttr("aria-labelledby");
var modalTitle = $modalContent.find("h1, h2, h3").first().text() || "Dialog";
$modal.attr("aria-label", modalTitle);
}

$modal.show();
// Initialize conditional fields after modal content is loaded
handleConditionalFields();

var $firstFocusable = _getFocusableElements($modal).first();
if ($firstFocusable.length) {
$firstFocusable.focus();
} else {
$modal.find('h2').attr('tabindex', '-1').focus();
}

_trapFocus();

$(document).off('keydown.dmaModal').on('keydown.dmaModal', function(e) {
if (e.key === 'Escape' || e.keyCode === 27) {
if ($modal.is(':visible')) {
e.preventDefault();
_closeModal();
}
}
});
}
});
});
Expand All @@ -105,13 +185,22 @@
"#dma-modal-action .cancel, #dma-modal-action .dma-modal-close",
function (e) {
e.preventDefault();
$modal.hide();
_closeModal();
},
);

function displayErrors(errors) {
function _displayErrors(errors) {
$(".dma-errorlist, .dma-alert-danger").remove();

var errorCount = Object.keys(errors).length;
var $statusMessage = $(".dma-status-message");
if ($statusMessage.length) {
$statusMessage.text("");
setTimeout(function() {
$statusMessage.text("Form submission failed. " + errorCount + " error" + (errorCount > 1 ? "s" : "") + " found. Please review and correct.");
}, 100);
}

$.each(errors, function (field, messages) {
if (field === "__all__") {
var $generalError = $(
Expand All @@ -121,7 +210,7 @@
$("#dma-modal-action form").prepend($generalError);
} else {
var $field = $("#id_" + field);
var $errorList = $('<ul class="dma-errorlist"></ul>');
var $errorList = $('<ul class="dma-errorlist" role="alert"></ul>');
$.each(messages, function (index, message) {
$errorList.append($("<li></li>").text(message));
});
Expand All @@ -135,6 +224,10 @@
);
$("#dma-modal-action form").prepend($generalError);
}

if ($modal.is(':visible')) {
_trapFocus();
}
}

$(document).on("submit", "#dma-modal-action form", function (e) {
Expand All @@ -143,6 +236,10 @@
var url = form.attr("action");
var formData = new FormData(form[0]);

var $confirmBtn = form.closest("#dma-modal-action").find(".dma-confirm-btn");
$confirmBtn.prop("disabled", true).addClass("dma-loading").attr("aria-busy", "true");
$(".dma-status-message").text("Processing your request, please wait...");

var selectedIds = form.find('input[name="selected_ids"]').val();
if (selectedIds) {
formData.append("selected_ids", selectedIds);
Expand All @@ -154,25 +251,36 @@
processData: false,
contentType: false,
dataType: "json",
timeout: 30000,
success: function (data) {
if (data.success) {
$modal.hide();
_closeModal();
location.reload();
} else if (data.errors) {
displayErrors(data.errors);
$confirmBtn.prop("disabled", false).removeClass("dma-loading").attr("aria-busy", "false");
_displayErrors(data.errors);
}
},
error: function (jqXHR, textStatus, errorThrown) {
displayErrors({
__all__: ["An unexpected error occurred. Please try again."],
});
$confirmBtn.prop("disabled", false).removeClass("dma-loading").attr("aria-busy", "false");
if (textStatus === 'timeout') {
_displayErrors({
__all__: ["Request timed out. Please try again."],
});
} else {
_displayErrors({
__all__: ["An unexpected error occurred. Please try again."],
});
}
},
});
});

$(window).on("click", function (e) {
if ($(e.target).is(".dma-modal")) {
$modal.hide();
if (!$(".dma-confirm-btn").hasClass("dma-loading")) {
_closeModal();
}
}
});
});
Expand Down
13 changes: 9 additions & 4 deletions django_modal_actions/templates/admin/django_modal_actions/modal_actions.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<div class="dma-modal-header">
<h2>{{ action_name }}</h2>
<button class="dma-modal-close">&times;</button>
<button class="dma-modal-close" aria-label="Close dialog">&times;</button>
</div>
<div class="dma-modal-body">
<p>{{ description }}</p>
Expand All @@ -19,8 +19,9 @@ <h2>{{ action_name }}</h2>
</div>
<div class="dma-modal-footer">
{% if form %}
<button type="submit" form="dma-modal-form" class="dma-button default">
Confirm
<button type="submit" form="dma-modal-form" class="dma-button default dma-confirm-btn">
<span class="dma-btn-text">Confirm</span>
<span class="dma-spinner"></span>
</button>
<button class="dma-button cancel">Cancel</button>
{% else %}
Expand All @@ -31,8 +32,12 @@ <h2>{{ action_name }}</h2>
{% csrf_token %} {% if selected_ids %}
<input type="hidden" name="selected_ids" value="{{ selected_ids }}" />
{% endif %}
<button type="submit" class="dma-button default">Confirm</button>
<button type="submit" class="dma-button default dma-confirm-btn">
<span class="dma-btn-text">Confirm</span>
<span class="dma-spinner"></span>
</button>
<button class="dma-button cancel">Cancel</button>
</form>
{% endif %}
</div>
<div aria-live="polite" aria-atomic="true" class="dma-sr-only dma-status-message"></div>
Loading