Struct RatatuiLogo

pub struct RatatuiLogo { /* private fields */ }

A widget that renders the Ratatui logo

The Ratatui logo takes up two lines of text and comes in two sizes: Tiny and Small. This may be used in an application’s help or about screen to show that it is powered by Ratatui.

Examples

The Ratatui-logo example demonstrates how to use the RatatuiLogo widget. This can be run by cloning the Ratatui repository and then running the following command with an optional size argument:

cargo run --example ratatui-logo [size]

Tiny (default, 2x15 characters)

use ratatui::widgets::RatatuiLogo;

frame.render_widget(RatatuiLogo::tiny(), frame.area());

Renders:

▛▚▗▀▖▜▘▞▚▝▛▐ ▌▌
▛▚▐▀▌▐ ▛▜ ▌▝▄▘▌

Small (2x27 characters)

use ratatui::widgets::RatatuiLogo;

frame.render_widget(RatatuiLogo::small(), frame.area());

Renders:

█▀▀▄ ▄▀▀▄▝▜▛▘▄▀▀▄▝▜▛▘█  █ █
█▀▀▄ █▀▀█ ▐▌ █▀▀█ ▐▌ ▀▄▄▀ █

Implementations

impl RatatuiLogo

pub const fn new(size: Size) -> Self

Create a new Ratatui logo widget

Examples

use ratatui::widgets::{RatatuiLogo, RatatuiLogoSize};

let logo = RatatuiLogo::new(RatatuiLogoSize::Tiny);

pub const fn size(self, size: Size) -> Self

Set the size of the logo

Examples

use ratatui::widgets::{RatatuiLogo, RatatuiLogoSize};

let logo = RatatuiLogo::default().size(RatatuiLogoSize::Small);

pub const fn tiny() -> Self

Create a new Ratatui logo widget with a tiny size

Examples

use ratatui::widgets::RatatuiLogo;

let logo = RatatuiLogo::tiny();

pub const fn small() -> Self

Create a new Ratatui logo widget with a small size

Examples

use ratatui::widgets::RatatuiLogo;

let logo = RatatuiLogo::small();

Trait Implementations

impl Clone for RatatuiLogo

fn clone(&self) -> RatatuiLogo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RatatuiLogo

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

Formats the value using the given formatter.

impl Default for RatatuiLogo

fn default() -> RatatuiLogo

Returns the “default value” for a type.

impl PartialEq for RatatuiLogo

fn eq(&self, other: &RatatuiLogo) -> 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 Widget for RatatuiLogo

fn render(self, area: Rect, buf: &mut Buffer)

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom widget.

impl Copy for RatatuiLogo

impl Eq for RatatuiLogo

impl StructuralPartialEq for RatatuiLogo