使用 JavaScript 在 Thymeleaf 应用中动态控制 Bootstrap 模态框触发

使用 JavaScript 在 Thymeleaf 应用中动态控制 Bootstrap 模态框触发

本文详细介绍了如何在 spring Boot Thymeleaf 应用中,根据下拉选择器的值动态控制 bootstrap 模态框的显示行为。通过在客户端使用 JavaScript 监听下拉选择器的 change 事件,并根据其选中值动态添加或移除触发模态框所需的 data-toggle 和 data-target 属性,从而实现条件性地阻止或允许模态框弹出。文章提供了详细的代码示例和实现步骤,并讨论了相关注意事项。

1. 问题背景与需求分析

在基于 thymeleaf 和 spring boot 构建的 web 应用中,我们经常会遇到需要根据用户在表单中的选择,动态调整页面行为的需求。一个常见的场景是:当用户点击一个按钮时,通常会弹出一个 bootstrap 模态框。然而,如果表单中的某个下拉选择器(

例如,在提供的场景中,存在一个名为 classOverridden 的下拉选择器。如果用户选择了除默认空值以外的任何选项,则点击提交按钮时,ID 为 #managerselectForCooridnator 的模态框不应被触发。

2. 解决方案概述

要实现这一功能,最直接且有效的方法是利用客户端 JavaScript。Bootstrap 模态框的触发机制依赖于 html 元素上的 data-toggle=”modal” 和 data-target=”#modalId” 属性。因此,我们可以通过 JavaScript 动态地添加或移除这些属性,从而控制模态框的触发。

具体步骤如下:

  1. 为下拉选择器和触发模态框的按钮添加唯一的 id 属性,以便于 JavaScript 访问。
  2. 编写 JavaScript 代码,监听下拉选择器的 change 事件。
  3. 在事件处理函数中,根据下拉选择器的当前值,动态地移除或添加按钮上的 data-toggle 和 data-target 属性。
  4. 考虑页面加载时的初始状态,确保即使页面加载时下拉选择器已非默认值,模态框也能被正确抑制。

3. 实现步骤与代码示例

3.1 准备 Thymeleaf 模板

首先,我们需要修改 Thymeleaf 模板,为相关的 HTML 元素添加 id 属性。

立即学习Java免费学习笔记(深入)”;

<div class="container-fluid">     <div class="row">         <!-- 导航栏和其他内容 -->         <div class="col">             <form th:object="${answeredQuestionnaire}" method="post">                 <!-- 其他表单内容 -->                  <div th:each="role: ${loggedInUser.applicationUserRoles}">                     <div class="form-row">                         <div class="form-row">                             <div class="form-group col-4 text-left pt-2">                                 <label class="form-group font-weight-bold"> [[#{review.differentBCMClass}]] :</label>                             </div>                             <div class="form-group col-2 text-left pt-2">                                 <!-- 为 select 元素添加 id -->                                 <select th:field="*{classOverridden}" id="classOverriddenSelect" name="classOverridden">                                     <option value="" default>[[#{pleaseSelect}]]</option>                                     <option class="text-center" th:value="1">1</option>                                     <option class="text-center" th:value="2">2</option>                                     <option class="text-center" th:value="3">3</option>                                     <option class="text-center" th:value="4">4</option>                                     <option class="text-center" th:value="0">0</option>                                 </select>                             </div>                         </div>                         <div class="form-group col-6 ">                             <label class="font-weight-bold "> [[#{review.commentForDifferentClass}]] : </label>                             <textarea rows="5"                                       th:placeholder="#{comment}"                                       th:field="*{classOverriddenComment}"                                       th:value="${answeredQuestionnaire.classOverriddenComment}"                                       th:text="${answeredQuestionnaire.classOverriddenComment}"                                       class="form-control"></textarea>                         </div>                     </div>                      <br>                     <div class="form-group form-row text-center"                          th:if="${role.roleName != 'Manager' and role.roleName != 'officer' }">                         <div class="form-group col text-center pt-2">                             <!-- 为触发模态框的按钮添加 id -->                             <button type="button"                                     id="submitButton"                                     class="btn btn-info btn-block " role="button" data-toggle="modal" data-target="#managerSelectForCooridnator">                                 [[#{review.submit}]]                             </button>                         </div>                     </div>                      <!-- 另一个提交按钮,不涉及模态框控制,此处省略 -->                     <!-- <div class="form-group form-row text-center">...</div> -->                  </div>             </form>         </div>     </div> </div>

关键改动:

  • 触发模态框的

3.2 编写 JavaScript 逻辑

接下来,在页面的 <script> 标签内(推荐在 <body> 标签的末尾或使用 defer 属性),添加 JavaScript 代码来处理逻辑。</script>

<script>     document.addEventListener('domContentLoaded', function() {         // 获取下拉选择器和按钮的引用         const submitButton = document.getElementById('submitButton');         const select = document.getElementById('classOverriddenSelect');          // 定义一个函数来更新按钮的模态框行为         function updateButtonModalBehavior() {             // 如果下拉选择器有值(非默认的空字符串)             if (select.value !== '') {                 // 移除 data-toggle 和 data-target 属性,阻止模态框弹出                 submitButton.removeAttribute('data-toggle');                 submitButton.removeAttribute('data-target');             } else {                 // 如果下拉选择器是默认空值,则添加回属性,允许模态框弹出                 submitButton.setAttribute('data-toggle', 'modal');                 submitButton.setAttribute('data-target', '#managerSelectForCooridnator');             }         }          // 页面加载完成后,立即执行一次检查,处理初始状态         updateButtonModalBehavior();          // 监听下拉选择器的 'change' 事件         select.addEventListener('change', updateButtonModalBehavior);     }); </script>

代码解释:

  1. document.addEventListener(‘DOMContentLoaded’, …): 确保在 DOM 完全加载后执行 JavaScript 代码,避免因元素未加载而导致的错误。
  2. const submitButton = document.getElementById(‘submitButton’);const select = document.getElementById(‘classOverriddenSelect’);: 通过之前添加的 id 属性获取到对应的 HTML 元素。
  3. function updateButtonModalBehavior() { … }: 这是一个封装了核心逻辑的函数,方便在不同时机调用。
  4. if (select.value !== ”) { … }: 判断下拉选择器的当前值是否为空字符串(即是否选择了除“请选择”以外的任何选项)。
  5. submitButton.removeAttribute(‘data-toggle’);submitButton.removeAttribute(‘data-target’);: 当 select.value 不为空时,移除这两个属性。Bootstrap 模态框依赖这两个属性来识别并触发模态框,移除它们就相当于切断了触发机制。
  6. submitButton.setAttribute(‘data-toggle’, ‘modal’);submitButton.setAttribute(‘data-target’, ‘#managerSelectForCooridnator’);: 当 select.value 为空时,重新添加这两个属性,使按钮恢复触发模态框的功能。
  7. updateButtonModalBehavior();: 在 DOMContentLoaded 事件中立即调用一次此函数。这是为了处理页面加载时,如果 classOverridden 字段已经有非默认值(例如,从后端预填充或用户返回页面),按钮的模态框行为也能立即得到正确设置。
  8. select.addEventListener(‘change’, updateButtonModalBehavior);: 为下拉选择器添加 change 事件监听器。每当用户改变下拉选择器的选项时,updateButtonModalBehavior 函数就会被调用,从而动态调整按钮的行为。

4. 注意事项与最佳实践

  • JavaScript 放置位置: 推荐将 <script> 标签放置在 <body> 标签的闭合标签 </script>

© 版权声明
THE END
喜欢就支持一下吧
点赞11 分享