Struct Frame 

pub struct Frame { /* private fields */ }

A frame container (lazygit-style panel).

Implementations

impl Frame

pub fn new() -> Self

Create a frame.

pub fn tab_titles<I, S>(self, titles: I) -> Self

where I: IntoIterator<Item = S>, S: Into<RichText>,

Set tab titles rendered in the top border.

pub fn active_tab(self, active_tab: usize) -> Self

Set the active tab index.

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

Set the style for the active tab.

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

Set the style for the active tab when focused.

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

Set the style for inactive tabs.

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

Set the style for inactive tabs when focused.

pub fn on_tab_change(self, cb: Callback<TabsEvent>) -> Self

Callback fired when the active tab changes via border tab clicks.

pub fn tab_variant(self, variant: TabVariant) -> Self

Set the visual variant for border tabs.

pub fn header(self, header: BorderLabels) -> Self

Set labels rendered in the top border.

pub fn header_left(self, label: impl Into<FrameLabel>) -> Self

Set the left header label.

pub fn header_center(self, label: impl Into<FrameLabel>) -> Self

Set the centered header label.

pub fn header_right(self, label: impl Into<FrameLabel>) -> Self

Set the right header label.

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

Set base style.

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

Set style for the inner content area (distinct from border).

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

Set style applied when the frame or its children have focus.

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

Extend the themed focus style with the given style.

pub fn inherit_focus_style(self) -> Self

Inherit focus style from the active theme.

pub fn focus_style_slot(self, slot: StyleSlot) -> Self

Set the focus style slot directly.

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

Set style when hovered.

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

Extend the themed hover style with the given style.

pub fn inherit_hover_style(self) -> Self

Inherit hover style from the active theme.

pub fn hover_style_slot(self, slot: StyleSlot) -> Self

Set the hover style slot directly.

pub fn focus_border_style(self, border_style: BorderStyle) -> Self

Set border style applied when focused.

pub fn border(self, border: bool) -> Self

Enable or disable border decoration.

pub fn border_style(self, border_style: BorderStyle) -> Self

Set border style.

pub fn border_edges(self, border_edges: BorderEdges) -> Self

Set which border edges reserve layout space and render as frame chrome.

BorderEdges::HorizontalCaps keeps the top and bottom border rows with corner caps, but does not consume left or right content columns.

pub fn border_merge_mode(self, merge_mode: BorderMergeMode) -> Self

Set merge behavior for overlapping frame border symbols.

pub fn join_frame(self, join: bool) -> Self

Join borders with neighboring frames when edges touch.

pub fn padding(self, padding: impl Into<Padding>) -> Self

Set padding.

pub fn decoration(self, decoration: EdgeDecoration) -> Self

Add an edge decoration.

pub fn decorations(self, decorations: Vec<EdgeDecoration>) -> Self

Replace all decorations.

pub fn header_content(self, header: impl Into<Element>) -> Self

Set a content header element rendered inside the frame.

pub fn child(self, child: impl Into<Element>) -> Self

Set child.

pub fn width(self, width: Length) -> Self

Override requested width.

pub fn height(self, height: Length) -> Self

Override requested height.

pub fn unfocused_height(self, height: Length) -> Self

Override requested height when not focused.

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

Set minimum height when focused (includes borders).

pub fn compact(self, compact: bool) -> Self

Enable compact single-line rendering mode.

In compact mode, the frame renders as a single horizontal line with dashes and the title embedded: -[1]-Status-----. This is useful for collapsed panels in a dynamic layout.

pub fn collapsible(self, collapsible: bool) -> Self

Allow the frame to collapse when space is constrained.

pub fn footer(self, footer: BorderLabels) -> Self

Set labels rendered in the bottom border.

pub fn footer_left(self, label: impl Into<FrameLabel>) -> Self

Set the left footer label.

pub fn footer_center(self, label: impl Into<FrameLabel>) -> Self

Set the centered footer label.

pub fn footer_right(self, label: impl Into<FrameLabel>) -> Self

Set the right footer label.

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

Set the header group style.

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

Set the focused header group style.

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

Set the footer group style.

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

Set the focused footer group style.

pub fn header_padding(self, padding: impl Into<Padding>) -> Self

Set header label padding.

pub fn footer_padding(self, padding: impl Into<Padding>) -> Self

Set footer label padding.

pub fn focusable(self, focusable: bool) -> Self

Make the frame focusable even if it has no child or tabs.

pub fn focus_scope(self, scope: FocusScope) -> Self

Set focus traversal behavior for this subtree.

pub fn child_align(self, align: Align) -> Self

Set alignment of child content within the frame’s inner area.

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Frame

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Frame

fn default() -> Frame

Returns the “default value” for a type.

impl From<Frame> for Element

fn from(value: Frame) -> Self

Converts to this type from the input type.