Struct Button 

pub struct Button { /* private fields */ }

A clickable button widget for the UI

Implementations

impl Button

pub fn hover_style(self, style: Style) -> Self

Sets the hover style for the button.

Arguments

• style - The style to apply when the button is hovered

Returns

self for method chaining

Example

use ratatui::style::{Color, Style};
use ratatui_toolkit::Button;

let button = Button::new("Click Me")
    .hover_style(Style::default().fg(Color::Yellow));

impl Button

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

Creates a new button with the specified text.

Arguments

• text - The button text to display

Returns

A new Button instance with default styling

Example

use ratatui_toolkit::Button;

let button = Button::new("Click Me");

impl Button

pub fn normal_style(self, style: Style) -> Self

Sets the normal (non-hovered) style for the button.

Arguments

• style - The style to apply when the button is not hovered

Returns

self for method chaining

Example

use ratatui::style::{Color, Style};
use ratatui_toolkit::Button;

let button = Button::new("Click Me")
    .normal_style(Style::default().fg(Color::White));

impl Button

pub fn area(&self) -> Option<Rect>

Returns the area where the button was rendered, if rendered.

Returns

Some(area) if the button has been rendered, None otherwise

impl Button

pub fn hover(&self) -> Style

Returns the hover style.

Returns

The style applied when the button is hovered

impl Button

pub fn hovered(&self) -> bool

Returns whether the button is currently hovered.

Returns

true if the button is being hovered, false otherwise

impl Button

pub fn is_clicked(&self, column: u16, row: u16) -> bool

Checks if a click at the given coordinates is within the button’s area.

Arguments

• column - The column (x) coordinate
• row - The row (y) coordinate

Returns

true if the coordinates are within the button’s area, false otherwise

Note

Returns false if the button has not been rendered yet (no area set)

impl Button

pub fn normal(&self) -> Style

Returns the normal (non-hovered) style.

Returns

The style applied when the button is not hovered

impl Button

pub fn render_at_offset( &self, panel_area: Rect, offset_from_right: u16, ) -> (Span<'static>, Rect)

Renders the button at a specified offset from the right edge.

Arguments

• panel_area - The area where the button will be rendered
• offset_from_right - Distance from the right edge of the panel

Returns

A tuple containing the styled span and the rendered area

impl Button

pub fn render_with_title( &mut self, panel_area: Rect, title: &str, ) -> Line<'static>

Renders the button alongside a title line.

Arguments

• panel_area - The area where the button will be rendered
• title - The title text to display

Returns

A Line containing the title span and the button span

Note

This method updates the button’s internal area for click detection

impl Button

pub fn set_area(&mut self, area: Rect)

Sets the button’s area (used for click detection).

Arguments

• area - The rectangular area where the button is rendered

impl Button

pub fn text(&self) -> &str

Returns the button’s text content.

Returns

A string slice containing the button’s text

impl Button

pub fn update_hover(&mut self, column: u16, row: u16)

Updates the button’s hover state based on cursor position.

Arguments

• column - The column (x) coordinate of the cursor
• row - The row (y) coordinate of the cursor

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 a default button with text “Button”.

Returns

A new Button instance with default styling and text “Button”