Struct Title

pub struct Title<'a> {
    pub content: Line<'a>,
    pub alignment: Option<Alignment>,
    pub position: Option<Position>,
}

A Block title.

It can be aligned (see Alignment) and positioned (see Position).

Future Deprecation

This type is deprecated and will be removed in a future release. The reason for this is that the position of the title should be stored in the block itself, not in the title. The Line type has an alignment method that can be used to align the title. For more information see https://github.com/ratatui/ratatui/issues/738.

Use Line instead, when the position is not defined as part of the title. When a specific position is needed, use Block::title_top or Block::title_bottom instead.

Example

Title with no style.

use ratatui::widgets::block::Title;

Title::from("Title");

Blue title on a white background (via Stylize trait).

use ratatui::{style::Stylize, widgets::block::Title};

Title::from("Title".blue().on_white());

Title with multiple styles (see Line and Stylize).

use ratatui::{style::Stylize, text::Line, widgets::block::Title};

Title::from(Line::from(vec!["Q".white().underlined(), "uit".gray()]));

Complete example

use ratatui::{
    layout::Alignment,
    widgets::{
        block::{Position, Title},
        Block,
    },
};

Title::from("Title")
    .position(Position::Top)
    .alignment(Alignment::Right);

Fields

content: Line<'a>

Title content

alignment: Option<Alignment>

Title alignment

If None, defaults to the alignment defined with Block::title_alignment in the associated Block.

position: Option<Position>

Title position

If None, defaults to the position defined with Block::title_position in the associated Block.

Implementations

impl<'a> Title<'a>

pub fn content<T>(self, content: T) -> Self

where T: Into<Line<'a>>,

👎Deprecated: use Block::title_top() or Block::title_bottom() instead. This will be removed in a future release.

Set the title content.

pub const fn alignment(self, alignment: Alignment) -> Self

👎Deprecated: use Block::title_top() or Block::title_bottom() instead. This will be removed in a future release.

Set the title alignment.

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

👎Deprecated: use Block::title_top() or Block::title_bottom() instead. This will be removed in a future release.

Set the title position.

Trait Implementations

impl<'a> Clone for Title<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Title<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Title<'a>

fn default() -> Title<'a>

Returns the “default value” for a type.

impl<'a, T> From<T> for Title<'a>

where T: Into<Line<'a>>,

fn from(value: T) -> Self

Converts to this type from the input type.

impl<'a> Hash for Title<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> PartialEq for Title<'a>

fn eq(&self, other: &Title<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Eq for Title<'a>

impl<'a> StructuralPartialEq for Title<'a>