Django：在模板中呈现表单字段时添加 CSS 类

Question

我正在像{{ form.first_name }} 这样的模板中输出表单的字段，我想向它添加一个类（例如蓝图的 span-x-类）。所以我想知道是否有一个很好的现成解决方案（模板过滤器），我可以在时尚{{ form.first_name|add_class:"span-4" }} 中使用它？ （我只是想知道 Django 的开发人员或其他人是否在我自己不知情的情况下想到了这一点）

Answer 1

为 python3 更新

更新很简单，只需要在 print 上加上括号并将 unicode(value) 更改为 str(value)，我还快速将 'class="%s">' 更改为 fstring。

import re
from django.utils.safestring import mark_safe
from django import template
register = template.Library()

class_re = re.compile(r'(?<=class=["\'])(.*)(?=["\'])')
@register.filter
def add_class(value, css_class):
    string = str(value)
    match = class_re.search(string)
    if match:
        m = re.search(r'^%s$|^%s\s|\s%s\s|\s%s$' % (css_class, css_class, 
                                                    css_class, css_class), 
                                                    match.group(1))
        print (match.group(1))
        if not m:
            return mark_safe(class_re.sub(match.group(1) + " " + css_class, 
                                          string))
    else:
        return mark_safe(string.replace('>', f' class="{css_class}">'))
    return value

Answer 2

另一种方法是在字段上使用as_widget 方法来更改它——比正则表达式方法更简单、更安全，并且不需要任何额外的依赖项。

定义一个custom template filter：

@register.filter
def add_class(field, class_name):
    return field.as_widget(attrs={
        "class": " ".join((field.css_classes(), class_name))
    })

在你的模板中：

{{ form.first_name|add_class:"span-4" }}

也可以使用as_widget添加其他属性，如placeholder等

Answer 3

关于 lazerscience 解决方案的另一个注意事项：如果将其应用于没有类属性的 元素，则 else 情况下的字符串替换将产生如下内容：

<select name="state" id="id_state" class="class1 class2">
    <option value="AL" class="class1 class2">Alabama</option class="class1 class2">
    <option value="AK" class="class1 class2">Alaska</option class="class1 class2">
    <option value="AZ" class="class1 class2">Arizona</option class="class1 class2">
</select class="class1 class2">

我很确定浏览器会废弃那些无关的类定义，但是当您只需要一个时，这就是大量的字符串替换。一个简单的补救措施：

return mark_safe(string.replace('>', ' class="%s">' % css_class, 1))

最后一个参数 (1) 将确保只有“>”的第一个实例将替换为“class="...">，这在逻辑上对于任何表单元素都是正确的。

Answer 4

我还在学习 Django，但你不能这样做吗 -

from django import forms

class SomeForm(forms.Form):
    f = forms.CharField(label='x',widget=forms.TextInput(attrs={'class':'name'}))

我想没有必要在模板级别执行此操作（或使用过滤器），除非您有一些我不理解的要求。

Answer 5

关于如何使用 Lazerscience 非常方便的解决方案的一些额外说明。以下是文件在依赖项导入时的外观：

import re
from django.utils.safestring import mark_safe
from django import template
register = template.Library()

class_re = re.compile(r'(?<=class=["\'])(.*)(?=["\'])')
@register.filter
def add_class(value, css_class):
    string = unicode(value)
    match = class_re.search(string)
    if match:
        m = re.search(r'^%s$|^%s\s|\s%s\s|\s%s$' % (css_class, css_class, 
                                                    css_class, css_class), 
                                                    match.group(1))
        print match.group(1)
        if not m:
            return mark_safe(class_re.sub(match.group(1) + " " + css_class, 
                                          string))
    else:
        return mark_safe(string.replace('>', ' class="%s">' % css_class))
    return value

我将它粘贴到一个名为 add_class.py 的文件中。目录结构为： mydjangoproject > general_tools_app > templatetags > add_class.py

general_tools_app 是一个应用程序，它收集了我添加到新 django 项目中的有用功能。

（general_tools_app 和 templatetags 目录都有一个空的__init__.py 文件，以便正确注册）

在 settings.py 中，我的 INSTALLED_APPS 元组包含条目“mydjangoproject.general_tools_app”。

要在模板中使用过滤器，我在文件顶部添加了{% load add_class %} 行。如果我想将“删除”类添加到字段中，我会这样做

{{ myfield|add_class:'delete' }}

Answer 6

你只需要安装 Django widget_tweaks

pip install django-widget-tweaks

在你可以在你的模板上做类似的事情之后：

{{ form.search_query|attr:"type:search" }}

--

阅读所有相关信息here。

Answer 7

为了解决这个问题，我制作了自己的模板过滤器，您可以将其应用于任何标签，而不仅仅是输入元素！

class_re = re.compile(r'(?<=class=["\'])(.*)(?=["\'])')
@register.filter
def add_class(value, css_class):
    string = unicode(value)
    match = class_re.search(string)
    if match:
        m = re.search(r'^%s$|^%s\s|\s%s\s|\s%s$' % (css_class, css_class, 
                                                    css_class, css_class), 
                                                    match.group(1))
        print match.group(1)
        if not m:
            return mark_safe(class_re.sub(match.group(1) + " " + css_class, 
                                          string))
    else:
        return mark_safe(string.replace('>', ' class="%s">' % css_class))
    return value

Answer 8

您需要明确指定小部件并使用attrs keyword argument 添加类。据我所知，没有其他方法。

但是，如果这太麻烦，您仍然可以将字段包装在另一个元素中，例如 div 或 span 并为其添加一个类。然后相应地修改你的 CSS。