Skip to main content

Pane

Struct Pane 

Source
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,
}
Expand description

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§

Source§

impl<'a> Pane<'a>

Source

pub fn new(title: impl Into<String>) -> Pane<'a>

Available on crate feature pane only.
Source

pub fn with_icon(self, icon: impl Into<String>) -> Pane<'a>

Available on crate feature pane only.
Source

pub fn with_padding( self, top: u16, right: u16, bottom: u16, left: u16, ) -> Pane<'a>

Available on crate feature pane only.
Source

pub fn with_uniform_padding(self, padding: u16) -> Pane<'a>

Available on crate feature pane only.
Available on crate feature pane only.
Available on crate feature pane only.
Source

pub fn border_style(self, style: Style) -> Pane<'a>

Available on crate feature pane only.
Source

pub fn border_type(self, border_type: BorderType) -> Pane<'a>

Available on crate feature pane only.
Source

pub fn title_style(self, style: Style) -> Pane<'a>

Available on crate feature pane only.
Source

pub fn footer_style(self, style: Style) -> Pane<'a>

Available on crate feature pane only.
Source§

impl<'a> Pane<'a>

Source

pub fn with_theme(self, theme: &AppTheme) -> Pane<'a>

Available on crate features pane and markdown-preview only.

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 crate::primitives::pane::Pane;
use crate::widgets::markdown_preview::services::theme::AppTheme;

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

impl<'a> Pane<'a>

Source

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

Available on crate feature pane only.
Available on crate feature pane only.
Source

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

Available on crate feature pane only.
Available on crate feature pane only.
Source

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

Available on crate feature pane only.

Trait Implementations§

Source§

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

Source§

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

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

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

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

fn default() -> Pane<'a>

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for Pane<'a>

§

impl<'a> RefUnwindSafe for Pane<'a>

§

impl<'a> Send for Pane<'a>

§

impl<'a> Sync for Pane<'a>

§

impl<'a> Unpin for Pane<'a>

§

impl<'a> UnsafeUnpin for Pane<'a>

§

impl<'a> UnwindSafe for Pane<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more