Определить класс CSS в формах Django

144

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

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

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

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

  • 8
    вау, все проголосовали за это? docs.djangoproject.com/en/dev/ref/forms/widgets/...
  • 8
    @skyl Я бы воспринял это как указание на то, что его нелегко найти в документации Django. Я просмотрел и сделал несколько поисков в Google тоже и не смог найти это, так что я рад за вопрос, и он получает мой upvote.
Показать ещё 2 комментария
Теги:
django-forms

12 ответов

75
Лучший ответ

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

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

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

  • 2
    Означает ли это, что он не может быть использован с классом ModelForm?
  • 0
    Нет, вам просто нужно явно определить поле формы в форме модели, чтобы вы могли определить виджет. Или используйте решение, перечисленное ниже, чтобы избежать необходимости вносить изменения в поле формы.
152

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

  • 51
    Единственное вменяемое решение, должен сказать. Спасибо!. Код Python, особенно в определении формы, является последним местом, где можно применить стили для стиля - они определенно принадлежат шаблонам.
  • 4
    Это отличная библиотека! Обидно, этот ответ похоронен внизу.
Показать ещё 10 комментариев
61

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

def __init__(self, *args, **kwargs):
    super(SampleClass, self).__init__(*args, **kwargs)
    self.fields['name'].widget.attrs['class'] = 'my_class'
  • 4
    Для ModelForms это часто лучше, так как вам не нужно знать об используемом поле формы по умолчанию, и вы можете динамически устанавливать различные классы в зависимости от условий выполнения. Чище, чем мета-кодирование
  • 1
    Это предполагает, что вы хотите ввод для каждого поля в форме, что часто не так. Форма не обязательно связана с моделью - она может быть связана со многими моделями. В случае, если поля модели и поля формы имеют отношение 1: 1, тогда да, ModelForm - гораздо лучший выбор.
35

Используйте django-widget-tweaks, он прост в использовании и работает очень хорошо.

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

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

<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>

form.subject - это экземпляр 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', None).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>

form.subjects будет отображаться с классом css "MyClass".

Надеюсь на эту помощь.

ИЗМЕНИТЬ

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

  • Добавить ссылку django-widget-tweak

  • 3
    Это замечательно! Это СУХОЙ, и это отделяет слой дисплея от контрольного слоя. +1 от меня!
  • 1
    Однако теперь я заметил один недостаток. Если я определяю класс в атрибутах виджетов, то они переопределяются этим фильтром 'addcss'. У вас есть идеи, как это объединить?
Показать ещё 6 комментариев
28

Расширение метода, указанного на 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'

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

  • 0
    Это именно то, что говорили другие много лет назад, за исключением того, что вы делаете это с помощью «размера», а не «класса», который был запрошен.
  • 2
    @Chris Morgan На самом деле, он первый, кто предложил использовать «comment.widget.attrs» в самой декларации формы (вместо того, чтобы связываться с init или делать это в представлении).
22

Если вы хотите, чтобы все поля формы наследовали определенный класс, вы просто определяете родительский класс, который наследует от 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' ко всем полям во всех формах моего приложения без добавления репликации кода.

  • 1
    пожалуйста, начинайте имена классов с заглавных букв (кроме того, BaseForm кажется гораздо более подходящим названием)
13

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

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

Ниже приведена вариация, которая даст все поля одного и того же класса (например, jquery nice rounded corner).

  # 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'
1

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

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'
        }
    ))
1

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

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

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

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})
  • 0
    Спасибо за ваше предложение. Я отредактировал свой ответ соответственно более «питоническим» подходом.
  • 0
    отлично !! это то что я искал
1

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

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})
0

Вы также можете использовать Django Crispy Forms, это отличный инструмент для определения форм, если вы хотите использовать некоторую 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'),
        )
    )

Ещё вопросы

Сообщество Overcoder
Наверх
Меню