How do I add a placeholder on a CharField in Django

Question

Take this very simple form for example   class SearchForm Form       q   forms CharField label  search     This gets rendered in the template    lt input type  text  name  q  id  id q    gt    However  I want to add the placeholder attribute to this field with a value of Search so that the HTML would look something like    lt input type  text  name  q  id  id q  placeholder  Search    gt    Preferably I would like to pass the placeholder value in to CharField in the form class through a dictionary or something like   q   forms CharField label  search   placeholder  Search     What would be the best way to accomplish this

User · Answer

Most of the time I just wish to have all placeholders equal to the verbose name of the field defined in my models

I've added a mixin to easily do this to any form that I create,

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

And

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

User · Answer

The other methods are all good  However  if you prefer to not specify the field  e g  for some dynamic method   you can use this   def   init   self   args    kwargs       super MyForm  self    init    args    kwargs      self fields  email   widget attrs  placeholder     self fields  email   label or  email address nl    It also allows the placeholder to depend on the instance for ModelForms with instance specified

User · Answer

For a ModelForm  you can use the Meta class thus   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

User · Answer

class FormClass forms ModelForm       class Meta          model   Book         fields      all            widgets                  field name   forms TextInput attrs   placeholder    Type placeholder text here

User · Answer

Look at the widgets documentation  Basically it would look like   q   forms CharField label  search                        widget forms TextInput attrs   placeholder    Search       More writing  yes  but the separation allows for better abstraction of more complicated cases   You can also declare a widgets attribute containing a  lt field name gt    gt   lt widget instance gt  mapping directly on the Meta of your ModelForm sub-class

User · Answer

After looking at your method  I used this method to solve it   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

User · Answer

Great question  There are three solutions I know about   Solution  1  Replace the default widget   class SearchForm forms Form         q   forms CharField              label  Search               widget forms TextInput attrs   placeholder    Search                Solution  2  Customize the default widget  If you re using the same widget that the field usually uses then you can simply customize that one instead of instantiating an entirely new one   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  3  Finally  if you re working with a model form then  in addition to the previous two solutions  you have the option to specify a custom widget for a field by setting the widgets attribute of the inner Meta class   class CommentForm forms ModelForm         class Meta          model   Comment         widgets                  body   forms Textarea attrs   cols   80   rows   20

User · Answer

You can use this code to add placeholder attr for every TextInput field in you form  Text for placeholders will be taken from model field labels   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

User · Answer

It s undesirable to have to know how to instantiate a widget when you just want to override its placeholder       q   forms CharField label  search               q widget attrs  placeholder      Search

[python] How do I add a placeholder on a CharField in Django?

Examples related to python

Examples related to django

Examples related to django-forms