LayoutTemplate

Enum LayoutTemplate 

Source
pub enum LayoutTemplate {
    Standard(StandardOptions),
    Sidebar(SidebarOptions),
    Split(SplitOptions),
    Minimal(MinimalOptions),
    Custom(Box<dyn LayoutProvider>),
    CustomFn(LayoutFn),
}
Expand description

Layout templates with customization options

Templates provide common layout patterns. Use Custom or CustomFn for full control with ratatui.

Variants§

§

Standard(StandardOptions)

Standard vertical layout: chat (fills), panels, input, status bar

§

Sidebar(SidebarOptions)

Sidebar layout: main content + sidebar

§

Split(SplitOptions)

Split layout: two main areas side by side or stacked

§

Minimal(MinimalOptions)

Minimal layout: just chat and input, no status bar

§

Custom(Box<dyn LayoutProvider>)

Custom layout using a LayoutProvider implementation

§

CustomFn(LayoutFn)

Custom layout using a closure

Implementations§

Source§

impl LayoutTemplate

Source

pub fn standard() -> Self

Create a standard layout with default options

Source

pub fn with_panels() -> Self

Create a standard layout with panels (permission, question, slash popup)

Source

pub fn with_sidebar( sidebar_widget_id: &'static str, width: impl Into<SidebarWidth>, ) -> Self

Create a sidebar layout

Source

pub fn minimal() -> Self

Create a minimal layout (no status bar, no panels)

Source

pub fn split_horizontal( left_widget_id: &'static str, right_widget_id: &'static str, ) -> Self

Create a horizontal split layout

Source

pub fn split_vertical( top_widget_id: &'static str, bottom_widget_id: &'static str, ) -> Self

Create a vertical split layout

Source

pub fn custom<P: LayoutProvider>(provider: P) -> Self

Create a custom layout using a LayoutProvider

Source

pub fn custom_fn<F>(f: F) -> Self
where F: Fn(Rect, &LayoutContext<'_>, &WidgetSizes) -> LayoutResult + Send + Sync + 'static,

Create a custom layout using a closure

Source

pub fn compute( &self, ctx: &LayoutContext<'_>, sizes: &WidgetSizes, ) -> LayoutResult

Compute the layout for the given context

Trait Implementations§

Source§

impl Default for LayoutTemplate

Source§

fn default() -> Self

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

Auto Trait Implementations§

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> 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, 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