Struct ToggleButton 

pub struct ToggleButton { /* private fields */ }

Implementations

impl ToggleButton

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

Overrides the selection key, which otherwise mirrors the element id.

pub fn selection_key(&self) -> SharedString

The member’s key inside a ToggleButtonGroup.

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

pub fn content( self, render: impl Fn(InteractiveState) -> AnyElement + 'static, ) -> Self

v3’s render function for the button’s children, handed isHovered, isPressed, isFocused, isFocusVisible and isSelected. The hover and the press are a frame behind the pointer – gpui reports both to a handler, not to the render that draws them.

pub fn label(self, l: impl Into<SharedString>) -> Self

pub fn variant(self, v: ToggleVariant) -> Self

pub fn size(self, s: Size) -> Self

pub fn hover_bg(self, color: impl Into<Hsla>) -> Self

The fill the hover fade eases to, in place of the variant’s hover colour. The fade runs from the resting background — the sx background when one is set, the variant’s resting colour otherwise — so this is the Button contract, on a toggle. v3 has no such prop.

pub fn radius(self, radius: impl Into<Pixels>) -> Self

The corner radius, in place of the owning control_radius helper. Group edges, the hover fade and the press scale still apply. Not a v3 prop; the removed v2 radius prop is prohibited and this is a per-component repository extension.

pub fn sx(self, style: impl FnOnce(Div) -> Div) -> Self

The one slot for caller-owned low-level styling: GPUI’s styling methods (bg, text_color, w, h, p, rounded, border_color, …) applied to the button’s root element after every value the variant, the size and the active theme chose, so they win.

pub fn is_selected(self, v: bool) -> Self

pub fn default_selected(self, v: bool) -> Self

defaultSelected — the uncontrolled initial state.

Only consulted when isSelected is not supplied; the button then owns the state and toggles itself. A group always drives selection, so this is for a standalone toggle.

pub fn is_icon_only(self, v: bool) -> Self

pub fn is_disabled(self, v: bool) -> Self

pub fn child(self, el: impl IntoElement) -> Self

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

onChange — reports the selection the press moves to.

Fires alongside ToggleButton::on_press; use whichever shape suits.

pub fn on_press( self, f: impl Fn(&ClickEvent, &mut Window, &mut App) + 'static, ) -> Self

Trait Implementations

impl IntoElement for ToggleButton

type Element = ViewElement<ToggleButton>

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 ParentElement for ToggleButton

fn extend(&mut self, elements: impl IntoIterator<Item = AnyElement>)

Extend this element’s children with the given child elements.

fn child(self, child: impl IntoElement) -> Self

where Self: Sized,

Add a single child element to this element.

fn children(self, children: impl IntoIterator<Item = impl IntoElement>) -> Self

where Self: Sized,

Add multiple child elements to this element.

impl RenderOnce for ToggleButton

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.