Struct Title 

pub struct Title {
    pub content: Text,
    pub align: Align,
    pub position: Position,
    pub pad: u16,
}

A framed title, e.g. on a panel, rule or table.

When inset into a border, a left-aligned title reads as part of the frame with one connecting glyph before it (┌─ Title ─), not a flush ┌ Title.

Fields

content: Text

The title content (rich text).

align: Align

Horizontal placement along the edge.

position: Position

Which edge the title sits on.

pad: u16

Spaces of padding on each side of the title text.

Implementations

impl Title

pub fn new(content: impl Into<Text>) -> Self

Creates a left-aligned top title with single-space padding.

Examples found in repository

examples/output_dynamic.rs (line 62)

fn live() -> Result<()> {
    let mut live = Live::new();
    for tick in 1..=8 {
        let frame = Panel::new(format!("live tick {tick}"))
            .title(Title::new("Live"))
            .render(30);
        live.update(&frame)?;
        sleep(Duration::from_millis(120));
    }
    live.finish()
}

examples/output_gallery.rs (line 95)

fn panels() -> Result<()> {
    section("Panels")?;
    Panel::new("Rounded border (default).").print()?;
    Panel::new("Double border.")
        .border(BorderType::Double)
        .print()?;
    Panel::new("Centered, filled, fixed width.")
        .border(BorderType::Thick)
        .title(Title::new("Title"))
        .subtitle(Title::new("subtitle"))
        .content_align(Align::Center)
        .fill(Style::new().bg(Color::Indexed(236)))
        .width(40)
        .print()?;
    Ok(())
}

examples/prompt-readme.rs (line 43)

fn hero(width: u16) -> Result<()> {
    let theme = theme();
    let body = Text::new(vec![
        Line::raw("Interactive prompts - confirm · select · text · password ·"),
        Line::raw("number · textarea · fuzzy · date."),
    ]);
    Panel::new(body)
        .border(BorderType::Rounded)
        .border_style(Style::new().fg(theme.accent))
        .title(
            Title::new(" sparcli · input widgets ")
                .align(Align::Center)
                .style(theme.title),
        )
        .content_align(Align::Center)
        .width(width)
        .print()
}

examples/output-readme.rs (line 53)

fn hero() -> Result<()> {
    let cyan = Style::new().fg(Color::Cyan).bold();
    let on_magenta = Style::new().fg(Color::Black).bg(Color::Magenta).bold();
    let yellow = Style::new().fg(Color::Yellow).bold();
    let body = Text::new(vec![
        Line::new(vec![
            Span::raw("A native Rust library for "),
            Span::styled("styled terminal output", cyan),
            Span::raw(" and "),
            Span::styled("input", on_magenta),
            Span::raw(" - panels, tables, trees, lists,"),
        ]),
        Line::new(vec![
            Span::raw("key-value pairs, badges, rules, "),
            Span::styled("columns", cyan),
            Span::raw(" and progress bars, with Rich-compatible "),
            Span::styled("[markup]", yellow),
            Span::raw("."),
        ]),
    ]);
    Panel::new(body)
        .border(BorderType::Rounded)
        .border_style(Style::new().fg(Color::Cyan))
        .title(
            Title::new(" sparcli ")
                .align(Align::Center)
                .style(Style::new().fg(Color::Cyan).bold()),
        )
        .content_align(Align::Center)
        .width(96)
        .print()
}

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

Sets the horizontal alignment.

Examples found in repository

examples/prompt-readme.rs (line 44)

fn hero(width: u16) -> Result<()> {
    let theme = theme();
    let body = Text::new(vec![
        Line::raw("Interactive prompts - confirm · select · text · password ·"),
        Line::raw("number · textarea · fuzzy · date."),
    ]);
    Panel::new(body)
        .border(BorderType::Rounded)
        .border_style(Style::new().fg(theme.accent))
        .title(
            Title::new(" sparcli · input widgets ")
                .align(Align::Center)
                .style(theme.title),
        )
        .content_align(Align::Center)
        .width(width)
        .print()
}

examples/output-readme.rs (line 54)

fn hero() -> Result<()> {
    let cyan = Style::new().fg(Color::Cyan).bold();
    let on_magenta = Style::new().fg(Color::Black).bg(Color::Magenta).bold();
    let yellow = Style::new().fg(Color::Yellow).bold();
    let body = Text::new(vec![
        Line::new(vec![
            Span::raw("A native Rust library for "),
            Span::styled("styled terminal output", cyan),
            Span::raw(" and "),
            Span::styled("input", on_magenta),
            Span::raw(" - panels, tables, trees, lists,"),
        ]),
        Line::new(vec![
            Span::raw("key-value pairs, badges, rules, "),
            Span::styled("columns", cyan),
            Span::raw(" and progress bars, with Rich-compatible "),
            Span::styled("[markup]", yellow),
            Span::raw("."),
        ]),
    ]);
    Panel::new(body)
        .border(BorderType::Rounded)
        .border_style(Style::new().fg(Color::Cyan))
        .title(
            Title::new(" sparcli ")
                .align(Align::Center)
                .style(Style::new().fg(Color::Cyan).bold()),
        )
        .content_align(Align::Center)
        .width(96)
        .print()
}

pub fn position(self, position: Position) -> Self

Sets the edge the title sits on.

pub fn pad(self, pad: u16) -> Self

Sets the padding on each side of the title text.

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

Applies a style to every span of the title.

Examples found in repository

examples/prompt-readme.rs (line 45)

fn hero(width: u16) -> Result<()> {
    let theme = theme();
    let body = Text::new(vec![
        Line::raw("Interactive prompts - confirm · select · text · password ·"),
        Line::raw("number · textarea · fuzzy · date."),
    ]);
    Panel::new(body)
        .border(BorderType::Rounded)
        .border_style(Style::new().fg(theme.accent))
        .title(
            Title::new(" sparcli · input widgets ")
                .align(Align::Center)
                .style(theme.title),
        )
        .content_align(Align::Center)
        .width(width)
        .print()
}

examples/output-readme.rs (line 55)

fn hero() -> Result<()> {
    let cyan = Style::new().fg(Color::Cyan).bold();
    let on_magenta = Style::new().fg(Color::Black).bg(Color::Magenta).bold();
    let yellow = Style::new().fg(Color::Yellow).bold();
    let body = Text::new(vec![
        Line::new(vec![
            Span::raw("A native Rust library for "),
            Span::styled("styled terminal output", cyan),
            Span::raw(" and "),
            Span::styled("input", on_magenta),
            Span::raw(" - panels, tables, trees, lists,"),
        ]),
        Line::new(vec![
            Span::raw("key-value pairs, badges, rules, "),
            Span::styled("columns", cyan),
            Span::raw(" and progress bars, with Rich-compatible "),
            Span::styled("[markup]", yellow),
            Span::raw("."),
        ]),
    ]);
    Panel::new(body)
        .border(BorderType::Rounded)
        .border_style(Style::new().fg(Color::Cyan))
        .title(
            Title::new(" sparcli ")
                .align(Align::Center)
                .style(Style::new().fg(Color::Cyan).bold()),
        )
        .content_align(Align::Center)
        .width(96)
        .print()
}

Trait Implementations

impl Clone for Title

fn clone(&self) -> Title

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Title

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

Formats the value using the given formatter.

impl Default for Title

fn default() -> Title

Returns the “default value” for a type.