Struct Pane 

pub struct Pane<'a> {
    pub title: String,
    pub icon: Option<String>,
    pub padding: (u16, u16, u16, u16),
    pub text_footer: Option<Line<'a>>,
    pub footer_height: u16,
    pub border_style: Style,
    pub border_type: BorderType,
    pub title_style: Style,
    pub footer_style: Style,
}

A styled panel component with title, icon, padding, and optional footer

Fields

title: String

Title text for pane

icon: Option<String>

Icon to display before the title (optional)

padding: (u16, u16, u16, u16)

Padding around the content (top, right, bottom, left)

text_footer: Option<Line<'a>>

Simple text footer (optional) - displayed in border

footer_height: u16

Height of the footer area when using widget footers

border_style: Style

Styling

border_type: BorderType

title_style: Style

footer_style: Style

Implementations

impl<'a> Pane<'a>

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

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

pub fn with_padding(self, top: u16, right: u16, bottom: u16, left: u16) -> Self

pub fn with_uniform_padding(self, padding: u16) -> Self

pub fn with_text_footer(self, footer: Line<'a>) -> Self

pub fn with_footer_height(self, height: u16) -> Self

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

pub fn border_type(self, border_type: BorderType) -> Self

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

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

impl<'a> Pane<'a>

pub fn with_theme(self, theme: &AppTheme) -> Self

Applies theme colors to the pane.

This method configures the pane’s border and footer styles based on the provided theme.

Theme Mapping

• Border style uses theme.border
• Footer style uses theme.text_muted

Arguments

• theme - The application theme to apply

Returns

Self with theme colors applied for method chaining.

Example

use ratatui_toolkit::{Pane, AppTheme};

let theme = AppTheme::default();
let pane = Pane::new("My Panel")
    .with_theme(&theme);

impl<'a> Pane<'a>

pub fn render<W>(&self, frame: &mut Frame<'_>, area: Rect, content: W)

where W: Widget,

pub fn render_with_footer<C, F>( &self, frame: &mut Frame<'_>, area: Rect, content: C, footer: F, )

where C: Widget, F: Widget,

pub fn render_paragraph( &self, frame: &mut Frame<'_>, area: Rect, content: Vec<Line<'a>>, )

pub fn render_paragraph_with_footer<F>( &self, frame: &mut Frame<'_>, area: Rect, content: Vec<Line<'a>>, footer: F, )

where F: Widget,

pub fn render_block( &self, frame: &mut Frame<'_>, area: Rect, ) -> (Rect, Option<Rect>)

Trait Implementations

impl<'a> Clone for Pane<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Pane<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Pane<'a>

fn default() -> Self

Returns the “default value” for a type.