Определение класса css в формах django

Предположим у меня есть форма

class SampleClass(forms.Form):
    name = forms.CharField(max_length=30)
    age = forms.IntegerField()
    django_hacker = forms.BooleanField(required=False)

есть ли способ определить классы css для каждого поля, чтобы я мог использовать jQuery на основе класса в моей отображаемой странице?

Я надеялся, что не придется вручную создавать форму.

12 ответов


еще одно решение, которое не требует изменений в коде python и поэтому лучше для дизайнеров и одноразовых презентационных изменений:django-виджет-настройки. Надеюсь, кому-нибудь это пригодится.


ответил на мой собственный вопрос. вздох

http://docs.djangoproject.com/en/dev/ref/forms/widgets/#django.forms.Widget.attrs

Я не понял, что он был передан в конструктор виджета.


вот еще одно решение для добавления определения классов в виджеты после объявления полей в классе.

def __init__(self, *args, **kwargs):
    super(SampleClass, self).__init__(*args, **kwargs)
    self.fields['name'].widget.attrs['class'] = 'my_class'

использовать django-виджет-настройки, Это простой в использовании и работает довольно хорошо.

В противном случае это можно сделать с помощью настраиваемого фильтра шаблонов.

учитывая, что вы представляете свою форму таким образом:

<form action="/contact/" method="post">
    {{ form.non_field_errors }}
    <div class="fieldWrapper">
        {{ form.subject.errors }}
        <label for="id_subject">Email subject:</label>
        {{ form.subject }}
    </div>
</form>

форма.субъект-это экземпляр BoundField, которая имеет as_widget метод.

вы можете создать пользовательский фильтр "addcss" в "my_app/templatetags/myfilters.py"

from django import template

register = template.Library()

@register.filter(name='addcss')
def addcss(value, arg):
    css_classes = value.field.widget.attrs.get('class', '').split(' ')
    if css_classes and arg not in css_classes:
        css_classes = '%s %s' % (css_classes, arg)
    return value.as_widget(attrs={'class': css_classes})

и затем примените фильтр:

{% load myfilters %}
<form action="/contact/" method="post">
    {{ form.non_field_errors }}
    <div class="fieldWrapper">
        {{ form.subject.errors }}
        <label for="id_subject">Email subject:</label>
        {{ form.subject|addcss:'MyClass' }}
    </div>
</form>

форма.затем объекты будут отображаться с помощью css-класса" MyClass".

надеюсь, что это поможет.

правка 1

  • обновить фильтр в соответствии с dimyGответом

  • добавить django-widget-tweak link

Изменить 2

  • фильтр обновления в соответствии с Bhyd'ы комментарий

расширение метода, указанного на docs.djangoproject.com:

class MyForm(forms.Form): 
    comment = forms.CharField(
            widget=forms.TextInput(attrs={'size':'40'}))

Я думал, что это было хлопотно, чтобы знать собственный тип виджета для каждого поля, и подумал, что смешно переопределить значение по умолчанию, чтобы просто поместить имя класса в поле формы. Это, кажется, работает для меня:

class MyForm(forms.Form): 
    #This instantiates the field w/ the default widget
    comment = forms.CharField()

    #We only override the part we care about
    comment.widget.attrs['size'] = '40'

Это кажется мне немного чище.


Если вы хотите, чтобы все поля в форме наследовали определенный класс, вы просто определяете родительский класс, который наследует от forms.ModelForm, а затем наследовать от него

class BaseForm(forms.ModelForm):
    def __init__(self, *args, **kwargs):
        super(BaseForm, self).__init__(*args, **kwargs)
        for field_name, field in self.fields.items():
            field.widget.attrs['class'] = 'someClass'


class WhateverForm(BaseForm):
    class Meta:
        model = SomeModel

это помогло мне добавить 'form-control' class для всех полей на всех формах моего приложения автоматически, без добавления репликации кода.


вот простой способ изменить в представлении. добавьте ниже в виде непосредственно перед передачей его в шаблон.

form = MyForm(instance = instance.obj)
form.fields['email'].widget.attrs = {'class':'here_class_name'}

просто добавить классы в форму следующим образом.

class UserLoginForm(forms.Form):
    username = forms.CharField(widget=forms.TextInput(
        attrs={
        'class':'form-control',
        'placeholder':'Username'
        }
    ))
    password = forms.CharField(widget=forms.PasswordInput(
        attrs={
        'class':'form-control',
        'placeholder':'Password'
        }
    ))

вот вариант выше, который даст всем полям один и тот же класс (например, jQuery хорошие закругленные углы).

  # Simple way to assign css class to every field
  def __init__(self, *args, **kwargs):
    super(TranslatedPageForm, self).__init__(*args, **kwargs)
    for myField in self.fields:
      self.fields[myField].widget.attrs['class'] = 'ui-state-default ui-corner-all'

в случае, если вы хотите добавить класс в поле формы в шаблоне (не в view.py или form.py) например, в случаях, когда вы хотите изменить сторонние приложения без переопределения их представлений, затем фильтр шаблона, как описано в Charlesthk ответ очень удобно. Но в этом ответе фильтр шаблона переопределяет все существующие классы, которые может иметь поле.

Я попытался добавить это в качестве редактирования, но было предложено написано как новый ответ.

Итак, тег шаблона, который уважает существующие классы поля:

from django import template

register = template.Library()


@register.filter(name='addclass')
def addclass(field, given_class):
    existing_classes = field.field.widget.attrs.get('class', None)
    if existing_classes:
        if existing_classes.find(given_class) == -1:
            # if the given class doesn't exist in the existing classes
            classes = existing_classes + ' ' + given_class
        else:
            classes = existing_classes
    else:
        classes = given_class
    return field.as_widget(attrs={"class": classes})

Как оказалось, Вы можете сделать это в конструкторе формы (init function) или после того, как класс формы был инициирован. Это иногда требуется, если вы не пишете свою собственную форму, и эта форма приходит откуда-то еще -

def some_view(request):
    add_css_to_fields = ['list','of','fields']
    if request.method == 'POST':
        form = SomeForm(request.POST)
        if form.is_valid():
            return HttpResponseRedirect('/thanks/')
    else:
        form = SomeForm()

    for key in form.fields.keys():
        if key in add_css_to_fields:
            field = form.fields[key]
            css_addition = 'css_addition '
            css = field.widget.attrs.get('class', '')
            field.widget.attrs['class'] = css_addition + css_classes

    return render(request, 'template_name.html', {'form': form})

вы также можете использовать Хрустящие Формы Django, Это отличный инструмент для определения форм, Если вы хотите использовать некоторые рамки CSS, такие как Bootstrap или Foundation. И там легко указать классы для полей формы.

ваш класс формы хотел бы это тогда:

from django import forms

from crispy_forms.helper import FormHelper
from crispy_forms.layout import Layout, Div, Submit, Field
from crispy_forms.bootstrap import FormActions

class SampleClass(forms.Form):
    name = forms.CharField(max_length=30)
    age = forms.IntegerField()
    django_hacker = forms.BooleanField(required=False)

    helper = FormHelper()
    helper.form_class = 'your-form-class'
    helper.layout = Layout(
        Field('name', css_class='name-class'),
        Field('age', css_class='age-class'),
        Field('django_hacker', css-class='hacker-class'),
        FormActions(
            Submit('save_changes', 'Save changes'),
        )
    )