Struct Box 

pub struct Box { /* private fields */ }

A rectangular box filled with spaces, optionally with a background color.

The box renders pad_y rows of spaces at the requested width. A background function can be applied to each line via with_background.

Implementations

impl Box

pub fn new(pad_y: u16) -> Self

Create a new box with the given vertical padding.

pub fn with_background(self, bg: fn(&str, u16) -> String) -> Self

Apply a background color function to every line.

The function receives (line_text, width) and should return the styled line.

Trait Implementations

impl Component for Box

fn render(&self, width: u16) -> Result<Rendered, RenderError>

Render this component into lines of text at the given width.

fn render_rect(&self, rect: Rect) -> Result<Rendered, RenderError>

Render this component into a specific rectangular area.

fn handle_input(&mut self, _event: &Event) -> InputResult

Handle an input event (key press, resize, mouse, etc.).

fn wants_key_release(&self) -> bool

Returns true if this component wants to receive KeyEventKind::Release events in addition to Press / Repeat.

fn as_focusable(&self) -> Option<&dyn Focusable>

Cast this component to a Focusable reference, if supported.

fn as_focusable_mut(&mut self) -> Option<&mut dyn Focusable>

Cast this component to a mutable Focusable reference, if supported.