Provide users option to use * or optional: Issue #67

Author: Parbhat

README.rst

@@ -21,7 +21,7 @@ Create a virtualenv::
 At the command line::
 
     $ pip install django-foundation-formtags
-    
+
 
 Usage
 -----
@@ -31,7 +31,7 @@ To start use django-foundation-forms in a project you must include in your setti
     INSTALLED_APPS = (
         'foundation_formtags',
     )
-    
+
 In the template load foundation tags by::
 
     {% load foundation_formtags %}
@@ -42,18 +42,28 @@ To use the django-form-foundation filter::
         {% csrf_token %}
         {{ form|as_foundation }}
     </form>
-    
+
 To use the django-form-foundation field tags::
 
     <form class="form" action="{{ url }}" method="POST">
         {% csrf_token %}
         {% render_field form.name %}
-        
+
         {% render_field form.subject %}
-        
+
         {% render_field form.message %}
     </form>
-    
+
+Required versus optional fields
+-------------------------------
+
+The normal behaviour is to mark required fields with `*`. If you want to mark only optional fields, you can add the following setting to your project settings file.
+
+    FOUNDATION_FORMTAGS_USE_OPTIONAL = True
+
+To learn more about optional fields read this blog_.
+
+.. _blog: https://www.formulate.com.au/blog/required-versus-optional-fields-new-standard
 
 Contributing
 ------------
@@ -63,4 +73,4 @@ little bit helps, and credit will always be given.
 
 
 * Free software: BSD license
-* Documentation: https://django-foundation-formtags.readthedocs.org.
+* Documentation: https://django-foundation-formtags.readthedocs.org.

docs/usage.rst

@@ -6,7 +6,7 @@ To start use django-foundation-forms in a project you must include in your setti
     INSTALLED_APPS = (
         'foundation_formtags',
     )
-    
+
 In the template load foundation tags by::
 
     {% load foundation_formtags %}
@@ -17,14 +17,25 @@ To use the django-form-foundation filter::
         {% csrf_token %}
         {{ form|as_foundation }}
     </form>
-    
+
 To use the django-form-foundation field tags::
 
     <form class="form" action="{{ url }}" method="POST">
         {% csrf_token %}
         {% render_field form.name %}
-        
+
         {% render_field form.subject %}
-        
+
         {% render_field form.message %}
-    </form>
+    </form>
+
+Required versus optional fields
+-------------------------------
+
+The normal behaviour is to mark required fields with `*`. If you want to mark only optional fields, you can add the following setting to your project settings file.
+
+    FOUNDATION_FORMTAGS_USE_OPTIONAL = True
+
+To learn more about optional fields read this blog_.
+
+.. _blog: https://www.formulate.com.au/blog/required-versus-optional-fields-new-standard

foundation_formtags/templates/foundation_formtags/foundation_form_field.html

@@ -13,13 +13,15 @@
             <small class="form-error is-visible chk">{{ error }}</small>
         {% endfor %}
     {% endif %}
-    
+
     {% if field.label %}
         <label for="{{ field.auto_id }}" class={% if field.errors %}"is-invalid-label"{% endif %}>
             {{ field.label|safe }}
-                {% if not field.field.required  %}
-                   <span class="optional">(optional)</span>
-                {% endif %}
+            {% if not field.field.required and use_optional %}
+                    <span class="optional">(optional)</span>
+            {% elif field.field.required and not use_optional %}
+                    <span class="required">*</span>
+            {% endif %}
         </label>
     {% endif %}
 
@@ -32,5 +34,5 @@
             <small>{{ field.help_text|safe }}</small>
         {% endif %}
     {% endif %}
-    
-{% endif %}
+
+{% endif %}

foundation_formtags/templatetags/foundation_formtags.py

@@ -2,16 +2,21 @@
 
 import types
 from django import template
+from django.conf import settings
 from django.template.loader import get_template
-from django.template import Context
 from django.forms import CheckboxInput
 register = template.Library()
 
 
+FOUNDATION_FORMTAGS_USE_OPTIONAL = getattr(
+    settings, 'FOUNDATION_FORMTAGS_USE_OPTIONAL', False
+)
+
+
 @register.filter
 def as_foundation(form):
     template = get_template("foundation_formtags/form.html")
-    c = {"form": form}
+    c = {"form": form, "use_optional": FOUNDATION_FORMTAGS_USE_OPTIONAL}
     return template.render(c)