使用 HTMX 和 Django 实现点击按钮后动态更新

本文旨在指导开发者如何利用 HTMX 库和 Django 框架，实现在点击按钮后动态更新按钮状态的功能。我们将详细介绍前端 HTMX 代码的编写，后端 Django 视图函数的实现，以及如何通过 JSON 响应传递数据，最终实现按钮状态的无刷新更新。本文重点解决 HTMX 替换元素后 JavaScript 无法正确引用元素的问题，并提供完整的解决方案。

前端 HTMX 表单

首先，我们需要创建一个包含按钮的表单，并使用 HTMX 的 hx-post 属性指定表单提交的 URL。hx-swap 属性控制如何更新页面内容。

    {% csrf_token %}
    {% if request.user in account.followers.all %}
    עוקב
    {% else %}
    עקוב
    {% endif %}

在这个例子中，表单提交到 main:follow_toggle 视图，并将整个表单（outerHTML）替换为服务器返回的内容。

后端 Django 视图

接下来，我们需要创建一个 Django 视图来处理表单提交，并返回更新后的按钮状态。重要的是，视图应该返回一个 JSON 响应，包含指示用户是否正在关注的标志。

from django.shortcuts import get_object_or_404
from django.http import JsonResponse
from django.views import generic
from .models import Account  # 假设 Account 模型在当前目录下

class FollowToggleView(generic.View):
    def post(self, request, account_id):
        user_to_toggle = get_object_or_404(Account, id=account_id)
        is_following = user_to_toggle in request.user.following.all()
        if is_following:
            request.user.unfollow(user_to_toggle)
            is_following = False
        else:
            request.user.follow(user_to_toggle)
            is_following = True

        # 构建新的按钮 HTML
        if is_following:
            button_html = 'עוקב'
        else:
            button_html = 'עקוב'

        # 返回包含更新后按钮的表单
        form_html = f'
{request.csrf_token}{button_html}
'

        return JsonResponse({'form': form_html})

在这个视图中，我们首先检查用户是否已经关注了目标账户。然后，我们切换关注状态，并构建包含更新后按钮的完整表单 HTML。最后，我们返回一个 JSON 响应，其中包含表单的 HTML 代码。注意，我们使用 request.path 作为 hx-post 的值，这样表单就会提交到相同的 URL。

AI Room Planner

AI 室内设计工具，免费为您的房间提供上百种设计方案

下载

JavaScript 代码

现在，我们需要编写 JavaScript 代码来处理 HTMX 的 htmx:afterSwap 事件，并在按钮状态更新后，更新按钮的文本和类。

document.addEventListener('htmx:afterSwap', (event) => {
  // 找到表单
  const form = event.target;
  if (form.id === 'follow-form') {
      // 找到按钮
      const followButton = form.querySelector('#follow-button');

      if (followButton) {
          // 根据按钮的 class 决定文本
          if (followButton.classList.contains('btn-secondary')) {
              followButton.innerText = 'עוקב';
          } else {
              followButton.innerText = 'עקוב';
          }
      }
  }
});

这段代码首先监听 htmx:afterSwap 事件。当事件触发时，它会检查事件的目标元素是否是 follow-form 表单。如果是，它会找到表单内的 follow-button 按钮，并根据按钮的类更新按钮的文本。

重要提示：

• 事件委托： 由于 HTMX 可能会替换整个表单，因此直接通过 document.getElementById 获取按钮引用可能会失效。建议使用事件委托，即在 htmx:afterSwap 事件中重新查询按钮元素。
• JSON 响应： 确保 Django 视图返回的是 JSON 响应，并且包含足够的信息来更新按钮状态。
• CSRF 令牌： 在更新后的表单中包含 CSRF 令牌，以防止 CSRF 攻击。
• hx-swap 属性： hx-swap 属性决定了如何更新页面内容。在本例中，我们使用 outerHTML 来替换整个表单。

总结

通过结合 HTMX 的无刷新更新能力和 Django 的后端处理能力，我们可以轻松地实现动态更新按钮状态的功能。关键在于正确处理 HTMX 替换元素后的元素引用问题，并使用 JSON 响应传递数据。 遵循以上步骤，你就可以构建一个响应迅速且用户体验良好的关注/取消关注功能。