Expand description
A widget based terminal ui rendering library.
This crate provides an abstraction over terminal manipulation in the form of the Widget
trait. It also provides some default widgets available in widgets.
While this crate was built for the requestty crate and other crates which implement the
Prompt trait in requestty, it can be used otherwise as well.
§Backends
This crate currently supports 2 backends:
The different backends can be enabled using the features of the same name.
Re-exports§
pub use widgets::Widget;
Modules§
- backend
- A module to represent a terminal and operations on it.
- events
- A module for handling key events
- layout
- A module to describe regions of the screen that can be rendered to.
- style
- A module to control the looks of text.
- symbols
- Special characters used for prompts/widgets.
- widgets
- A module containing the in-built widgets and types required by them
Macros§
- assert_
backend_ snapshot crosstermortermion - A testing utility to assert visual equality with
TestBackend.
Structs§
- Input
- A ui runner which implements the render cycle.
Enums§
- Error
Kind - The errors that can occur in
requestty. - OnEsc
- What to do after receiving
Esc - Validation
- The state of a prompt on validation.
Traits§
- Prompt
- This trait should be implemented by all ‘root’ widgets.
Type Aliases§
- Result
- The
requesttyresult type.