Struct Dialog 

pub struct Dialog {
    pub open: bool,
    pub submitted: bool,
    pub working_input: String,
    pub submitted_input: String,
    /* private fields */
}

The data structure for the dialog.

Fields

open: bool

Whether or not the dialog box is open.

submitted: bool

Whether or not input has been submitted.

working_input: String

The text being written into the dialog box when it’s open. This field can be used to pre-populate the dialog with a value before it is opened. It will be cleared when the user presses Esc or Enter.

submitted_input: String

The text that has been written and is submitted for use when the user presses Enter. Any surrounding whitespace will be trimmed.

Implementations

impl Dialog

pub fn key_action(&mut self, key_code: &KeyCode)

Respond to key press.

pub fn title_top(&mut self, title: &str) -> Self

Set the top title of the block surrounding the widget.

If the method is not used, there will be no top title.

pub fn title_bottom(&mut self, title: &str) -> Self

Set the bottom title of the block surrounding the widget.

If the method is not used, the bottom title will default to BOTTOM_TITLE.

pub fn borders(&mut self, borders: Borders) -> Self

Set borders of the block surrounding the widget.

If the method is not used, the borders will default to ratatui::widgets::Borders::ALL.

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

Set the style of the widget.

If the method is not used, the style will be the default with a ratatui::style::Color::DarkGray background.

Trait Implementations

impl Clone for Dialog

fn clone(&self) -> Dialog

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Dialog

fn default() -> Dialog

Returns the “default value” for a type.

impl PartialEq for Dialog

fn eq(&self, other: &Dialog) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Widget for Dialog

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

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

impl StructuralPartialEq for Dialog