Struct Button 

pub struct Button { /* private fields */ }

A clickable button widget

Implementations

impl Button

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

Create a new button with a label

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

Set an icon to display before the label

Example

use revue::prelude::*;

let btn = Button::new("Save")
    .icon('💾')
    .variant(ButtonVariant::Primary);

// Using Nerd Font icons
let btn = Button::new("Settings")
    .icon('\u{f013}');  // Gear icon

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

Create a primary button

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

Create a danger button

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

Create a ghost button

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

Create a success button

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

Set button variant

pub fn width(self, width: u16) -> Self

Set minimum width

pub fn handle_key(&mut self, key: &Key) -> bool

Handle key input, returns true if button was “clicked”

pub fn handle_mouse(&mut self, event: &MouseEvent, area: Rect) -> (bool, bool)

Handle mouse input, returns (needs_render, was_clicked)

The area parameter should be the button’s rendered area.

Example

let (needs_render, clicked) = button.handle_mouse(&mouse, button_area);
if clicked {
    // Button was clicked
}

pub fn is_pressed(&self) -> bool

Check if button is pressed

pub fn is_hovered(&self) -> bool

Check if button is hovered

impl Button

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

Set focused state

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

Set disabled state

pub fn fg(self, color: Color) -> Self

Set foreground color

pub fn bg(self, color: Color) -> Self

Set background color

pub fn is_focused(&self) -> bool

Check if widget is focused

pub fn is_disabled(&self) -> bool

Check if widget is disabled

pub fn set_focused(&mut self, focused: bool)

Set focused state (mutable)

impl Button

pub fn element_id(self, id: impl Into<String>) -> Self

Set element ID for CSS selector (#id)

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

Add a CSS class

pub fn classes<I, S>(self, classes: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Add multiple CSS classes

Trait Implementations

impl Clone for Button

fn clone(&self) -> Button

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Button

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

Formats the value using the given formatter.

impl Default for Button

fn default() -> Self

Returns the “default value” for a type.

impl Interactive for Button

fn handle_key(&mut self, event: &KeyEvent) -> EventResult

Handle keyboard event

fn handle_mouse(&mut self, event: &MouseEvent, area: Rect) -> EventResult

Handle mouse event

fn focusable(&self) -> bool

Check if the widget can receive focus

fn on_focus(&mut self)

Called when the widget receives focus

fn on_blur(&mut self)

Called when the widget loses focus

impl StyledView for Button

fn set_id(&mut self, id: impl Into<String>)

Set element ID

fn add_class(&mut self, class: impl Into<String>)

Add a CSS class

fn remove_class(&mut self, class: &str)

Remove a CSS class

fn toggle_class(&mut self, class: &str)

Toggle a CSS class

fn has_class(&self, class: &str) -> bool

Check if has class

impl View for Button

fn render(&self, ctx: &mut RenderContext<'_>)

Render the view

fn id(&self) -> Option<&str>

Get element ID (for CSS #id selectors)

fn classes(&self) -> &[String]

Get CSS classes (for CSS .class selectors)

fn meta(&self) -> WidgetMeta

Get widget metadata for DOM

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

Get widget type name (for CSS type selectors)

fn children(&self) -> &[Box<dyn View>]

Get child views (for container widgets)