Add what's new docs for button styling

QuLogic · QuLogic · commit 538a7d5071c6 · 2023-01-20T21:49:52.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,31 @@
+Custom styling of button widgets
+--------------------------------
+
+Additional custom styling of button widgets 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(nrows=2, ncols=2, figsize=(5, 2), width_ratios=[1, 2])
+   default_rb = RadioButtons(ax[0, 0], ['Apples', 'Oranges'])
+   styled_rb = RadioButtons(ax[0, 1], ['Apples', 'Oranges'],
+                            label_props={'color': ['red', 'orange'],
+                                         'fontsize': [16, 20]},
+                            radio_props={'edgecolor': ['red', 'orange'],
+                                         'facecolor': ['mistyrose', 'peachpuff']})
+
+   default_cb = CheckButtons(ax[1, 0], ['Apples', 'Oranges'],
+                             actives=[True, True])
+   styled_cb = CheckButtons(ax[1, 1], ['Apples', 'Oranges'],
+                            actives=[True, True],
+                            label_props={'color': ['red', 'orange'],
+                                         'fontsize': [16, 20]},
+                            frame_props={'edgecolor': ['red', 'orange'],
+                                         'facecolor': ['mistyrose', 'peachpuff']},
+                            check_props={'color': ['darkred', 'darkorange']})
+
+   ax[0, 0].set_title('Default')
+   ax[0, 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 (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 (label font size / 2)**2 size,
             black color, and 1.0 linewidth.
+
+            .. versionadded:: 3.7
         """
         super().__init__(ax)
 
@@ -1120,6 +1126,8 @@ def set_label_props(self, props):
         """
         Set properties of the `.Text` labels.
 
+        .. versionadded:: 3.7
+
         Parameters
         ----------
         props : dict
@@ -1134,6 +1142,8 @@ def set_frame_props(self, props):
         """
         Set properties of the check button frames.
 
+        .. versionadded:: 3.7
+
         Parameters
         ----------
         props : dict
@@ -1149,6 +1159,8 @@ def set_check_props(self, props):
         """
         Set properties of the check button checks.
 
+        .. versionadded:: 3.7
+
         Parameters
         ----------
         props : dict
@@ -1608,6 +1620,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 (label font size / 2)**2 size, black
@@ -1617,6 +1631,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)
 
@@ -1718,6 +1734,8 @@ def set_label_props(self, props):
         """
         Set properties of the `.Text` labels.
 
+        .. versionadded:: 3.7
+
         Parameters
         ----------
         props : dict
@@ -1732,6 +1750,8 @@ def set_radio_props(self, props):
         """
         Set properties of the `.Text` labels.
 
+        .. versionadded:: 3.7
+
         Parameters
         ----------
         props : dict
