Struct ConnectedButtonGroup 

pub struct ConnectedButtonGroup { /* private fields */ }

Implementations

impl ConnectedButtonGroup

pub fn new(id: impl Into<ElementId>, label: impl Into<SharedString>) -> Self

pub fn selection(self, selection: GroupSelection) -> Self

Single (default), multiple or no selection.

pub fn required(self, required: bool) -> Self

Whether a single selection must keep one option selected (default, radio semantics). Optional selections are toggle buttons whose changes arrive through on_toggle.

pub fn selected_values<V: Into<SharedString>>( self, values: impl IntoIterator<Item = V>, ) -> Self

The selected values of a multiple or optional selection.

pub fn on_toggle( self, callback: impl Fn(&SharedString, bool, &mut Window, &mut App) + 'static, ) -> Self

The requested selection of one option of a toggle group (multiple, or an optional single selection).

pub fn on_activate( self, callback: impl Fn(&SharedString, &mut Window, &mut App) + 'static, ) -> Self

An activated option of a group without selection.

pub fn vertical(self, vertical: bool) -> Self

Stack the options vertically (connected top to bottom).

pub fn density(self, density: ButtonDensity) -> Self

Shorten the options by the density’s step.

pub fn equal_widths(self, equal: bool) -> Self

Give every option the widest one’s width (horizontal groups that fit their content; vertical options always share the column).

pub fn labels(self, labels: GroupLabels) -> Self

When options with icons show their labels.

pub fn variant(self, variant: ButtonVariant) -> Self

The toggle-button colors the options use: tonal by default (the kit’s connected group), or filled, elevated or outlined.

pub fn button_size(self, size: ButtonSize) -> Self

An M3 Expressive button size (XS–XL): the options take that button’s height, padding, label type and icon, and the size’s inner corners. Without it the group keeps its compact 40px default.

pub fn shape(self, shape: ButtonShape) -> Self

Round (default) or square ends: square ends of unselected options take the inner corner radius. The selected option is a full pill.

pub fn options<K: Into<SharedString>, V: Into<SharedString>>( self, options: impl IntoIterator<Item = (K, V)>, ) -> Self

The options as (value, label) pairs. Values identify an option’s focus and selection state, so they must be unique: a repeated value is a caller bug (a debug assertion), and release builds keep only its first occurrence.

pub fn selected(self, value: impl Into<SharedString>) -> Self

pub fn full_width(self) -> Self

Fill the parent’s width in equal options, each at least as wide as its label; options wrap to another row only when their labels cannot fit.

pub fn segmented(self) -> Self

Connected segments that fill the parent, with persistent option icons. Radio/tab semantics, focus navigation and pointer feedback are unchanged.

pub fn height(self, height: Rems) -> Self

Override option text for a page-specific typography role. Override the option height (48px segmented, 40px otherwise), e.g. for a page’s view tabs.

pub fn label_text_size(self, size: Rems) -> Self

pub fn tabs(self) -> Self

Navigation uses the same surfaces, with tab semantics and optional leading layout.

pub fn focus_handles( self, handles: impl IntoIterator<Item = FocusHandle>, ) -> Self

pub fn icon(self, value: impl Into<SharedString>, icon: impl Into<Icon>) -> Self

Attach an icon by option value; this may be called before or after options.

pub fn reveal_in(self, scroll: ScrollHandle) -> Self

pub fn disabled(self, disabled: bool) -> Self

pub fn preview_state( self, value: impl Into<SharedString>, state: InteractionPreview, ) -> Self

Render the option with value as a static specimen in one forced interaction state, painting what that live state paints (its hover or press layer, focus ring or disabled colors). A group with any preview is a specimen: it leaves the tab order, and its other options ignore live hover and press. See InteractionPreview.

pub fn on_change( self, callback: impl Fn(&SharedString, &mut Window, &mut App) + 'static, ) -> Self

Trait Implementations

impl IntoElement for ConnectedButtonGroup

type Element = ViewElement<ConnectedButtonGroup>

The specific type of element into which the implementing type is converted. Useful for converting other types into elements automatically, like Strings

fn into_element(self) -> Self::Element

Convert self into a type that implements [Element].

fn into_any_element(self) -> AnyElement

Convert self into a dynamically-typed [AnyElement].

impl RenderOnce for ConnectedButtonGroup

fn render(self, window: &mut Window, cx: &mut App) -> impl IntoElement

Render this component into an element tree. Note that this method takes ownership of self, as compared to [Render::render()] method which takes a mutable reference.