Module tuirealm::tui::prelude

A prelude for conveniently writing applications using this library.

use ratatui::prelude::*;

Aside from the main types that are used in the library, this prelude also re-exports several modules to make it easy to qualify types that would otherwise collide. E.g.:

use ratatui::{prelude::*, widgets::*};

#[derive(Debug, Default, PartialEq, Eq)]
struct Line;

assert_eq!(Line::default(), Line);
assert_eq!(text::Line::default(), ratatui::text::Line::from(vec![]));

Structs

• Buffer
  A buffer that maps to the desired content of the terminal after the draw call
• CompletedFrame
  CompletedFrame represents the state of the terminal after all changes performed in the last Terminal::draw call have been applied. Therefore, it is only valid until the next call to Terminal::draw.
• CrosstermBackend
  A Backend implementation that uses Crossterm to render to the terminal.
• Frame
  A consistent view into the terminal state for rendering a single frame.
• Layout
  A layout is a set of constraints that can be applied to a given area to split it into smaller ones.
• Line
  A line of text, consisting of one or more Spans.
• Margin
• Masked
  A wrapper around a string that is masked when displayed.
• Modifier
  Modifier changes the way a piece of text is displayed.
• Rect
  A Rectangular area.
• Span
  Represents a part of a line that is contiguous and where all characters share the same style.
• Style
  Style lets you control the main characteristics of the displayed elements.
• Terminal
  An interface to interact and draw Frames on the user’s terminal.
• TerminalOptions
  Options to pass to Terminal::with_options
• Text
  A string split over multiple lines where each line is composed of several clusters, each with their own style.

Enums

• Alignment
• Color
  ANSI Color
• Constraint
  A constraint that defines the size of a layout element.
• Corner
• Direction
• Marker
  Marker to use when plotting data points
• Viewport
  Represents the viewport of the terminal. The viewport is the area of the terminal that is currently visible to the user. It can be either fullscreen, inline or fixed.

Traits

• Backend
  The Backend trait provides an abstraction over different terminal libraries. It defines the methods required to draw content, manipulate the cursor, and clear the terminal screen.
• BlockExt
  An extension trait for Block that provides some convenience methods.
• StatefulWidget
  A StatefulWidget is a widget that can take advantage of some local state to remember things between two draw calls.
• Styled
  A trait for objects that have a Style.
• Stylize
  An extension trait for styling objects.
• Widget
  A Widget is a type that can be drawn on a Buffer in a given Rect.