Radio Group

A set of options where exactly one can be selected.

EXAMPLEwasm · webgpu

This demo runs the real GPUI component on WebGPU, which this browser does not expose.

Try Chrome or Edge 113+, or Safari 26+. In Firefox, enable dom.webgpu.enabled.

You can also run it natively: cargo run -p showcase radio-group

The demo failed to start in this browser.

You can run it natively instead: cargo run -p showcase radio-group

Live examples are not supported on most mobile browsers yet — open this page on a desktop or tablet to run the demo.

Recent phones with WebGPU may manage it (downloads ~18 MB):

#Anatomy

Import the component's parts and compose them under its root:

use base_gpui::radio_group::{
    RadioGroupIndicator,
    RadioGroupRadio,
    RadioGroupRoot,
};

RadioGroupRoot::new()
    .child(
        RadioGroupRadio::new()
                .child(
                    RadioGroupIndicator::new(),
                ),
    );
The anatomy is a structural overview. Parts with mutually exclusive modes may need separate instances; each part's section below documents its configuration.

#RadioGroupRoot

Coordinates the component's state and supplies context to its child parts.

Source

use base_gpui::radio_group::RadioGroupRoot;

RadioGroupRoot::new()
    .id("example-id")
    .name("name")
    .form(/* form: impl Into<SharedString> */)
    .default_value(None)
    .value(None)
    .disabled(true)
    .read_only(true)
    .required(true)
    .aria_label("aria label")
    .on_value_change(|/* callback arguments */| { /* handle change */ })
    .style_with_state(|/* callback arguments */| { /* handle change */ });

#Builders

BuilderSignature & description
.newpub fn new() -> Self

Creates a RadioGroupRoot with its default configuration.

.childpub fn child(mut self, child: impl Into<RadioGroupChild<T>>) -> Self
  • child: impl Into<RadioGroupChild<T>>

Adds one typed child to this part.

.childrenpub fn children(mut self, children: impl IntoIterator<Item = impl Into<RadioGroupChild<T>>>,) -> Self
  • children: impl IntoIterator<Item = impl Into<RadioGroupChild<T>>>

Adds multiple typed children in iteration order.

.idpub fn id(mut self, id: impl Into<ElementId>) -> Self
  • id: impl Into<ElementId>

Sets the stable GPUI element identity. Use a unique value when multiple instances can appear in the same view.

.namepub fn name(mut self, name: impl Into<SharedString>) -> Self
  • name: impl Into<SharedString>

Sets the form field name used when serializing or submitting the value.

.formpub fn form(mut self, form: impl Into<SharedString>) -> Self
  • form: impl Into<SharedString>

Sets the form configuration for this part.

.default_valuepub fn default_value(mut self, default_value: Option<T>) -> Self
  • default_value: Option<T>

Sets the initial value for uncontrolled state. Later user changes are retained by the component.

.valuepub fn value(mut self, value: Option<T>) -> Self
  • value: Option<T>

Sets the current controlled value or the value represented by this part, depending on the part's role.

.disabledpub fn disabled(mut self, disabled: bool) -> Self
  • disabled: bool

When true, prevents user interaction with this part.

.read_onlypub fn read_only(mut self, read_only: bool) -> Self
  • read_only: bool

When true, allows presentation and focus behavior without permitting value changes.

.requiredpub fn required(mut self, required: bool) -> Self
  • required: bool

Marks the control as required for validation and accessibility state.

.aria_labelpub fn aria_label(mut self, aria_label: impl Into<SharedString>) -> Self
  • aria_label: impl Into<SharedString>

Sets the accessible label announced by screen readers. This is the literal-string substitute for Base UI's aria-labelledby id wiring, which has no gpui builder. When set, render the group's visible label text with Text::new_inaccessible(...) instead of text!(...) so the label is not announced twice.

.on_value_changepub fn on_value_change(mut self, on_value_change: impl Fn(Option<&T>, &mut RadioGroupValueChangeDetails, &mut Window, &mut App) + 'static,) -> Self
  • on_value_change: impl Fn(Option<&T>, &mut RadioGroupValueChangeDetails, &mut Window, &mut App) + 'static

Registers a callback invoked when value change occurs.

.style_with_statepub fn style_with_state(mut self, style: impl Fn(RadioGroupRootStyleState, Div) -> Div + 'static,) -> Self
  • style: impl Fn(RadioGroupRootStyleState, Div) -> Div + 'static,

Styles the part from its current behavioral state while preserving separation between behavior and visual design.

RadioGroupRoot also supports the GPUI traits implemented in its source, such as standard styling or child composition.

#RadioGroupIndicator

Visual representation of the component's current state or value.

Source

use base_gpui::radio_group::RadioGroupIndicator;

RadioGroupIndicator::new()
    .keep_mounted(true)
    .style_with_state(|/* callback arguments */| { /* handle change */ });

#Builders

BuilderSignature & description
.newpub fn new() -> Self

Creates a RadioGroupIndicator with its default configuration.

.keep_mountedpub fn keep_mounted(mut self, keep_mounted: bool) -> Self
  • keep_mounted: bool

Keeps the part mounted when inactive or closed so child state can be preserved.

.style_with_statepub fn style_with_state(mut self, style: impl Fn(RadioGroupIndicatorStyleState, Div) -> Div + 'static,) -> Self
  • style: impl Fn(RadioGroupIndicatorStyleState, Div) -> Div + 'static,

Styles the part from its current behavioral state while preserving separation between behavior and visual design.

RadioGroupIndicator also supports the GPUI traits implemented in its source, such as standard styling or child composition.

#RadioGroupRadio

Public renderable part of the Radio Group Radio component.

Source

use base_gpui::radio_group::RadioGroupRadio;

RadioGroupRadio::new()
    .id("example-id")
    .value(/* value: T */)
    .disabled(true)
    .read_only(true)
    .required(true)
    .aria_label("aria label")
    .style_with_state(|/* callback arguments */| { /* handle change */ });

#Builders

BuilderSignature & description
.newpub fn new() -> Self

Creates a RadioGroupRadio with its default configuration.

.childpub fn child(mut self, child: impl Into<RadioGroupRadioChild>) -> Self
  • child: impl Into<RadioGroupRadioChild>

Adds one typed child to this part.

.childrenpub fn children(mut self, children: impl IntoIterator<Item = impl Into<RadioGroupRadioChild>>,) -> Self
  • children: impl IntoIterator<Item = impl Into<RadioGroupRadioChild>>

Adds multiple typed children in iteration order.

.idpub fn id(mut self, id: impl Into<ElementId>) -> Self
  • id: impl Into<ElementId>

Sets the stable GPUI element identity. Use a unique value when multiple instances can appear in the same view.

.valuepub fn value(mut self, value: T) -> Self
  • value: T

Sets the current controlled value or the value represented by this part, depending on the part's role.

.disabledpub fn disabled(mut self, disabled: bool) -> Self
  • disabled: bool

When true, prevents user interaction with this part.

.read_onlypub fn read_only(mut self, read_only: bool) -> Self
  • read_only: bool

When true, allows presentation and focus behavior without permitting value changes.

.requiredpub fn required(mut self, required: bool) -> Self
  • required: bool

Marks the control as required for validation and accessibility state.

.aria_labelpub fn aria_label(mut self, aria_label: impl Into<SharedString>) -> Self
  • aria_label: impl Into<SharedString>

Sets the accessible label announced by screen readers. This is the literal-string substitute for Base UI's aria-labelledby id wiring, which has no gpui builder. When set, render the radio's visible label text with Text::new_inaccessible(...) instead of text!(...) so the label is not announced twice.

.style_with_statepub fn style_with_state(mut self, style: impl Fn(RadioGroupRadioStyleState, Div) -> Div + 'static,) -> Self
  • style: impl Fn(RadioGroupRadioStyleState, Div) -> Div + 'static,

Styles the part from its current behavioral state while preserving separation between behavior and visual design.

RadioGroupRadio also supports the GPUI traits implemented in its source, such as standard styling or child composition.

#Accessibility

Keyboard interaction and accessibility semantics are implemented by the component, independently of visual styling. Known limitations caused by missing GPUI accessibility primitives are documented in the module source and are not silently approximated.

#Stability

Base GPUI is pre-1.0. Builder names and state types may evolve as GPUI and this port mature.