Skip to content

Commit d7fed6d

Browse files
Dayana-Naleksihakli
authored andcommitted
docs: add how to render form errors to readme file
1 parent 5287425 commit d7fed6d

File tree

1 file changed

+80
-0
lines changed

1 file changed

+80
-0
lines changed

README.rst

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -336,6 +336,86 @@ Example usage:
336336
With 'rightmost filter wins' rule it wouldn't be possible to override
337337
``|attr:"foo:default_foo"`` in main template.
338338

339+
Rendering form error messages
340+
===============================
341+
342+
This app can render the following form error messages:
343+
344+
1. Field related errors
345+
2. Non-Field related errors
346+
3. All form errors - Displays all field and non-field related errors. If related to a specific field the name is dispayed above the error, if the error is a general form error, displays __all__
347+
348+
349+
Field related errors
350+
--------------------
351+
To render field related errors in your form:
352+
353+
Example:
354+
355+
.. code-block:: html+django
356+
357+
{% load widget_tweaks %}
358+
{% for error in field.errors %}
359+
<span class="text-danger">{{ error }}</span>
360+
{% endfor %}
361+
362+
363+
364+
Example usage:
365+
366+
.. code-block:: html+django
367+
368+
{% for field in form.visible_fields %}
369+
{{ field }}
370+
<label for="{{ field.id_for_label }}">{{ field.label }}</label>
371+
{% for error in field.errors %}
372+
<span class="text-danger">{{ error }}</span>
373+
{% endfor %}
374+
{% endfor %}
375+
376+
377+
378+
Non-Field related errors
379+
--------------------
380+
Render general form errors:
381+
382+
Example:
383+
384+
.. code-block:: html+django
385+
386+
{% load widget_tweaks %}
387+
{% if form.non_field_errors %}
388+
<span class="text-danger"> {{ form.non_field_errors }}</span>
389+
{% endif %}
390+
391+
392+
Example usage:
393+
394+
.. code-block:: html+django
395+
396+
{% for field in form.visible_fields %}
397+
{{ field }}
398+
<label for="{{ field.id_for_label }}">{{ field.label }}</label>
399+
{% for error in field.errors %}
400+
<span class="text-danger">{{ error }}</span>
401+
{% endfor %}
402+
{% endfor %}
403+
404+
405+
406+
All form errors
407+
--------------------
408+
Render all form errors:
409+
410+
Example:
411+
412+
.. code-block:: html+django
413+
414+
{% load widget_tweaks %}
415+
{{ form.errors }}
416+
417+
418+
339419
Contributing
340420
============
341421

0 commit comments

Comments
 (0)