Struct tui_widgets::popup::Popup

#[non_exhaustive]
pub struct Popup<'content, W>
where
    W: SizedWidgetRef,
{
    pub body: W,
    pub title: Line<'content>,
    pub style: Style,
    pub borders: Borders,
    pub border_set: Set,
    pub border_style: Style,
}

Configuration for a popup.

This struct is used to configure a Popup. It can be created using Popup::new.

Example

use ratatui::{prelude::*, symbols::border};
use tui_popup::Popup;

fn render_popup(frame: &mut Frame) {
    let popup = Popup::new("Press any key to exit")
        .title("tui-popup demo")
        .style(Style::new().white().on_blue())
        .border_set(border::ROUNDED)
        .border_style(Style::new().bold());
    frame.render_widget(&popup, frame.size());
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

body: W

The body of the popup.

title: Line<'content>

The title of the popup.

style: Style

The style to apply to the entire popup.

borders: Borders

The borders of the popup.

border_set: Set

The symbols used to render the border.

border_style: Style

Border style

Implementations

impl<'content, W> Popup<'content, W>

where W: SizedWidgetRef,

pub fn title(self, value: impl Into<Line<'content>>) -> Popup<'content, W>

Sets the title field of this struct.

pub fn style(self, value: impl Into<Style>) -> Popup<'content, W>

Sets the style field of this struct.

pub fn borders(self, value: impl Into<Borders>) -> Popup<'content, W>

Sets the borders field of this struct.

pub fn border_set(self, value: impl Into<Set>) -> Popup<'content, W>

Sets the border_set field of this struct.

pub fn border_style(self, value: impl Into<Style>) -> Popup<'content, W>

Sets the border_style field of this struct.

impl<'content, W> Popup<'content, W>

where W: SizedWidgetRef,

pub fn new(body: W) -> Popup<'content, W>

Create a new popup with the given title and body with all the borders.

Parameters

• body - The body of the popup. This can be any type that can be converted into a Text.

Example

use tui_popup::Popup;

let popup = Popup::new("Press any key to exit").title("tui-popup demo");

Trait Implementations

impl<'content, W> Debug for Popup<'content, W>

where W: Debug + SizedWidgetRef,

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

Formats the value using the given formatter.

impl<W> StatefulWidgetRef for Popup<'_, W>

where W: SizedWidgetRef,

type State = PopupState

State associated with the stateful widget.

fn render_ref( &self, area: Rect, buf: &mut Buffer, state: &mut <Popup<'_, W> as StatefulWidgetRef>::State, )

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

impl<W> WidgetRef for Popup<'_, W>

where W: SizedWidgetRef,

fn render_ref(&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.