Add what's new focs for button styling

QuLogic · QuLogic · commit 882a32ba69e9 · 2023-01-19T14:48:35.000-05:00
diff --git a/doc/users/next_whats_new/widget_button_styling.rst b/doc/users/next_whats_new/widget_button_styling.rst
@@ -0,0 +1,32 @@
+Custom styling of Button widgets
+--------------------------------
+
+Additional custom styling of button widget may be achieved via the
+*label_props* and *radio_props* arguments to `.RadioButtons`; and the
+*label_props*, *frame_props*, and *check_props* arguments to `.CheckButtons`.
+
+.. plot::
+
+   from matplotlib.widgets import CheckButtons, RadioButtons
+
+   fig, ax = plt.subplots(1, 2, figsize=(5, 1), width_ratios=[1, 2])
+   default = RadioButtons(ax[0], ['Apples', 'Oranges'])
+   ax[0].set_title('Default')
+   styled = RadioButtons(ax[1], ['Apples', 'Oranges'],
+                         label_props={'color': ['red', 'orange'],
+                                      'fontsize': [20, 24]},
+                         radio_props={'edgecolor': ['red', 'orange'],
+                                      'facecolor': ['darkred', 'darkorange']})
+   ax[1].set_title('Stylized')
+
+   fig, ax = plt.subplots(1, 2, figsize=(5, 1), width_ratios=[1, 2])
+   default = CheckButtons(ax[0], ['Apples', 'Oranges'],
+                          actives=[True, True])
+   ax[0].set_title('Default')
+   styled = CheckButtons(ax[1], ['Apples', 'Oranges'],
+                         actives=[True, True],
+                         label_props={'color': ['red', 'orange'],
+                                      'fontsize': [20, 24]},
+                         frame_props={'color': ['red', 'orange']},
+                         check_props={'color': ['darkred', 'darkorange']})
+   ax[1].set_title('Stylized')
diff --git a/lib/matplotlib/widgets.py b/lib/matplotlib/widgets.py
@@ -1015,14 +1015,20 @@ def __init__(self, ax, labels, actives=None, *, useblit=True,
             See the tutorial :doc:`/tutorials/advanced/blitting` for details.
         label_props : dict, optional
             Dictionary of `.Text` properties to be used for the labels.
+
+            .. versionadded:: 3.7
         frame_props : dict, optional
             Dictionary of scatter `.Collection` properties to be used for the
             check button frame. Defaults to 's' marker, (label font size /
             2)**2 size, black edgecolor, no facecolor, and 1.0 linewidth.
+
+            .. versionadded:: 3.7
         check_props : dict, optional
             Dictionary of scatter `.Collection` properties to be used for the
             check button check. Defaults to 'x' marker, (label font size /
             2)**2 size, black color, and 1.0 linewidth.
+
+            .. versionadded:: 3.7
         """
         super().__init__(ax)
 
@@ -1114,6 +1120,8 @@ def set_label_props(self, props):
         """
         Set properties of the `.Text` labels.
 
+        .. versionadded:: 3.7
+
         Parameters
         ----------
         props : dict
@@ -1128,6 +1136,8 @@ def set_frame_props(self, props):
         """
         Set properties of the check button frames.
 
+        .. versionadded:: 3.7
+
         Parameters
         ----------
         props : dict
@@ -1143,6 +1153,8 @@ def set_check_props(self, props):
         """
         Set properties of the check button checks.
 
+        .. versionadded:: 3.7
+
         Parameters
         ----------
         props : dict
@@ -1617,6 +1629,8 @@ def __init__(self, ax, labels, active=0, activecolor=None, *,
             See the tutorial :doc:`/tutorials/advanced/blitting` for details.
         label_props : dict or list of dict, optional
             Dictionary of `.Text` properties to be used for the labels.
+
+            .. versionadded:: 3.7
         radio_props : dict, optional
             Dictionary of scatter `.Collection` properties to be used for the
             radio buttons. Defaults to 'o' marker, (label font size / 2)**2
@@ -1626,6 +1640,8 @@ def __init__(self, ax, labels, active=0, activecolor=None, *,
                 If a facecolor is supplied in *radio_props*, it will override
                 *activecolor*. This may be used to provide an active color per
                 button.
+
+            .. versionadded:: 3.7
         """
         super().__init__(ax)
 
@@ -1726,6 +1742,8 @@ def set_label_props(self, props):
         """
         Set properties of the `.Text` labels.
 
+        .. versionadded:: 3.7
+
         Parameters
         ----------
         props : dict
@@ -1740,6 +1758,8 @@ def set_radio_props(self, props):
         """
         Set properties of the `.Text` labels.
 
+        .. versionadded:: 3.7
+
         Parameters
         ----------
         props : dict
