Add docs custom send button label & icon optional keyword args

Author: plocket

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2023 Suffolk Legal Innovation and Technology Lab
+Copyright (c) 2025 Suffolk Legal Innovation and Technology Lab
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

docassemble/AssemblyLine/al_document.py

@@ -1936,6 +1936,8 @@ def download_list_html(
         view_icon: str = "eye",
         download_label: str = "Download",
         download_icon: str = "download",
+        send_label: str = "Send",
+        send_icon: str = "envelope",
         zip_label: Optional[str] = None,
         zip_icon: str = "file-archive",
         append_matching_suffix: bool = True,
@@ -1958,10 +1960,12 @@ def download_list_html(
             view_icon (str): Icon for the 'view' button, default is "eye".
             download_label (str): Label for the 'download' button, default is "Download".
             download_icon (str): Icon for the 'download' button, default is "download".
+            send_label (str): Label for the 'send' button. Default is "Send".
+            send_icon (str): Fontawesome icon for the 'send' button. Default is "envelope".
             zip_label (Optional[str]): Label for the zip option. If not provided, uses the generic template for `self.zip_label` ("Download all").
             zip_icon (str): Icon for the zip option, default is "file-archive".
             append_matching_suffix (bool): Flag to determine if matching suffix should be appended to file name, default is True.
-            include_email (bool): Flag to include an email option, default is False.
+            include_email (bool): Flag to include an option, default is False.
             use_previously_cached_files (bool): Flag to use previously cached files (e.g., made in background) if defined. default is False.
             include_full_pdf (bool): Flag to include a full PDF option, default is False.
             full_pdf_label (Optional[str]): Label for the full PDF option. If not provided, uses the generic template for `self.full_pdf_label` ("Download all").
@@ -2071,7 +2075,7 @@ def download_list_html(
             html += table_row(full_pdf_label, full_pdf_button)
 
         if include_email:
-            html += self.send_email_table_row(key=key)
+            html += self.send_email_table_row(key=key, send_label=send_label, send_icon=send_icon)
 
         html += "\n</div>"
 
@@ -2150,13 +2154,15 @@ def download_html(
 
         return html
 
-    def send_email_table_row(self, key: str = "final") -> str:
+    def send_email_table_row(self, key: str = "final", send_label: str = "Send", send_icon: str = "envelope") -> str:
         """
         Generate HTML doc table row for an input box and button that allows
         someone to send the bundle to the specified email address.
 
         Args:
             key (str): A key used to identify which version of the ALDocument to send. Defaults to "final".
+            send_label (str): Label for the 'send' button. Default is "Send".
+            send_icon (str): Icon for the 'send' button. Default is "envelope".
 
         Returns:
             str: The generated HTML string for the table row.
@@ -2189,7 +2195,7 @@ def send_email_table_row(self, key: str = "final") -> str:
         """
 
         # "Send" button for the 2nd column of the table row
-        send_button = f'{action_button_html(javascript_string, label="Send", icon="envelope", color="primary", size="md", classname="al_send_email_button al_button", id_tag=al_send_button_id)}'
+        send_button = f'{action_button_html(javascript_string, label=send_label, icon=send_icon, color="primary", size="md", classname="al_send_email_button al_button", id_tag=al_send_button_id)}'
 
         # Whole row put together
         html = f"""
@@ -2206,8 +2212,10 @@ def send_button_to_html(
         email: str,
         editable: bool = False,
         template_name: str = "",
-        label: str = "Send",
-        icon: str = "envelope",
+        label: Optional[str] = None,
+        send_label: str = "Send",
+        icon: Optional[str] = None,
+        send_icon: str = "envelope",
         color: str = "primary",
         key: str = "final",
     ) -> str:
@@ -2220,14 +2228,23 @@ def send_button_to_html(
             email (str): The recipient's email address.
             editable (bool, optional): Flag indicating if the bundle is editable. Defaults to False.
             template_name (str, optional): The name of the template to be used. Defaults to an empty string.
-            label (str, optional): The label for the button. Defaults to "Send".
-            icon (str, optional): The Fontawesome icon for the button. Defaults to "envelope".
+            label (Optional[str]): The label for the send button. Defaults to
+                `send_label`.
+            send_label (str): Alias for `label`. Matches other methods.
+                Defaults to "Send".
+            icon (Optional[str]): The Fontawesome icon for the send button.
+                Defaults to `send_icon`.
+            send_icon (str): Alias for `icon`. Matches other methods. Defaults
+                to "envelope".
             color (str, optional): The Bootstrap color of the button. Defaults to "primary".
             key (str, optional): A key used to identify which version of the ALDocument to send. Defaults to "final".
 
         Returns:
             str: The generated HTML string for the button.
         """
+        label = label or send_label
+        icon = icon or send_icon
+      
         if not self.has_enabled_documents():
             return ""  # Don't let people email an empty set of documents
         if not hasattr(self, "_cached_get_email_copy"):
@@ -2261,6 +2278,10 @@ def send_button_html(
         key: str = "final",
         show_editable_checkbox: bool = True,
         template_name: str = "",
+        label: Optional[str] = None,
+        send_label: str = "Send",
+        icon: Optional[str] = None,
+        send_icon: str = "envelope",
     ) -> str:
         """
         Generate HTML for an input box and button that allows someone to send the bundle
@@ -2276,10 +2297,21 @@ def send_button_html(
                 Defaults to True.
             template_name (str, optional): Name of the template variable that is used to fill
                 the email contents. By default, the `x.send_email_template` template will be used.
+            label (str, optional): The label for the send button. Defaults to
+                `send_label`. Matches other methods.
+            send_label (str): Alias for `label`. Matches other methods.
+                Defaults to "Send".
+            icon (str, optional): The Fontawesome icon for the send button.
+                Defaults to `send_icon`. Matches other methods.
+            send_icon (str): Alias for `icon`. Matches other methods. Defaults
+                to "envelope".
 
         Returns:
             str: The generated HTML string for the input box and button.
         """
+        label = label or send_label
+        icon = icon or send_icon
+      
         if not self.has_enabled_documents():
             return ""  # Don't let people email an empty set of documents
         if not hasattr(self, "_cached_get_email_copy"):
@@ -2327,7 +2359,7 @@ def send_button_html(
       <input value="{user_info().email if user_logged_in() else ''}" alt="Email address for document" class="form-control" type="email" size="35" name="{al_email_input_id}" id="{al_email_input_id}">
     </span>
     
-    {action_button_html(javascript_string, label="Send", icon="envelope", color="primary", size="md", classname="al_send_email_button", id_tag=al_send_button_id)}
+    {action_button_html(javascript_string, label=label, icon=icon, color="primary", size="md", classname="al_send_email_button", id_tag=al_send_button_id)}
 
   </div>
   """

docassemble/AssemblyLine/data/questions/test_aldocument.yml

@@ -214,11 +214,14 @@ comment: |
     format:str='pdf',
     view:bool=True,
     refresh:bool=True,
-    include_zip:bool = True,
-    view_label="View",
+    include_zip:bool=True,
+    view_label:str="View",
     view_icon:str="eye",
     download_label:str="Download",
     download_icon:str="download",
+    include_email:bool=False,
+    send_label:str="Send",
+    send_icon:str="envelope",
     zip_label:str="Download zip",
     zip_icon:str="file-archive"
 id: download_list_html_custom_1
@@ -231,21 +234,21 @@ subquestion: |
   - Keep "view" as True
   - Keep "include_zip" as True
   
-  multi_bundle_1.download_list_html( key="test_key", format="docx", refresh=False, view_label="Custom view label", view_icon="circle", download_label="Custom download label", download_icon="square", zip_label="Custom zip label", zip_icon="clock" )
+  multi_bundle_1.download_list_html( key="test_key", format="docx", refresh=False, view_label="Custom view label", view_icon="circle", download_label="Custom download label", download_icon="square", include_email=True, send_label="Custom send label", send_icon="search", zip_label="Custom zip label", zip_icon="clock" )
   
-  ${ multi_bundle_1.download_list_html( key="test_key", format="docx", refresh=False, view_label="Custom view label", view_icon="circle", download_label="Custom download label", download_icon="square", zip_label="Custom zip label", zip_icon="clock" ) }
+  ${ multi_bundle_1.download_list_html( key="test_key", format="docx", refresh=False, view_label="Custom view label", view_icon="circle", download_label="Custom download label", download_icon="square", include_email=True, send_label="Custom send label", send_icon="search", zip_label="Custom zip label", zip_icon="clock" ) }
   
   ---
   
-  single_pdf_bundle_1.download_list_html( key="test_key", format="docx", refresh=False, view_label="Custom view label", view_icon="circle", download_label="Custom download label", download_icon="square", zip_label="Custom zip label", zip_icon="clock" )
+  single_pdf_bundle_1.download_list_html( key="test_key", format="docx", refresh=False, view_label="Custom view label", view_icon="circle", download_label="Custom download label", download_icon="square", include_email=True, send_label="Custom send label", send_icon="search", zip_label="Custom zip label", zip_icon="clock" )
   
-  ${ single_pdf_bundle_1.download_list_html( key="test_key", format="docx", refresh=False, view_label="Custom view label", view_icon="circle", download_label="Custom download label", download_icon="square", zip_label="Custom zip label", zip_icon="clock" ) }
+  ${ single_pdf_bundle_1.download_list_html( key="test_key", format="docx", refresh=False, view_label="Custom view label", view_icon="circle", download_label="Custom download label", download_icon="square", include_email=True, send_label="Custom send label", send_icon="search", zip_label="Custom zip label", zip_icon="clock" ) }
   
   ---
   
-  single_docx_bundle_1.download_list_html( key="test_key", format="docx", refresh=False, view_label="Custom view label", view_icon="circle", download_label="Custom download label", download_icon="square", zip_label="Custom zip label", zip_icon="clock" )
+  single_docx_bundle_1.download_list_html( key="test_key", format="docx", refresh=False, view_label="Custom view label", view_icon="circle", download_label="Custom download label", download_icon="square", include_email=True, send_label="Custom send label", send_icon="search", zip_label="Custom zip label", zip_icon="clock" )
   
-  ${ single_docx_bundle_1.download_list_html( key="test_key", format="docx", refresh=False, view_label="Custom view label", view_icon="circle", download_label="Custom download label", download_icon="square", zip_label="Custom zip label", zip_icon="clock" ) }
+  ${ single_docx_bundle_1.download_list_html( key="test_key", format="docx", refresh=False, view_label="Custom view label", view_icon="circle", download_label="Custom download label", download_icon="square", include_email=True, send_label="Custom send label", send_icon="search", zip_label="Custom zip label", zip_icon="clock" ) }
   
   ---
 ---
@@ -329,21 +332,45 @@ subquestion: |
 id: email_custom
 continue button field: email_custom
 question: |
-  send_button_html() with custom args
+  send_button_html() and send_button_to_html() with custom args
 subquestion: |
-  multi_bundle_1.send_button_html( key="test_key", show_editable_checkbox=False )
+  ##### send_button_html()
+
+  Send button which allows the user to edit the email address.
+  
+  multi_bundle_1.send_button_html( key="test_key", show_editable_checkbox=False, label="Custom send label", icon="search" )
+  
+  ${ multi_bundle_1.send_button_html( key="test_key", show_editable_checkbox=False, label="Custom send label", icon="search" ) }
+  
+  ---
+  single_pdf_bundle_1.send_button_html( key="test_key", show_editable_checkbox=False, label="Custom send label", icon="search" )
+  
+  ${ single_pdf_bundle_1.send_button_html( key="test_key", show_editable_checkbox=False, label="Custom send label", icon="search" ) }
+  
+  ---
+  single_docx_bundle_1.send_button_html( key="test_key", show_editable_checkbox=False, label="Custom send label", icon="search" )
+  
+  ${ single_docx_bundle_1.send_button_html( key="test_key", show_editable_checkbox=False, label="Custom send label", icon="search" ) }
+  
+  ---
+
+  ##### send_button_to_html()
+
+  Send button that hides the recipient's email address.
+  
+  multi_bundle_1.send_button_to_html( "happy_feet@example.com", key="test_key", label="Custom send label", icon="search" )
   
-  ${ multi_bundle_1.send_button_html( key="test_key", show_editable_checkbox=False ) }
+  ${ multi_bundle_1.send_button_to_html( "happy_feet@example.com", key="test_key", label="Custom send label", icon="search" ) }
   
   ---
-  single_pdf_bundle_1.send_button_html( key="test_key", show_editable_checkbox=False )
+  single_pdf_bundle_1.send_button_to_html( "happy_feet@example.com", key="test_key", label="Custom send label", icon="search" )
   
-  ${ single_pdf_bundle_1.send_button_html( key="test_key", show_editable_checkbox=False ) }
+  ${ single_pdf_bundle_1.send_button_to_html( "happy_feet@example.com", key="test_key", label="Custom send label", icon="search" ) }
   
   ---
-  single_docx_bundle_1.send_button_html( key="test_key", show_editable_checkbox=False )
+  single_docx_bundle_1.send_button_to_html( "happy_feet@example.com", key="test_key", label="Custom send label", icon="search" )
   
-  ${ single_docx_bundle_1.send_button_html( key="test_key", show_editable_checkbox=False ) }
+  ${ single_docx_bundle_1.send_button_to_html( "happy_feet@example.com", key="test_key", label="Custom send label", icon="search" ) }
   
   ---
 ---

setup.py

@@ -1,6 +1,6 @@
 import os
 import sys
-from setuptools import setup, find_packages
+from setuptools import setup, find_namespace_packages
 from fnmatch import fnmatchcase
 from distutils.util import convert_path
 
@@ -52,9 +52,8 @@ def find_package_data(where='.', package='', exclude=standard_exclude, exclude_d
       author_email='qsteenhuis@suffolk.edu',
       license='The MIT License (MIT)',
       url='https://courtformsonline.org',
-      packages=find_packages(),
-      namespace_packages=['docassemble'],
-      install_requires=['docassemble.ALToolbox>=0.8.3', 'docassemble.GithubFeedbackForm>=0.2.1'],
+      packages=find_namespace_packages(),
+      install_requires=['docassemble.ALToolbox>=0.11.1', 'docassemble.GithubFeedbackForm>=0.4.1.1'],
       zip_safe=False,
       package_data=find_package_data(where='docassemble/AssemblyLine/', package='docassemble.AssemblyLine'),
      )