Struct Button

pub struct Button { /* private fields */ }

A simple push button with a contained view.

Examples

Button with an action

A button can be used to call an action when interacted with. Usually this is an event that is being emitted when the button is pressed.

Button::new(cx, |cx| Label::new(cx, "Text"))
    .on_press(|ex| ex.emit(AppEvent::Action))

Button without an action

A button can be used without an action and therefore do nothing when pressed. This is useful for prototyping and testing out the different styling options of a button without having to add an action.

Button::new(cx, |cx| Label::new(cx, "Text"));

Button containing multiple views

A button can contain more than just a single view or label inside of it. This can for example be done by using a HStack or VStack.

Button::new(
    cx,
    |cx| {
        HStack::new(cx, |cx| {
            Label::new(cx, "Hello");
            Label::new(cx, "World");
        })
    },
);

Button Variants

The style of a button can be modified using the variant modifier from the ButtonModifiers trait by specifying the ButtonVariant.

Button::new(cx, |cx| Label::new(cx, "Text"))
    .variant(ButtonVariant::Accent);

Implementations

impl Button

pub fn new<C, V>(cx: &mut Context, content: C) -> Handle<'_, Button>

where C: FnOnce(&mut Context) -> Handle<'_, V>, V: View,

Creates a new button with specified content.

Example

Button::new(cx, |cx| Label::new(cx, "Press Me"));

Trait Implementations

impl View for Button

fn element(&self) -> Option<&'static str>

Specifies a name for the view type which can be used as an element selector in css.

fn event(&mut self, cx: &mut EventContext<'_>, event: &mut Event)

Handles any events received by the view.

fn build<F>(self, cx: &mut Context, content: F) -> Handle<'_, Self>

where F: FnOnce(&mut Context),

Builds the view into the tree and returns a handle which can be used to apply style and layout modifiers to the view.

fn draw(&self, cx: &mut DrawContext<'_>, canvas: &Canvas)

Provides custom drawing for the view.

fn accessibility(&self, cx: &mut AccessContext<'_>, node: &mut AccessNode)

Provides a way to configure the accessibility features of a view.