Hyphenate attributes with certain prefixes

docs/settings.rst

@@ -57,6 +57,9 @@ The ``BOOTSTRAP5`` dict variable contains these settings and defaults:
         # Field class used for horizontal fields withut a label.
         'horizontal_field_offset_class': 'offset-sm-2',
 
+        # HTML attributes with any of these prefixes will have underscores converted to hyphens.
+        "hyphenate_attribute_prefixes": ["data"],
+
         # Set placeholder attributes to label if no placeholder is provided.
         'set_placeholder': True,
 

src/django_bootstrap5/core.py

@@ -2,7 +2,6 @@
 
 from django.conf import settings
 
-BOOTSTRAP5 = {"foo": "bar"}
 BOOTSTRAP5_DEFAULTS = {
     "css_url": {
         "url": "https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/css/bootstrap.min.css",
@@ -34,6 +33,7 @@
     "field_renderers": {
         "default": "django_bootstrap5.renderers.FieldRenderer",
     },
+    "hyphenate_attribute_prefixes": ["data"],
 }
 
 

src/django_bootstrap5/html.py

@@ -1,9 +1,13 @@
+from copy import copy
+
 from django.forms.utils import flatatt
 from django.utils.html import format_html
 
 from django_bootstrap5.text import text_value
 from django_bootstrap5.utils import get_url_attrs
 
+from .core import get_bootstrap_setting
+
 
 def render_script_tag(url):
     """Build a script tag."""
@@ -17,8 +21,24 @@ def render_link_tag(url):
     return render_tag("link", attrs=attrs, close=False)
 
 
+def has_prefix(name, prefixes):
+    """Return whether the name has one of the given prefixes."""
+    return any(name.startswith(f"{prefix}_") for prefix in prefixes)
+
+
+def hyphenate(attr_name):
+    """Return the hyphenated version of the attribute name."""
+    return attr_name.replace("_", "-")
+
+
 def render_tag(tag, attrs=None, content=None, close=True):
     """Render an HTML tag."""
+    prefixes = get_bootstrap_setting("hyphenate_attribute_prefixes") or []
+    if attrs:
+        for attr_name, attr_value in copy(attrs).items():
+            if has_prefix(attr_name, prefixes):
+                attrs[hyphenate(attr_name)] = attr_value
+                del attrs[attr_name]
     attrs_string = flatatt(attrs) if attrs else ""
     builder = "<{tag}{attrs}>{content}"
     content_string = text_value(content)

tests/test_bootstrap_button.py

@@ -66,3 +66,38 @@ def test_button_type_link(self):
 
         with self.assertRaises(ValueError):
             self.render("{% bootstrap_button 'button' button_type='button' href='#' %}")
+
+    def test_button_hyphenate_attributes(self):
+        # No attributes to hyphenate
+        self.assertHTMLEqual(
+            self.render("{% bootstrap_button 'button' href='#' %}"),
+            '<a class="btn btn-primary" href="#" role="button">button</a>',
+        )
+        # Default: data prefix
+        self.assertHTMLEqual(
+            self.render("{% bootstrap_button 'button' href='#' data_foo='bar' %}"),
+            '<a class="btn btn-primary" href="#" role="button" data-foo="bar">button</a>',
+        )
+        # Default: no hx prefix
+        self.assertHTMLEqual(
+            self.render("{% bootstrap_button 'button' href='#' data_foo='bar' hx_xyz='abc' %}"),
+            '<a class="btn btn-primary" href="#" role="button" data-foo="bar" hx_xyz="abc">button</a>',
+        )
+        # Custom: data and hx
+        with self.settings(BOOTSTRAP5={"hyphenate_attribute_prefixes": ["data", "hx"]}):
+            self.assertHTMLEqual(
+                self.render("{% bootstrap_button 'button' href='#' data_foo='bar' hx_xyz='abc' %}"),
+                '<a class="btn btn-primary" href="#" role="button" data-foo="bar" hx-xyz="abc">button</a>',
+            )
+        # Custom: hx only
+        with self.settings(BOOTSTRAP5={"hyphenate_attribute_prefixes": ["hx"]}):
+            self.assertHTMLEqual(
+                self.render("{% bootstrap_button 'button' href='#' data_foo='bar' hx_xyz='abc' %}"),
+                '<a class="btn btn-primary" href="#" role="button" data_foo="bar" hx-xyz="abc">button</a>',
+            )
+        # Custom: empty list
+        with self.settings(BOOTSTRAP5={"hyphenate_attribute_prefixes": []}):
+            self.assertHTMLEqual(
+                self.render("{% bootstrap_button 'button' href='#' data_foo='bar' hx_xyz='abc' %}"),
+                '<a class="btn btn-primary" href="#" role="button" data_foo="bar" hx_xyz="abc">button</a>',
+            )

tests/test_bootstrap_field_radio_select.py

@@ -25,7 +25,6 @@ class DisabledSelectTestForm(forms.Form):
 
 
 class RadioSelectWithDisabledOptions(forms.RadioSelect):
-
     def __init__(self, attrs=None, choices=(), *, disabled_values=()):
         super().__init__(attrs)
         self.choices = choices
@@ -48,7 +47,6 @@ class DisabledOptionSelectTestForm(forms.Form):
     )
 
 
-
 class BootstrapFieldSelectTestCase(BootstrapTestCase):
     def test_select(self):
         """Test field with select widget."""

tests/test_bootstrap_field_radio_select_button_group.py

@@ -27,7 +27,6 @@ class DisabledSelectTestForm(forms.Form):
 
 
 class RadioSelectButtonGroupWithDisabledOptions(RadioSelectButtonGroup):
-
     def __init__(self, attrs=None, choices=(), *, disabled_values=()):
         super().__init__(attrs)
         self.choices = choices
@@ -50,8 +49,6 @@ class DisabledOptionSelectTestForm(forms.Form):
     )
 
 
-
-
 class BootstrapFieldSelectTestCase(BootstrapTestCase):
     def test_select(self):
         """Test field with select widget."""