Django: How to build a custom form widget?

Question

I am having a difficult time finding documentation on how to write a custom widget.

My questions are:

• If I build a custom widget, can it be used equiva

Answer 1

Django <1.11

Additionally to the other answers, this is a small code sample of a custom widget:

widgets.py:

from django.forms.widgets import Widget
from django.template import loader
from django.utils.safestring import mark_safe


class MyWidget(Widget):
    template_name = 'myapp/my_widget.html'

    def get_context(self, name, value, attrs=None):
        return {'widget': {
            'name': name,
            'value': value,
        }}

    def render(self, name, value, attrs=None):
        context = self.get_context(name, value, attrs)
        template = loader.get_template(self.template_name).render(context)
        return mark_safe(template)

my_widget.html:

{% if widget.value %}{{ widget.value }}{% endif %}

Django 1.11

Widgets are now rendered using the form rendering API.