{"title":"The form rendering API","version":"3.1","locale":"el","docname":"ref/forms/renderers","url":"/el/3.1/ref/forms/renderers/","canonical":"https://djangodocs.dev/el/3.1/ref/forms/renderers/","summary":"Django’s form widgets are rendered using Django’s template engines system . The form rendering process can be customized at several levels: Widgets can specify…","html":"<span id=\"the-form-rendering-api\"></span><h1>The form rendering API<a class=\"heading-anchor\" href=\"#module-django.forms.renderers\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h1>\n<p>Django’s form widgets are rendered using Django’s <a class=\"reference internal\" href=\"/el/3.1/topics/templates/\"><span class=\"doc\">template engines\nsystem</span></a>.</p>\n<p>The form rendering process can be customized at several levels:</p>\n<ul class=\"simple\">\n<li><p>Widgets can specify custom template names.</p></li>\n<li><p>Forms and widgets can specify custom renderer classes.</p></li>\n<li><p>A widget’s template can be overridden by a project. (Reusable applications\ntypically shouldn’t override built-in templates because they might conflict\nwith a project’s custom templates.)</p></li>\n</ul>\n<section id=\"the-low-level-render-api\">\n<span id=\"low-level-widget-render-api\"></span><h2>The low-level render API<a class=\"heading-anchor\" href=\"#the-low-level-render-api\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h2>\n<p>The rendering of form templates is controlled by a customizable renderer class.\nA custom renderer can be specified by updating the <a class=\"reference internal\" href=\"/el/3.1/ref/settings/#std-setting-FORM_RENDERER\"><code class=\"xref std std-setting docutils literal notranslate\"><span class=\"pre\">FORM_RENDERER</span></code></a>\nsetting. It defaults to\n<code class=\"docutils literal notranslate\"><span class=\"pre\">'</span></code><a class=\"reference internal\" href=\"#django.forms.renderers.DjangoTemplates\" title=\"django.forms.renderers.DjangoTemplates\"><code class=\"xref py py-class docutils literal notranslate\"><span class=\"pre\">django.forms.renderers.DjangoTemplates</span></code></a><code class=\"docutils literal notranslate\"><span class=\"pre\">'</span></code>.</p>\n<p>You can also provide a custom renderer by setting the\n<a class=\"reference internal\" href=\"/el/3.1/ref/forms/api/#django.forms.Form.default_renderer\" title=\"django.forms.Form.default_renderer\"><code class=\"xref py py-attr docutils literal notranslate\"><span class=\"pre\">Form.default_renderer</span></code></a> attribute or by using the <code class=\"docutils literal notranslate\"><span class=\"pre\">renderer</span></code> argument\nof <a class=\"reference internal\" href=\"/el/3.1/ref/forms/widgets/#django.forms.Widget.render\" title=\"django.forms.Widget.render\"><code class=\"xref py py-meth docutils literal notranslate\"><span class=\"pre\">Widget.render()</span></code></a>.</p>\n<p>Use one of the <a class=\"reference internal\" href=\"#built-in-template-form-renderers\"><span class=\"std std-ref\">built-in template form renderers</span></a> or implement your own. Custom renderers\nmust implement a <code class=\"docutils literal notranslate\"><span class=\"pre\">render(template_name,</span> <span class=\"pre\">context,</span> <span class=\"pre\">request=None)</span></code> method. It\nshould return a rendered templates (as a string) or raise\n<a class=\"reference internal\" href=\"/el/3.1/topics/templates/#django.template.TemplateDoesNotExist\" title=\"django.template.TemplateDoesNotExist\"><code class=\"xref py py-exc docutils literal notranslate\"><span class=\"pre\">TemplateDoesNotExist</span></code></a>.</p>\n</section>\n<section id=\"built-in-template-form-renderers\">\n<span id=\"id1\"></span><h2>Built-in-template form renderers<a class=\"heading-anchor\" href=\"#built-in-template-form-renderers\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h2>\n<section id=\"djangotemplates\">\n<h3><code class=\"docutils literal notranslate\"><span class=\"pre\">DjangoTemplates</span></code><a class=\"heading-anchor\" href=\"#djangotemplates\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h3>\n<dl class=\"py class\">\n<dt class=\"sig sig-object py\" id=\"django.forms.renderers.DjangoTemplates\">\n<em class=\"property\"><span class=\"k\"><span class=\"pre\">class</span></span><span class=\"w\"> </span></em><span class=\"sig-name descname\"><span class=\"pre\">DjangoTemplates</span></span><a class=\"heading-anchor\" href=\"#django.forms.renderers.DjangoTemplates\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd></dd></dl>\n\n<p>This renderer uses a standalone\n<a class=\"reference internal\" href=\"/el/3.1/topics/templates/#django.template.backends.django.DjangoTemplates\" title=\"django.template.backends.django.DjangoTemplates\"><code class=\"xref py py-class docutils literal notranslate\"><span class=\"pre\">DjangoTemplates</span></code></a>\nengine (unconnected to what you might have configured in the\n<a class=\"reference internal\" href=\"/el/3.1/ref/settings/#std-setting-TEMPLATES\"><code class=\"xref std std-setting docutils literal notranslate\"><span class=\"pre\">TEMPLATES</span></code></a> setting). It loads templates first from the built-in form\ntemplates directory in <code class=\"docutils literal notranslate\"><span class=\"pre\">django/forms/templates</span></code> and then from the installed\napps” templates directories using the <a class=\"reference internal\" href=\"/el/3.1/ref/templates/api/#django.template.loaders.app_directories.Loader\" title=\"django.template.loaders.app_directories.Loader\"><code class=\"xref py py-class docutils literal notranslate\"><span class=\"pre\">app_directories</span></code></a> loader.</p>\n<p>If you want to render templates with customizations from your\n<a class=\"reference internal\" href=\"/el/3.1/ref/settings/#std-setting-TEMPLATES\"><code class=\"xref std std-setting docutils literal notranslate\"><span class=\"pre\">TEMPLATES</span></code></a> setting, such as context processors for example, use the\n<a class=\"reference internal\" href=\"#django.forms.renderers.TemplatesSetting\" title=\"django.forms.renderers.TemplatesSetting\"><code class=\"xref py py-class docutils literal notranslate\"><span class=\"pre\">TemplatesSetting</span></code></a> renderer.</p>\n</section>\n<section id=\"jinja2\">\n<h3><code class=\"docutils literal notranslate\"><span class=\"pre\">Jinja2</span></code><a class=\"heading-anchor\" href=\"#jinja2\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h3>\n<dl class=\"py class\">\n<dt class=\"sig sig-object py\" id=\"django.forms.renderers.Jinja2\">\n<em class=\"property\"><span class=\"k\"><span class=\"pre\">class</span></span><span class=\"w\"> </span></em><span class=\"sig-name descname\"><span class=\"pre\">Jinja2</span></span><a class=\"heading-anchor\" href=\"#django.forms.renderers.Jinja2\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd></dd></dl>\n\n<p>This renderer is the same as the <a class=\"reference internal\" href=\"#django.forms.renderers.DjangoTemplates\" title=\"django.forms.renderers.DjangoTemplates\"><code class=\"xref py py-class docutils literal notranslate\"><span class=\"pre\">DjangoTemplates</span></code></a> renderer except that\nit uses a <a class=\"reference internal\" href=\"/el/3.1/topics/templates/#django.template.backends.jinja2.Jinja2\" title=\"django.template.backends.jinja2.Jinja2\"><code class=\"xref py py-class docutils literal notranslate\"><span class=\"pre\">Jinja2</span></code></a> backend. Templates\nfor the built-in widgets are located in <code class=\"docutils literal notranslate\"><span class=\"pre\">django/forms/jinja2</span></code> and installed\napps can provide templates in a <code class=\"docutils literal notranslate\"><span class=\"pre\">jinja2</span></code> directory.</p>\n<p>To use this backend, all the widgets in your project and its third-party apps\nmust have Jinja2 templates. Unless you provide your own Jinja2 templates for\nwidgets that don’t have any, you can’t use this renderer. For example,\n<a class=\"reference internal\" href=\"/el/3.1/ref/contrib/admin/#module-django.contrib.admin\" title=\"django.contrib.admin: Django's admin site.\"><code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">django.contrib.admin</span></code></a> doesn’t include Jinja2 templates for its widgets\ndue to their usage of Django template tags.</p>\n</section>\n<section id=\"templatessetting\">\n<h3><code class=\"docutils literal notranslate\"><span class=\"pre\">TemplatesSetting</span></code><a class=\"heading-anchor\" href=\"#templatessetting\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h3>\n<dl class=\"py class\">\n<dt class=\"sig sig-object py\" id=\"django.forms.renderers.TemplatesSetting\">\n<em class=\"property\"><span class=\"k\"><span class=\"pre\">class</span></span><span class=\"w\"> </span></em><span class=\"sig-name descname\"><span class=\"pre\">TemplatesSetting</span></span><a class=\"heading-anchor\" href=\"#django.forms.renderers.TemplatesSetting\"><span class=\"visually-hidden\">Link to this definition</span><span aria-hidden=\"true\">#</span></a></dt>\n<dd></dd></dl>\n\n<p>This renderer gives you complete control of how widget templates are sourced.\nIt uses <a class=\"reference internal\" href=\"/el/3.1/topics/templates/#django.template.loader.get_template\" title=\"django.template.loader.get_template\"><code class=\"xref py py-func docutils literal notranslate\"><span class=\"pre\">get_template()</span></code></a> to find widget\ntemplates based on what’s configured in the <a class=\"reference internal\" href=\"/el/3.1/ref/settings/#std-setting-TEMPLATES\"><code class=\"xref std std-setting docutils literal notranslate\"><span class=\"pre\">TEMPLATES</span></code></a> setting.</p>\n<p>Using this renderer along with the built-in widget templates requires either:</p>\n<ul>\n<li><p><code class=\"docutils literal notranslate\"><span class=\"pre\">'django.forms'</span></code> in <a class=\"reference internal\" href=\"/el/3.1/ref/settings/#std-setting-INSTALLED_APPS\"><code class=\"xref std std-setting docutils literal notranslate\"><span class=\"pre\">INSTALLED_APPS</span></code></a> and at least one engine\nwith <a class=\"reference internal\" href=\"/el/3.1/ref/settings/#std-setting-TEMPLATES-APP_DIRS\"><code class=\"xref std std-setting docutils literal notranslate\"><span class=\"pre\">APP_DIRS=True</span></code></a>.</p></li>\n<li><p>Adding the built-in widgets templates directory in <a class=\"reference internal\" href=\"/el/3.1/ref/settings/#std-setting-TEMPLATES-DIRS\"><code class=\"xref std std-setting docutils literal notranslate\"><span class=\"pre\">DIRS</span></code></a> of one of your template engines. To generate that path:</p>\n<div class=\"code-block\" data-language=\"default\"><div class=\"code-block-toolbar\"><span class=\"code-block-language\">Code</span><button type=\"button\" class=\"copy-button\" data-copy hidden><span class=\"copy-button-label\">Copy</span></button></div><pre role=\"group\" tabindex=\"0\" aria-label=\"Code code\"><code><span class=\"kn\">import</span><span class=\"w\"> </span><span class=\"nn\">django</span>\n<span class=\"n\">django</span><span class=\"o\">.</span><span class=\"n\">__path__</span><span class=\"p\">[</span><span class=\"mi\">0</span><span class=\"p\">]</span> <span class=\"o\">+</span> <span class=\"s1\">&#39;/forms/templates&#39;</span>  <span class=\"c1\"># or &#39;/forms/jinja2&#39;</span>\n</code></pre></div>\n</li>\n</ul>\n<p>Using this renderer requires you to make sure the form templates your project\nneeds can be located.</p>\n</section>\n</section>\n<section id=\"context-available-in-widget-templates\">\n<h2>Context available in widget templates<a class=\"heading-anchor\" href=\"#context-available-in-widget-templates\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h2>\n<p>Widget templates receive a context from <a class=\"reference internal\" href=\"/el/3.1/ref/forms/widgets/#django.forms.Widget.get_context\" title=\"django.forms.Widget.get_context\"><code class=\"xref py py-meth docutils literal notranslate\"><span class=\"pre\">Widget.get_context()</span></code></a>. By\ndefault, widgets receive a single value in the context, <code class=\"docutils literal notranslate\"><span class=\"pre\">widget</span></code>. This is a\ndictionary that contains values like:</p>\n<ul class=\"simple\">\n<li><p><code class=\"docutils literal notranslate\"><span class=\"pre\">name</span></code></p></li>\n<li><p><code class=\"docutils literal notranslate\"><span class=\"pre\">value</span></code></p></li>\n<li><p><code class=\"docutils literal notranslate\"><span class=\"pre\">attrs</span></code></p></li>\n<li><p><code class=\"docutils literal notranslate\"><span class=\"pre\">is_hidden</span></code></p></li>\n<li><p><code class=\"docutils literal notranslate\"><span class=\"pre\">template_name</span></code></p></li>\n</ul>\n<p>Some widgets add further information to the context. For instance, all widgets\nthat subclass <code class=\"docutils literal notranslate\"><span class=\"pre\">Input</span></code> defines <code class=\"docutils literal notranslate\"><span class=\"pre\">widget['type']</span></code> and <a class=\"reference internal\" href=\"/el/3.1/ref/forms/widgets/#django.forms.MultiWidget\" title=\"django.forms.MultiWidget\"><code class=\"xref py py-class docutils literal notranslate\"><span class=\"pre\">MultiWidget</span></code></a>\ndefines <code class=\"docutils literal notranslate\"><span class=\"pre\">widget['subwidgets']</span></code> for looping purposes.</p>\n</section>\n<section id=\"overriding-built-in-widget-templates\">\n<span id=\"id2\"></span><h2>Overriding built-in widget templates<a class=\"heading-anchor\" href=\"#overriding-built-in-widget-templates\"><span class=\"visually-hidden\">Link to this heading</span><span aria-hidden=\"true\">#</span></a></h2>\n<p>Each widget has a <code class=\"docutils literal notranslate\"><span class=\"pre\">template_name</span></code> attribute with a value such as\n<code class=\"docutils literal notranslate\"><span class=\"pre\">input.html</span></code>. Built-in widget templates are stored in the\n<code class=\"docutils literal notranslate\"><span class=\"pre\">django/forms/widgets</span></code> path. You can provide a custom template for\n<code class=\"docutils literal notranslate\"><span class=\"pre\">input.html</span></code> by defining <code class=\"docutils literal notranslate\"><span class=\"pre\">django/forms/widgets/input.html</span></code>, for example.\nSee <a class=\"reference internal\" href=\"/el/3.1/ref/forms/widgets/#built-in-widgets\"><span class=\"std std-ref\">Built-in widgets</span></a> for the name of each widget’s template.</p>\n<p>To override widget templates, you must use the <a class=\"reference internal\" href=\"#django.forms.renderers.TemplatesSetting\" title=\"django.forms.renderers.TemplatesSetting\"><code class=\"xref py py-class docutils literal notranslate\"><span class=\"pre\">TemplatesSetting</span></code></a>\nrenderer. Then overriding widget templates works <a class=\"reference internal\" href=\"/el/3.1/howto/overriding-templates/\"><span class=\"doc\">the same as</span></a> overriding any other template in your project.</p>\n</section>","rootId":"module-django.forms.renderers","toc":[{"title":"The low-level render API","anchor":"the-low-level-render-api","children":[]},{"title":"Built-in-template form renderers","anchor":"built-in-template-form-renderers","children":[{"title":"DjangoTemplates","anchor":"djangotemplates","children":[]},{"title":"Jinja2","anchor":"jinja2","children":[]},{"title":"TemplatesSetting","anchor":"templatessetting","children":[]}]},{"title":"Context available in widget templates","anchor":"context-available-in-widget-templates","children":[]},{"title":"Overriding built-in widget templates","anchor":"overriding-built-in-widget-templates","children":[]}],"breadcrumbs":[{"docname":"ref/index","title":"API Reference","url":"/el/3.1/ref/"},{"docname":"ref/forms/index","title":"Forms","url":"/el/3.1/ref/forms/"}],"prev":{"docname":"ref/forms/formsets","title":"Formset Functions","url":"/el/3.1/ref/forms/formsets/"},"next":{"docname":"ref/forms/widgets","title":"Widgets","url":"/el/3.1/ref/forms/widgets/"},"formats":{"html":"/el/3.1/ref/forms/renderers/","markdown":"/el/3.1/ref/forms/renderers.md","json":"/el/3.1/ref/forms/renderers.json"},"source":"https://github.com/django/django/blob/stable/3.1.x/docs/ref/forms/renderers.txt","official":"https://docs.djangoproject.com/el/3.1/ref/forms/renderers/","inVersions":["6.1","6.0","5.2","5.1","5.0","4.2","4.1","4.0","3.2","3.1","3.0","2.2","2.1","2.0","1.11"],"inLocales":["en","zh-hans","fr","ja","id","pt-br","ko","es","el","pl"]}