Rename tbx template pack to tbxforms

CHANGELOG.md

@@ -16,6 +16,10 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ## Unreleased
 
+### Changed
+
+-   Renamed `tbx` template directory and crispy forms template pack to `tbxforms` [#92]
+
 ### Fixed
 
 -   Conditional fields not working properly when there are multiple elements inspecting the same driving field [#91]

README.md

@@ -60,8 +60,8 @@ INSTALLED_APPS = [
 Now add the following settings to tell `django-crispy-forms` to use `tbxforms`:
 
 ```python
-CRISPY_ALLOWED_TEMPLATE_PACKS = ["tbx"]
-CRISPY_TEMPLATE_PACK = "tbx"
+CRISPY_ALLOWED_TEMPLATE_PACKS = ["tbxforms"]
+CRISPY_TEMPLATE_PACK = "tbxforms"
 ```
 
 ### Install the NPM package

tbxforms/templates/tbx/display_form.html → tbxforms/templates/tbxforms/display_form.html

@@ -1,7 +1,7 @@
 {% if form.form_html %}
     {% if include_media %}{{ form.media }}{% endif %}
-    {% include "tbx/errors.html" %}
+    {% include "tbxforms/errors.html" %}
     {{ form.form_html }}
 {% else %}
-    {% include "tbx/uni_form.html" %}
+    {% include "tbxforms/uni_form.html" %}
 {% endif %}

tbxforms/templates/tbx/field.html → tbxforms/templates/tbxforms/field.html

@@ -10,15 +10,15 @@
     <{% if tag %}{{ tag }}{% else %}div{% endif %} id="div_{{ field.auto_id }}" class="tbxforms-form-group{% if field.errors %} tbxforms-form-group--error{% endif %}{% if wrapper_class %} {{ wrapper_class }}{% endif %}{% if field.css_classes %} {{ field.css_classes }}{% endif %}">
 
     {% if field|is_checkboxes %}
-        {% include "tbx/layout/checkboxes.html" %}
+        {% include "tbxforms/layout/checkboxes.html" %}
     {% endif %}
 
     {% if field|is_radios %}
-        {% include "tbx/layout/radios.html" %}
+        {% include "tbxforms/layout/radios.html" %}
     {% endif %}
 
     {% if field|is_multivalue %}
-        {% include "tbx/layout/multifield.html" %}
+        {% include "tbxforms/layout/multifield.html" %}
     {% endif %}
 
     {% if not field|is_checkboxes and not field|is_radios and not field|is_multivalue %}
@@ -36,7 +36,7 @@
         {% endif %}
 
         {% if field|is_checkbox and form_show_labels %}
-            {% include "tbx/layout/help_text_and_errors.html" %}
+            {% include "tbxforms/layout/help_text_and_errors.html" %}
             <div class="tbxforms-checkboxes{% if checkboxes_small %} tbxforms-checkboxes--small{% endif %}">
                 <div class="tbxforms-checkboxes__item">
                     {% crispy_tbx_field field %}
@@ -46,7 +46,7 @@
                 </div>
             </div>
         {% else %}
-            {% include "tbx/layout/help_text_and_errors.html" %}
+            {% include "tbxforms/layout/help_text_and_errors.html" %}
             {% crispy_tbx_field field %}
             {% if max_characters or max_words %}
                 <p id="{{ field.id_for_label }}-info" class="tbxforms-hint tbxforms-character-count__message" aria-live="polite">

tbxforms/templates/tbxforms/inputs.html

@@ -0,0 +1,3 @@
+{% for input in inputs %}
+    {% include "tbxforms/layout/baseinput.html" %}
+{% endfor %}

tbxforms/templates/tbx/layout/checkboxes.html → tbxforms/templates/tbxforms/layout/checkboxes.html

@@ -20,7 +20,7 @@
         </legend>
     {% endif %}
 
-    {% include "tbx/layout/help_text_and_errors.html" %}
+    {% include "tbxforms/layout/help_text_and_errors.html" %}
 
     <div class="tbxforms-checkboxes{% if inline %}--inline{% endif %}{% if checkboxes_small %} tbxforms-checkboxes--small{% endif %}">
         {% for choice in field.field.choices %}

tbxforms/templates/tbxforms/layout/help_text_and_errors.html

@@ -0,0 +1,2 @@
+{% include "tbxforms/layout/help_text.html" %}
+{% include "tbxforms/layout/field_errors.html" %}

tbxforms/templates/tbx/layout/multifield.html → tbxforms/templates/tbxforms/layout/multifield.html

@@ -20,7 +20,7 @@
         </legend>
     {% endif %}
 
-    {% include "tbx/layout/help_text_and_errors.html" %}
+    {% include "tbxforms/layout/help_text_and_errors.html" %}
     {% crispy_tbx_field field %}
 
 </fieldset>

tbxforms/templates/tbx/layout/radios.html → tbxforms/templates/tbxforms/layout/radios.html

@@ -20,7 +20,7 @@
         </legend>
     {% endif %}
 
-    {% include "tbx/layout/help_text_and_errors.html" %}
+    {% include "tbxforms/layout/help_text_and_errors.html" %}
 
     <div class="tbxforms-radios{% if radios_inline %}--inline{% endif %}{% if radios_small %} tbxforms-radios--small{% endif %}">
         {% for choice in field.field.choices %}

tbxforms/templates/tbx/uni_form.html → tbxforms/templates/tbxforms/uni_form.html

@@ -1,6 +1,6 @@
 {% if include_media %}{{ form.media }}{% endif %}
 
-{% include "tbx/errors.html" %}
+{% include "tbxforms/errors.html" %}
 
 {% for field in form %}
     {% include field_template %}

tbxforms/templates/tbx/uni_formset.html → tbxforms/templates/tbxforms/uni_formset.html

@@ -1,9 +1,9 @@
 {% with formset.management_form as form %}
-    {% include "tbx/uni_form.html" %}
+    {% include "tbxforms/uni_form.html" %}
 {% endwith %}
 
 {% for form in formset %}
     <div class="multiField">
-        {% include "tbx/uni_form.html" %}
+        {% include "tbxforms/uni_form.html" %}
     </div>
 {% endfor %}

tbxforms/templates/tbx/whole_uni_form.html → tbxforms/templates/tbxforms/whole_uni_form.html

@@ -6,9 +6,9 @@
         {% csrf_token %}
     {% endif %}
 
-    {% include "tbx/display_form.html" %}
+    {% include "tbxforms/display_form.html" %}
 
-    {% include "tbx/inputs.html" %}
+    {% include "tbxforms/inputs.html" %}
 
 {% if form_tag %}
     </form>

tbxforms/templates/tbx/whole_uni_formset.html → tbxforms/templates/tbxforms/whole_uni_formset.html

@@ -13,13 +13,13 @@
     </div>
 
     {% for form in formset %}
-        {% include "tbx/display_form.html" %}
+        {% include "tbxforms/display_form.html" %}
     {% endfor %}
 
     {% if inputs %}
         <div class="form-actions">
             {% for input in inputs %}
-                {% include "tbx/layout/baseinput.html" %}
+                {% include "tbxforms/layout/baseinput.html" %}
             {% endfor %}
         </div>
     {% endif %}

tbxforms/templatetags/tbxforms.py

@@ -172,7 +172,7 @@ def render(self, context):  # noqa: C901
             [getattr(field.field.widget, "widget", field.field.widget)],
         )
 
-        if template_pack == "tbx":
+        if template_pack == "tbxforms":
             if is_multivalue(field):
                 error_widgets = [field.widget for field in field.field.fields]
                 error_count = sum(
@@ -215,7 +215,7 @@ def render(self, context):  # noqa: C901
 
             css_class = " ".join(css_class)
 
-            if template_pack == "tbx":
+            if template_pack == "tbxforms":
                 # The ability to override input_type was added to
                 # avoid having to create new widgets. However, as a
                 # result, the browser validates the field and displays
@@ -342,7 +342,7 @@ def crispy_tbx_field(parser, token):
     ``django-crispy-forms``. Any additions are clearly marked with a
     check to see if the 'gds' template pack is being used.
 
-    This template tag is only used within the tbx/field.html template
+    This template tag is only used within the tbxforms/field.html template
     and you almost certainly will not have to deal with it, even if
     you are laying out a form explicitly.
 

tbxforms/widgets.py

@@ -18,7 +18,7 @@ class DateInputWidget(forms.MultiWidget):
 
     """
 
-    template_name = "tbx/widgets/date.html"
+    template_name = "tbxforms/widgets/date.html"
 
     def __init__(self, *args, **kwargs):
         widgets = [

tests/layout/test_buttons.py

@@ -17,7 +17,7 @@
     ),
 )
 class TestButtons:
-    TEMPLATE = '{% include "tbx/layout/button.html" %}'
+    TEMPLATE = '{% include "tbxforms/layout/button.html" %}'
 
     def test_button(self, button_factory, snapshot_html):
         button = button_factory("name", "Title")

tests/layout/test_escaping.py

@@ -46,7 +46,7 @@ class TestButtonEscaping:
     be marked as safe.
     """
 
-    TEMPLATE = '{% include "tbx/layout/button.html" %}'
+    TEMPLATE = '{% include "tbxforms/layout/button.html" %}'
 
     def test_unsafe_markup_escaped(self, button_factory, snapshot_html):
         """

tests/settings.py

@@ -18,8 +18,8 @@
     },
 ]
 
-CRISPY_ALLOWED_TEMPLATE_PACKS = ("tbx",)
+CRISPY_ALLOWED_TEMPLATE_PACKS = ("tbxforms",)
 
-CRISPY_TEMPLATE_PACK = "tbx"
+CRISPY_TEMPLATE_PACK = "tbxforms"
 
 CRISPY_FAIL_SILENTLY = False