[Fork] A Text User Interface library for the Rust programming language
Go to file
Alexandre Bury 3674c118cb Rustfmt
2018-01-22 11:55:56 -08:00
assets Fix inverted outset color 2017-01-23 17:53:53 -08:00
doc Add mines example 2017-11-29 02:11:11 -08:00
examples Move View::as_any to separate trait AnyView 2018-01-22 11:50:25 -08:00
src Rustfmt 2018-01-22 11:55:56 -08:00
.gitignore Add examples to exclude 2017-11-17 11:39:20 -08:00
.travis.yml Added *-backend features 2017-02-01 20:59:17 +03:00
Cargo.toml Refactor ColorStyle 2018-01-17 10:22:06 -08:00
CHANGELOG.md Add examples descriptions 2018-01-18 10:32:08 -08:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2018-01-08 13:01:21 +01:00
CONTRIBUTING.md Update CONTRIBUTING.md 2017-06-14 23:55:11 -07:00
ISSUE_TEMPLATE.md Create ISSUE_TEMPLATE.md 2018-01-08 13:09:18 +01:00
LICENSE Add license 2015-05-22 00:25:59 -07:00
Readme.md Add Plain markup implementation 2018-01-10 14:44:27 +01:00
rustfmt.toml Rustfmt 2018-01-22 11:55:56 -08:00
shell.nix add shell.nix file for Nix users 2017-01-31 19:38:38 +01:00

Cursive

crates.io Build Status MIT licensed Gitter chat

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.7"

Or to use the latest git version:

[dependencies]
cursive = { git = "https://github.com/gyscos/Cursive" }

(You will also need ncurses installed.)

extern crate cursive;

use cursive::Cursive;
use cursive::views::{Dialog, TextView};

fn main() {
    // Creates the cursive root - required for every application.
    let mut siv = Cursive::new();

    // 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();
}

Cursive dialog example

Check out the other examples to get these results, and more:

edit.rs example lorem.rs example menubar.rs example select.rs example mines example theme.rs example

(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:

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:

Non-goals

  • Extreme performance. This is a simple layout library, guys, not compiz piped into libcaca. Unless you are running it on your microwave's microcontroller, it's not going to be slow. That being said, it should be expected to run at decent speed on raspberry pi-level hardware.
  • Multi-threaded UI. Callback methods are blocking - careful what you're doing in there! Feel free to use threads on your side, though.
  • Complete ncurses equivalent. You can access the underlying ncurses window when creating your own custom views, so you can do what you want with that, but the main library will probably only use a subset of the ncurses features. Also, using ncurses at all is not guaranteed, as other backends are considered.

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