Struct ModalRenderer 

pub struct ModalRenderer { /* private fields */ }

Modal command palette renderer.

The modal renderer clears its area, draws a rounded border, then renders the prompt, rows, and footer. It is useful when the palette should interrupt the current surface. See the render module for the renderer contract shared by all built-in renderers.

Implementations

impl ModalRenderer

pub fn new() -> Self

Creates a ModalRenderer with the default title.

pub fn title(self, title: impl Into<String>) -> Self

Sets the modal title.

Examples

use ratatui_command_palette::render::ModalRenderer;

let renderer = ModalRenderer::new().title("Actions");

assert_eq!(
    format!("{renderer:?}"),
    "ModalRenderer { title: \"Actions\" }"
);

Trait Implementations

impl Clone for ModalRenderer

fn clone(&self) -> ModalRenderer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModalRenderer

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

Formats the value using the given formatter.

impl Default for ModalRenderer

fn default() -> Self

Returns the “default value” for a type.

impl PaletteRenderer for ModalRenderer

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

Draws view into buf within area.