Expand description
widgets
is a collection of types that implement Widget
or StatefulWidget
or both.
Widgets are created for each frame as they are consumed after rendered. They are not meant to be stored but used as commands to draw common figures in the UI.
The available widgets are:
Block
: a basic widget that draws a block with optional borders, titles and styles.BarChart
: displays multiple datasets as bars with optional grouping.calendar::Monthly
: displays a single month.Canvas
: draws arbitrary shapes using drawing characters.Chart
: displays multiple datasets as a lines or scatter graph.Clear
: clears the area it occupies. Useful to render over previously drawn widgets.Gauge
: displays progress percentage using block characters.LineGauge
: display progress as a line.List
: displays a list of items and allows selection.Paragraph
: displays a paragraph of optionally styled and wrapped text.Scrollbar
: displays a scrollbar.Sparkline
: display a single data set as a sparkline.Table
: displays multiple rows and columns in a grid and allows selection.Tabs
: displays a tab bar and allows selection.
Re-exports§
pub use self::block::Block;
pub use self::block::BorderType;
pub use self::block::Padding;
Modules§
- block
- Elements related to the
Block
base widget. - calendar
widget-calendar
- A simple calendar widget.
(feature: widget-calendar)
- canvas
- A
Canvas
and a collection ofShape
s.
Macros§
- border
macros
- Macro that constructs and returns a combination of the
Borders
object from TOP, BOTTOM, LEFT and RIGHT.
Structs§
- Axis
- An X or Y axis for the
Chart
widget - Bar
- A bar to be shown by the
BarChart
widget. - BarChart
- A chart showing values as bars.
- BarGroup
- A group of bars to be shown by the Barchart.
- Borders
- Bitflags that can be composed to set the visible borders essentially on the block widget.
- Cell
- A
Cell
contains theText
to be displayed in aRow
of aTable
. - Chart
- A widget to plot one or more
Dataset
in a cartesian coordinate system - Clear
- A widget to clear/reset a certain area to allow overdrawing (e.g. for popups).
- Dataset
- A group of data points
- Gauge
- A widget to display a progress bar.
- Line
Gauge - A compact widget to display a progress bar over a single thin line.
- List
- A widget to display several items among which one can be selected (optional)
- List
Item - A single item in a
List
- List
State - State of the
List
widget - Paragraph
- A widget to display some text.
- Ratatui
Logo - A widget that renders the Ratatui logo
- Row
- A single row of data to be displayed in a
Table
widget. - Scrollbar
- A widget to display a scrollbar
- Scrollbar
State - A struct representing the state of a Scrollbar widget.
- Sparkline
- Widget to render a sparkline over one or more lines.
- Sparkline
Bar - An bar in a
Sparkline
. - Table
- A widget to display data in formatted columns.
- Table
State - State of a
Table
widget - Tabs
- A widget that displays a horizontal set of Tabs with a single tab selected.
- Wrap
- Describes how to wrap text across lines.
Enums§
- Graph
Type - Used to determine which style of graphing to use
- Highlight
Spacing - This option allows the user to configure the “highlight symbol” column width spacing
- Legend
Position - Allow users to specify the position of a legend in a
Chart
- List
Direction - Defines the direction in which the list will be rendered.
- Ratatui
Logo Size - The size of the logo
- Render
Direction - Defines the direction in which sparkline will be rendered.
- Scroll
Direction - An enum representing a scrolling direction.
- Scrollbar
Orientation - This is the position of the scrollbar around a given area.
Traits§
- Stateful
Widget - A
StatefulWidget
is a widget that can take advantage of some local state to remember things between two draw calls. - Stateful
Widget Ref unstable-widget-ref
- A
StatefulWidgetRef
is a trait that allows rendering a stateful widget by reference. - Widget
- A
Widget
is a type that can be drawn on aBuffer
in a givenRect
. - Widget
Ref unstable-widget-ref
- A
WidgetRef
is a trait that allows rendering a widget by reference.