extend Button widget to use rendering size

Author: jrief

formset/renderers/__init__.py

@@ -63,3 +63,8 @@ class ButtonVariant(StrEnum):
     DANGER = auto()
     WARNING = auto()
     INFO = auto()
+
+
+class ButtonSize(StrEnum):
+    SMALL = auto()
+    LARGE = auto()

formset/renderers/admin.py

@@ -49,6 +49,7 @@ def _amend_button(self, context):
         elif context['widget']['variant'] == ButtonVariant.PRIMARY:
             class_list.add('primary')
         context['widget']['attrs']['class'] = class_list
+        context['icon_class'] = ' me-1' if context['icon_left'] else ' ms-1'
         return context
 
     _context_modifiers = dict(DefaultFormRenderer._context_modifiers, **{

formset/renderers/bootstrap.py

@@ -1,6 +1,6 @@
 from django.utils.html import format_html
 
-from formset.renderers import ButtonVariant, ClassList
+from formset.renderers import ButtonSize, ButtonVariant, ClassList
 from formset.renderers.default import FormRenderer as DefaultFormRenderer
 
 
@@ -39,13 +39,18 @@ def _amend_select(self, context):
         return context
 
     def _amend_button(self, context):
+        class_list = ClassList(context['widget']['attrs'].get('class'))
         variant = context['widget']['variant']
         if not isinstance(variant, ButtonVariant):
             variant = 'outline-secondary'
-        class_list = ClassList(context['widget']['attrs'].get('class'))
         class_list.add(f'btn btn-{variant}')
+        size = context['widget']['size']
+        if size is ButtonSize.SMALL:
+            class_list.add('btn-sm')
+        elif size is ButtonSize.LARGE:
+            class_list.add('btn-lg')
         context['widget']['attrs']['class'] = class_list
-        context['icon_class'] = ' me-3' if context['icon_left'] else ' ms-3'
+        context['icon_class'] = ' me-1' if context['icon_left'] else ' ms-1'
         return context
 
     def _amend_dual_selector(self, context):

formset/renderers/tailwind.py

@@ -1,4 +1,5 @@
 from formset.boundfield import ClassList
+from formset.renderers import ButtonSize, ButtonVariant, ClassList
 from formset.renderers.default import FormRenderer as DefaultFormRenderer
 
 
@@ -86,7 +87,20 @@ def _amend_radio(self, context):
         return self._amend_multiple_input(context, 'formset-radio-select')
 
     def _amend_button(self, context):
-        context['widget']['attrs']['class'] = ClassList('formset-button-default')
+        class_list = ClassList(context['widget']['attrs'].get('class'))
+        variant = context['widget']['variant']
+        if not isinstance(variant, ButtonVariant):
+            variant = 'default'
+        class_list.add(f'formset-button-{variant}')
+        size = context['widget']['size']
+        if size is ButtonSize.SMALL:
+            class_list.add('formset-button-small')
+        elif size is ButtonSize.LARGE:
+            class_list.add('formset-button-large')
+        else:
+            class_list.add('formset-button-base')
+        context['widget']['attrs']['class'] = class_list
+        context['icon_class'] = ' me-1' if context['icon_left'] else ' ms-1'
         return context
 
     def _amend_fieldset(self, context):

formset/widgets/button.py

@@ -1,5 +1,5 @@
 from django.forms.widgets import Widget
-from django.template.loader import get_template
+from django.template.loader import get_template, render_to_string
 from django.utils.functional import cached_property
 
 
@@ -8,25 +8,37 @@ class Button(Widget):
     button_type = 'button'
     action = None
     button_variant = None
+    button_size = None
     icon_path = None
+    icon_char = None
     icon_left = None
 
     def __init__(
         self,
         attrs=None,
         action=None,
         button_variant=None,
+        button_size=None,
         auto_disable=False,
+        omit_restore=False,
         icon_path=None,
+        icon_char=None,
         icon_left=False
     ):
         if action is not None:
             self.action = action
         if button_variant:
             self.button_variant = button_variant
+        if button_size:
+            self.button_size = button_size
         self.auto_disable = auto_disable
+        self.omit_restore = omit_restore
+        if icon_path and icon_char:
+            raise ValueError("Specify either icon_path or icon_char, not both.")
         if icon_path:
             self.icon_path = icon_path
+        if icon_char:
+            self.icon_char = icon_char
         self.icon_left = icon_left
         super().__init__(attrs)
 
@@ -36,20 +48,26 @@ def build_attrs(self, base_attrs, extra_attrs=None):
             attrs['df-click'] = self.action
         if self.auto_disable:
             attrs['auto-disable'] = True
+        if self.omit_restore:
+            attrs['omit-restore'] = True
         return attrs
 
     def get_context(self, name, value, attrs):
         context = super().get_context(name, value, attrs)
         context['label'] = context['widget']['attrs'].pop('label', None)  # for buttons, the label is the value
         context['widget']['type'] = self.button_type
         context['widget']['variant'] = self.button_variant
+        context['widget']['size'] = self.button_size
         context['icon_element'] = self.icon_element
         context['icon_left'] = self.icon_left
         return context
 
     @cached_property
     def icon_element(self):
-        if self.icon_path:
-            template = get_template(self.icon_path)
-            return template.render()
-        return ''
+        if self.icon_char:
+            icon = self.icon_char
+        elif self.icon_path:
+            icon = render_to_string(self.icon_path)
+        else:
+            return ''
+        return icon