Struct Button 

pub struct Button { /* private fields */ }

A clickable, focusable button. Activates on click, Enter or Space.

use std::cell::Cell;
use std::rc::Rc;
use ravenrs_widgets::{Button, ButtonStyle, IconName, Ui};

let saved = Rc::new(Cell::new(false));
let flag = saved.clone();
let button = Button::new("Save")
    .icon(IconName::Check)
    .style(ButtonStyle::Secondary)
    .on_click(move || flag.set(true));
let mut ui = Ui::new(button, ravenrs_style::Theme::raven_dark());
ui.update();

Implementations

impl Button

pub fn new(label: impl Into<String>) -> Self

A primary, medium button with this label. An empty label makes it icon-only.

pub fn accessible_name(self, name: impl Into<String>) -> Self

Sets the name screen readers announce, instead of the label. Icon-only buttons should always have one.

pub fn accessible_description(self, text: impl Into<String>) -> Self

Sets what screen readers say after its name, such as what it does. Its shortcut and whether it is busy follow.

pub fn on_click(self, handler: impl Fn() + 'static) -> Self

Runs handler when the button is clicked or activated with Enter or Space.

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

Sets the visual emphasis (Primary by default).

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

Sets the height and padding (Medium by default).

pub fn icon(self, icon: IconName) -> Self

An icon before the label.

pub fn trailing_icon(self, icon: IconName) -> Self

An icon after the label (e.g. a chevron for menus).

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

Greys the button out and ignores clicks and focus.

pub fn full_width(self) -> Self

Stretches across the parent stack.

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

Shows an animated indicator over the content, which keeps its place so that the button does not change width, and ignores clicks until it is done. It keeps keyboard focus, and screen readers hear that it is loading and unavailable.

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

Lights the button up as being on, and announces it as a button that toggles. What a click does is still up to Self::on_click.

pub fn shortcut(self, keys: impl Into<String>) -> Self

Shows a key cap after the label, in the label’s color, such as "F8". It only shows the key: BuildCx::shortcut makes the key work.

Trait Implementations

impl Debug for Button

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl View for Button

fn build(&self, cx: &mut BuildCx<'_>) -> NodeId

Creates this view’s node for the current build.

fn type_name(&self) -> &'static str

The name the diagnostics panel shows this view’s cost under.