Comment ajouter un espace réservé sur un CharField dans Django?

Prenez cette forme très simple, par exemple:

class SearchForm(Form):
    q = forms.CharField(label='search')

Cela est rendu dans le modèle:

<input type="text" name="q" id="id_q" />

Cependant, je veux ajouter l' placeholderattribut à ce champ avec une valeur de Searchsorte que le HTML ressemble à quelque chose comme:

<input type="text" name="q" id="id_q" placeholder="Search" />

De préférence, je voudrais transmettre la valeur de l'espace réservé à CharFielddans la classe de formulaire via un dictionnaire ou quelque chose comme:

q = forms.CharField(label='search', placeholder='Search')

Quelle serait la meilleure façon d'y parvenir?

Regardez la documentation des widgets . Fondamentalement, cela ressemblerait à:

q = forms.CharField(label='search', 
                    widget=forms.TextInput(attrs={'placeholder': 'Search'}))

Plus d'écriture, oui, mais la séparation permet une meilleure abstraction des cas plus compliqués.

Vous pouvez également déclarer un widgetsattribut contenant un <field name> => <widget instance>mappage directement sur le Metade votre ModelFormsous-classe.

Pour un ModelForm, vous pouvez utiliser la classe Meta ainsi:

from django import forms

from .models import MyModel

class MyModelForm(forms.ModelForm):
    class Meta:
        model = MyModel
        widgets = {
            'name': forms.TextInput(attrs={'placeholder': 'Name'}),
            'description': forms.Textarea(
                attrs={'placeholder': 'Enter description here'}),
        }

Les autres méthodes sont toutes bonnes. Cependant, si vous préférez ne pas spécifier le champ (par exemple pour une méthode dynamique), vous pouvez utiliser ceci:

def __init__(self, *args, **kwargs):
    super(MyForm, self).__init__(*args, **kwargs)
    self.fields['email'].widget.attrs['placeholder'] = self.fields['email'].label or '[email protected]'

Il permet également à l'espace réservé de dépendre de l'instance de ModelForms avec l'instance spécifiée.

Vous pouvez utiliser ce code pour ajouter un attr d'espace réservé pour chaque champ TextInput de votre formulaire. Le texte des espaces réservés sera tiré des étiquettes de champ du modèle.

class PlaceholderDemoForm(forms.ModelForm):
    def __init__(self, *args, **kwargs):
        super(PlaceholderDemoForm, self).__init__(*args, **kwargs)
        for field_name in self.fields:
            field = self.fields.get(field_name)  
            if field:
                if type(field.widget) in (forms.TextInput, forms.DateInput):
                    field.widget = forms.TextInput(attrs={'placeholder': field.label})

    class Meta:
        model = DemoModel

Grande question. Je connais trois solutions:

Solution n ° 1

Remplacez le widget par défaut.

class SearchForm(forms.Form):  
    q = forms.CharField(
            label='Search',
            widget=forms.TextInput(attrs={'placeholder': 'Search'})
        )

Solution n ° 2

Personnalisez le widget par défaut. Si vous utilisez le même widget que le champ utilise habituellement, vous pouvez simplement le personnaliser au lieu d'en instancier un entièrement nouveau.

class SearchForm(forms.Form):  
    q = forms.CharField(label='Search')

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.fields['q'].widget.attrs.update({'placeholder': 'Search'})

Solution n ° 3

Enfin, si vous travaillez avec un formulaire modèle, vous avez la possibilité ( en plus des deux solutions précédentes ) de spécifier un widget personnalisé pour un champ en définissant l' widgetsattribut de la Metaclasse interne .

class CommentForm(forms.ModelForm):  
    class Meta:
        model = Comment
        widgets = {
            'body': forms.Textarea(attrs={'cols': 80, 'rows': 20})
        }

Il n'est pas souhaitable de savoir comment instancier un widget lorsque vous souhaitez simplement remplacer son espace réservé.

    q = forms.CharField(label='search')
    ...
    q.widget.attrs['placeholder'] = "Search"

La plupart du temps, je souhaite simplement que tous les espaces réservés soient égaux au nom détaillé du champ défini dans mes modèles

J'ai ajouté un mixin pour le faire facilement dans n'importe quelle forme que je crée,

class ProductForm(PlaceholderMixin, ModelForm):
    class Meta:
        model = Product
        fields = ('name', 'description', 'location', 'store')

Et

class PlaceholderMixin:
    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs):
        field_names = [field_name for field_name, _ in self.fields.items()]
        for field_name in field_names:
            field = self.fields.get(field_name)
            field.widget.attrs.update({'placeholder': field.label})

Après avoir regardé votre méthode, j'ai utilisé cette méthode pour la résoudre.

class Register(forms.Form):
    username = forms.CharField(label='用户名', max_length=32)
    email = forms.EmailField(label='邮箱', max_length=64)
    password = forms.CharField(label="密码", min_length=6, max_length=16)
    captcha = forms.CharField(label="验证码", max_length=4)

def __init__(self, *args, **kwargs):
    super().__init__(*args, **kwargs)
    for field_name in self.fields:
        field = self.fields.get(field_name)
        self.fields[field_name].widget.attrs.update({
            "placeholder": field.label,
            'class': "input-control"
        })