63b438188f
As starting to use the cursive library I've found it challenging to figure out how to actually use the themes. Only after checking the source code, and another library actually using this feature, I've managed to apply it to my project. This change makes it easier for new commers to use toml themes by extending the documentationn |
||
---|---|---|
.github/workflows | ||
cursive | ||
cursive-core | ||
doc | ||
examples | ||
.gitignore | ||
.travis.yml | ||
appveyor.yml | ||
Cargo.toml | ||
CHANGELOG.md | ||
CODE_OF_CONDUCT.md | ||
CONTRIBUTING.md | ||
ISSUE_TEMPLATE.md | ||
LICENSE | ||
Readme.md | ||
rustfmt.toml | ||
shell.nix |
Cursive
Cursive is a TUI (Text User Interface) library for rust. It uses ncurses by default, but other backends are available.
It allows you to build rich user interfaces for terminal applications.
Documentation
It is designed to be safe and easy to use:
[dependencies]
cursive = "0.15"
Or to use the latest git version:
[dependencies]
cursive = { git = "https://github.com/gyscos/cursive" }
(You will also need ncurses installed.)
use cursive::views::{Dialog, TextView};
fn main() {
// Creates the cursive root - required for every application.
let mut siv = cursive::default();
// Creates a dialog with a single "Quit" button
siv.add_layer(Dialog::around(TextView::new("Hello Dialog!"))
.title("Cursive")
.button("Quit", |s| s.quit()));
// Starts the event loop.
siv.run();
}
Check out the other examples to get these results, and more:
(Colors may depend on your terminal configuration.)
Tutorials
These tutorials may help you get started with cursive:
Third-party views
Here are a few crates implementing new views for you to use:
- cursive-aligned-view: A view wrapper for gyscos/cursive views which aligns child views.
- cursive-async-view: A loading-screen wrapper.
- cursive-flexi-logger-view: An alternative debug view using
emabee/flexi_logger
. - cursive-multiplex: A tmux like multiplexer.
- cursive-tabs: Tabs.
- cursive_calendar_view: A basic calendar view implementation.
- cursive_hexview: A simple hexview.
- cursive_table_view: A basic table view component.
- cursive_tree_view: A tree view implementation.
Showcases
Here are some cool applications using cursive:
- RustyChat: Chat client made using Rust and Cursive.
- fui: Add CLI & form interface to your program.
- grin-tui: Minimal implementation of the MimbleWimble protocol.
- ripasso: A simple password manager written in Rust.
Goals
- Ease of use. Simple apps should be simple. Complex apps should be manageable.
- Linux TTY Compatibility. Colors may suffer, and UTF-8 may be too much, but most features must work properly on a Linux TTY.
- Flexibility. This library should be able to handle simple UI scripts, complex real-time applications, or even games.
- In particular, it tries to have enough features to recreate these kind of tools:
Compatibility
First off, terminals are messy. A small set of features is standard, but beyond that, almost every terminal has its own implementation.
Output
- Colors: the basic 8-colors palette should be broadly supported. User-defined colors is not supported in the raw linux TTY, but should work in most terminals, although it's still kinda experimental.
- UTF-8: Currently Cursive really expects a UTF-8 locale. It may eventually get patched to support window borders on other locales, but it's not a priority. There is initial support for wide characters. RTL support is planned, but still very early.
Input
- The
key_codes
example can be a useful tool to see how the library reacts to various key presses. - Keep in mind that if the terminal has shortcuts registered, they probably won't be transmitted to the app.
- UTF-8 input should work fine in a unicode-enabled terminal emulator, but raw linux TTY may be more capricious.
Contributing
Alternatives
See also tui-rs - and a small comparison page.