Struct Panel 

pub struct Panel { /* private fields */ }

A bordered box around a renderable. Mirrors rich.panel.Panel.

Implementations

impl Panel

pub fn new(child: Box<dyn Renderable>) -> Self

A panel around child with default box (ROUNDED) and padding (0,1).

pub fn fit(child: Box<dyn Renderable>) -> Self

A panel that fits its content rather than expanding to the available width. Port of Panel.fit (expand=False).

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

Expand to the full available width (upstream expand, default on), or fit the measured width of the content and title.

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

A fixed width for the whole panel, borders included (upstream width), capped at the available width.

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

Set a title (drawn into the top border, centered by default).

pub fn title_as_text(self, title: Text) -> Self

Set a literal Text title (upstream Panel(title=Text(…))): no markup is parsed. Replaces a title.

pub fn title_align(self, align: HorizontalAlign) -> Self

Set the title alignment within the top border.

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

Set a subtitle (drawn into the bottom border, centered by default).

pub fn subtitle_as_text(self, subtitle: Text) -> Self

Set a literal Text subtitle (upstream Panel(subtitle=Text(…))): no markup is parsed. Replaces a subtitle.

pub fn safe_box(self, safe_box: Option<bool>) -> Self

Whether to substitute boxes a legacy Windows console cannot draw (upstream safe_box; None, the default, takes the console’s).

pub fn subtitle_align(self, align: HorizontalAlign) -> Self

Set the subtitle alignment within the bottom border.

pub fn box_set(self, box_set: BoxSet) -> Self

Choose the box-drawing set.

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

Set the inner padding (top, right, bottom, left).

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

Highlight strings rendered inside the panel (upstream Panel(highlight=…), default off). Passed to the child as ConsoleOptions::highlight.

pub fn border_style(self, style: impl Into<StyleType>) -> Self

Set the border style: a Style, or a theme name / definition. It is combined over style.

pub fn style(self, style: impl Into<StyleType>) -> Self

The style of the whole panel, border and contents (upstream style, default none): the background under the padded child, and beneath the border style.

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

A fixed height for the whole panel, borders included (upstream height); else the options’ height, else the content’s.

impl Panel

Read access to what a panel holds: upstream’s public Panel fields. Not upstream as methods, and they change nothing; they let an extension read a panel instead of its rendering.

use rich::{Panel, Text};
use rich::table::Cell;

let panel = Panel::new(Box::new(Text::new("body"))).title("[b]Status[/]");
assert!(matches!(panel.get_title(), Some(Cell::Markup(t)) if t == "[b]Status[/]"));
assert!(panel.get_subtitle().is_none());
assert_eq!(panel.renderable().printed_text().unwrap().plain(), "body");

pub fn renderable(&self) -> &dyn Renderable

The renderable inside the panel (upstream Panel.renderable).

pub fn get_title(&self) -> Option<Cell>

The title (upstream Panel.title): a Cell::Text when set with title_as_text, which wins, else a Cell::Markup set with title.

pub fn get_subtitle(&self) -> Option<Cell>

The subtitle (upstream Panel.subtitle), as get_title.

pub fn get_title_align(&self) -> HorizontalAlign

The title’s alignment (upstream Panel.title_align).

pub fn get_subtitle_align(&self) -> HorizontalAlign

The subtitle’s alignment (upstream Panel.subtitle_align).

Trait Implementations

impl Renderable for Panel

fn measure(&self, console: &Console, options: &ConsoleOptions) -> Measurement

Port of Panel.__rich_measure__: the widest of the content and the title, measured inside the borders and padding, plus both; or the fixed width. Either way the panel asks for exactly one width.

fn rich_render( &self, console: &Console, options: &ConsoleOptions, ) -> Vec<Segment>

fn fit_to_measurement(&self) -> bool

Whether a top-level Console::print shrinks this renderable to its measured width. Upstream renders every top-level renderable at the full console width, so the default is false; an extension may opt in.

fn vertical(&self) -> Option<VerticalAlign>

The vertical alignment a Table cell holding this renderable uses in place of its column’s. Upstream reads getattr(renderable, "vertical", None); Align sets it.

fn print_end_line(&self, _options: &ConsoleOptions) -> bool

Whether a top-level print ends this renderable’s last line. This port’s renderables separate lines, where upstream’s end each line with "\n", so a print adds the final line break. A renderable whose upstream output stops without one (Screen, LiveRender, a Rule whose end has no newline) returns false, and the next output continues its last line. options are the print’s options.