Struct TextPrompt 

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

A prompt widget that displays a message and a text input.

By default, the prompt reserves space for the TextState status symbol before the prompt message. Use TextPrompt::without_status_symbol when the surrounding UI owns completion or cancellation state and the prompt should start directly with the message.

TextPrompt can be rendered by value when it is built inline, or by reference when prompt configuration is stored and reused across frames. Rendering by reference keeps the prompt configuration available for later frames while still updating the external TextState.

Examples

use ratatui::Frame;
use ratatui::layout::Rect;
use tui_prompts::{Prompt, TextPrompt, TextState};

struct App<'a> {
    prompt: TextPrompt<'a>,
    state: TextState<'a>,
}

impl App<'_> {
    fn draw(&mut self, frame: &mut Frame, area: Rect) {
        (&self.prompt).draw(frame, area, &mut self.state);
    }
}

Implementations

impl<'a> TextPrompt<'a>

pub const fn new(message: Cow<'a, str>) -> TextPrompt<'a>

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

pub const fn with_render_style( self, render_style: TextRenderStyle, ) -> TextPrompt<'a>

pub const fn without_status_symbol(self) -> TextPrompt<'a>

Renders the prompt without the status symbol or its following space.

The prompt state’s Status is still updated and available through TextState. This only changes the rendered prefix, so the prompt message, input value, wrapping width, and cursor position all move left by the width of the hidden status symbol prefix.

Trait Implementations

impl<'a> Clone for TextPrompt<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for TextPrompt<'a>

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

Formats the value using the given formatter.

impl Default for TextPrompt<'_>

fn default() -> TextPrompt<'_>

Returns the “default value” for a type.

impl<'a> Eq for TextPrompt<'a>

impl<T> From<T> for TextPrompt<'static>

where T: Into<Cow<'static, str>>,

fn from(message: T) -> TextPrompt<'static>

Converts to this type from the input type.

impl<'a> PartialEq for TextPrompt<'a>

fn eq(&self, other: &TextPrompt<'a>) -> 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 Prompt for TextPrompt<'_>

fn draw( self, frame: &mut Frame<'_>, area: Rect, state: &mut <TextPrompt<'_> as StatefulWidget>::State, )

Draws the prompt widget.

This is in addition to the Widget trait implementation as we need the Frame to set the cursor position.

impl Prompt for &TextPrompt<'_>

fn draw( self, frame: &mut Frame<'_>, area: Rect, state: &mut <&TextPrompt<'_> as StatefulWidget>::State, )

Draws the prompt widget.

This is in addition to the Widget trait implementation as we need the Frame to set the cursor position.

impl<'a> StatefulWidget for TextPrompt<'a>

type State = TextState<'a>

State associated with the stateful widget.

fn render( self, area: Rect, buf: &mut Buffer, state: &mut <TextPrompt<'a> as StatefulWidget>::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<'a> StatefulWidget for &TextPrompt<'a>

type State = TextState<'a>

State associated with the stateful widget.

fn render( self, area: Rect, buf: &mut Buffer, state: &mut <&TextPrompt<'a> as StatefulWidget>::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<'a> StructuralPartialEq for TextPrompt<'a>