RadioButtonGroup#

Download this notebook from GitHub (right-click to download).


import panel as pn
import panel_material_ui as pmui

pn.extension()

The RadioButtonGroup widget allows selecting from a list or dictionary of values using a set of toggle buttons. It falls into the broad category of single-value, option-selection widgets that provide a compatible API and include the RadioBoxGroup, Select, and DiscreteSlider widgets.

Discover more on using widgets to add interactivity to your applications in the how-to guides on interactivity. Alternatively, learn how to set up callbacks and (JS-)links between parameters or how to use them as part of declarative UIs with Param.

Parameters:#

For details on other options for customizing the component see the customization guides.

Core#

  • disabled (boolean): Whether the widget is editable

  • options (list or dict): A list or dictionary of options to select from

  • value (object): The current value; must be one of the option values

Display#

  • color (str): A button theme; should be one of 'default' (white), 'primary' (blue), 'success' (green), 'info' (yellow), 'light' (light), or 'danger' (red).

  • description (str | Bokeh Tooltip | pn.widgets.TooltipIcon): A description which is shown when the widget is hovered.

  • name (str): The title of the widget

  • orientation (str, default=’horizontal’): Button group orientation, either ‘horizontal’ or ‘vertical’.

  • variant (str): The button style, either ‘solid’, ‘outlined’, ‘text’.

Styling#

  • sx (dict): Component level styling API.

  • theme_config (dict): Theming API.

Aliases#

For compatibility with Panel certain parameters are allowed as aliases:

  • button_style: Alias for variant

  • button_type: Alias for color

  • name: Alias for label


radio_group = pmui.RadioButtonGroup(
    name='Radio Button Group', options=['Biology', 'Chemistry', 'Physics'], button_type='success')

radio_group

Like most other widgets, RadioButtonGroup has a value parameter that can be accessed or set:

radio_group.value
Biology

Styles#

The color of the buttons can be set by selecting one of the available button_type values and the button_style can be 'solid' or 'outline':

pn.Column(*(
    pmui.RadioButtonGroup(
        label=color, color=color, options=['Foo', 'Bar', 'Baz'], value='Bar'
    )
    for color in pmui.Button.param.color.objects
))

Controls#

The RadioButtonGroup widget exposes a number of options which can be changed from both Python and Javascript. Try out the effect of these parameters interactively:

pn.Row(radio_group.controls(jslink=True), radio_group)

Download this notebook from GitHub (right-click to download).