Django: How to build a custom form widget?

by

You’re right in that Django doesn’t supply documentation on this specific topic. I advise you to look at the builtin widgets in django.forms.widgets (I’ll reference classes from that module below).

If I build a custom widget, can it be used equivalently for the admin interface or for normal forms?

Admin overrides some widgets (see django.contrib.admin.options.FORMFIELD_FOR_DBFIELD_DEFAULTS). You can probably subclass ModelAdmin and change the formfield_overrides attribute, but I have never done anything with ModelAdmin so I can’t help here…

If I want to allow the user to edit a list of items, what widget should I subclass? What methods of the widget do I need to override/implement?

Your widget probably doesn’t have anything in common with the default widgets (with Select if any?!). Subclass from Widget and if you find any common pattern with builtins, you can still change it later.

Implement the following methods:

  • render(self, name, value, attrs=None, renderer=None)

    Check out Input.render for a simple example. It also supports user-defined attributes that are included in the HTML. You may also want to add “id” attributes, see MultipleHiddenInput.render on how to do that. Don’t forget to use mark_safe when outputting HTML directly. If you have a rather complex widget you can use template rendering (example).

  • _has_changed(self, initial, data)

    Optional. Used in admin to log messages about what was changed.

What widget method is responsible for going from the user’s input back to the data model?

That has nothing to do with the widget – Django can’t know what widget was used in an earlier request. It can only use the form (POST) data sent from the form. Therefore, the field method Field.to_python is used to convert input to the Python data type (may raise ValidationError if the input is invalid).

More Related Contents:

  1. Django Passing Custom Form Parameters to Formset
  2. django submit two different forms with one submit button
  3. Making a Django form class with a dynamic number of fields
  4. Django required field in model form
  5. Django edit form based on add form?
  6. Django equivalent of PHP’s form value array/associative array
  7. Add class to Django label_tag() output
  8. Dynamically creating classes – Python
  9. How to remove a field from the parent Form in a subclass?
  10. Django – Working with multiple forms
  11. Django CSRF check failing with an Ajax POST request
  12. Having Django serve downloadable files
  13. How can I enable CORS on Django REST Framework
  14. Error on “pip install -U channels” command using for otree (Running setup.py bdist_wheel for twisted … error)
  15. Split views.py in several files
  16. How to execute a GROUP BY … COUNT or SUM in Django ORM?
  17. Any way to make {% extends ‘…’ %} conditional? – Django
  18. How do I add a placeholder on a CharField in Django?
  19. is there a way to loop over two lists simultaneously in django?
  20. Django DateField default options
  21. MySQL Improperly Configured Reason: unsafe use of relative path
  22. Method Not Allowed flask error 405
  23. How do I prevent fixtures from conflicting with django post_save signal code?
  24. Do properties work on Django model fields?
  25. What’s the best solution for OpenID with Django? [closed]
  26. How can I get the current language in Django?
  27. QuerySet, Object has no attribute id – Django
  28. Can I make STATICFILES_DIR same as STATIC_ROOT in Django 1.3?
  29. dynamically loading django apps at runtime
  30. Collectstatic error while deploying Django app to Heroku

Leave a Comment