Struct ButtonLike 

pub struct ButtonLike { /* private fields */ }

A button-like element that can be used to create a custom button when prebuilt buttons are not sufficient. Use this sparingly, as it is unconstrained and may make the UI feel less consistent.

This is also used to build the prebuilt buttons.

Implementations

impl ButtonLike

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

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

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

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

pub fn opacity(self, opacity: f32) -> Self

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

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

pub fn hoverable_tooltip( self, tooltip: impl Fn(&mut Window, &mut App) -> AnyView + 'static, ) -> Self

Trait Implementations

impl ButtonCommon for ButtonLike

fn id(&self) -> &ElementId

A unique element ID to identify the button.

fn style(self, style: ButtonStyle) -> Self

The visual style of the button.

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

The size of the button.

fn tooltip( self, tooltip: impl Fn(&mut Window, &mut App) -> AnyView + 'static, ) -> Self

The tooltip that shows when a user hovers over the button.

fn tab_index(self, tab_index: impl Into<isize>) -> Self

fn layer(self, elevation: ElevationIndex) -> Self

fn track_focus(self, focus_handle: &FocusHandle) -> Self

impl Clickable for ButtonLike

fn on_click( self, handler: impl Fn(&ClickEvent, &mut Window, &mut App) + 'static, ) -> Self

Sets the click handler that will fire whenever the element is clicked.

fn cursor_style(self, cursor_style: CursorStyle) -> Self

Sets the cursor style when hovering over the element.

impl Component for ButtonLike

fn scope() -> ComponentScope

Returns the scope of the component.

fn sort_name() -> &'static str

Returns a name that the component should be sorted by.

fn description() -> Option<&'static str>

An optional description of the component.

fn preview(_window: &mut Window, _cx: &mut App) -> Option<AnyElement>

The component’s preview.

fn id() -> ComponentId

The component’s unique identifier.

fn status() -> ComponentStatus

The ready status of this component.

fn name() -> &'static str

The name of the component.

impl Disableable for ButtonLike

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

Sets whether the element is disabled.

impl Documented for ButtonLike

const DOCS: &'static str = "A button-like element that can be used to create a custom button when\nprebuilt buttons are not sufficient. Use this sparingly, as it is\nunconstrained and may make the UI feel less consistent.\n\nThis is also used to build the prebuilt buttons."

The static doc comments on this type.

impl FixedWidth for ButtonLike

fn width(self, width: impl Into<DefiniteLength>) -> Self

Sets the width of the element.

fn full_width(self) -> Self

Sets the element’s width to the full width of its container.

impl From<ButtonLike> for SplitButtonKind

fn from(button_like: ButtonLike) -> Self

Converts to this type from the input type.

impl IntoElement for ButtonLike

type Element = Component<ButtonLike>

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 ButtonLike

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 ButtonLike

fn render(self, _: &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.

impl SelectableButton for ButtonLike

fn selected_style(self, style: ButtonStyle) -> Self

impl Toggleable for ButtonLike

fn toggle_state(self, selected: bool) -> Self

Sets whether the element is selected.

impl VisibleOnHover for ButtonLike

fn visible_on_hover(self, group_name: impl Into<SharedString>) -> Self

Sets the element to only be visible when the specified group is hovered.