Struct Button

pub struct Button<'a> { /* private fields */ }

Button widget.

Implementations

impl<'a> Button<'a>

pub fn new(text: impl Into<Text<'a>>) -> Self

pub fn styles_opt(self, styles: Option<ButtonStyle>) -> Self

Set all styles.

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

Set all styles.

pub fn style(self, style: impl Into<Style>) -> Self

Set the base-style.

pub fn focus_style(self, style: impl Into<Style>) -> Self

Style when focused.

pub fn armed_style(self, style: impl Into<Style>) -> Self

Style when clicked but not released.

pub fn armed_delay(self, delay: Duration) -> Self

Some terminals repaint too fast to see the click. This adds some delay when the button state goes from armed to clicked.

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

Style for hover over the button.

pub fn text(self, text: impl Into<Text<'a>>) -> Self

Button text.

pub fn left_aligned(self) -> Self

Left align button text.

pub fn right_aligned(self) -> Self

Right align button text.

pub fn block(self, block: Block<'a>) -> Self

Block.

pub fn width(&self) -> u16

Inherent width.

pub fn height(&self) -> u16

Inherent height.

Trait Implementations

impl<'a> Clone for Button<'a>

fn clone(&self) -> Button<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Button<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Button<'a>

fn default() -> Button<'a>

Returns the “default value” for a type.

impl StatefulWidget for Button<'_>

type State = ButtonState

State associated with the stateful widget.

fn render(self, area: Rect, buf: &mut Buffer, state: &mut Self::State)

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom stateful widget.