Skip to content

Latest commit

 

History

History
52 lines (34 loc) · 2.01 KB

README.md

File metadata and controls

52 lines (34 loc) · 2.01 KB
Raw

sanguine

Create dynamic, performant TUI applications in Rust.

Sanguine was created from the need for a library tailored for window/layout-based TUI applications such as text editors and terminal multiplexers. The Rust ecosystem contains many great crates for building TUI apps, but many are geared towards smaller applications and don't easily allow for complex layouts to be modified at runtime.

Sanguine implements a tree-based layout API that can be updated at runtime, with a simple, custom constraint algorithm geared towards rendering to the terminal. Layout results are cached between renders for performance, and are only recomputed when the layout is changed. Widgets can be nested and mouse events are handled properly for widgets at any depth - widgets only need to handle mouse events based on local position. Widgets can optionally specify a cursor location to allow for implementations of text editor windows and more.

It is built on top of Termwiz' BufferedTerminal, which optimizes terminal writes to maximize performance.

Features:

  • Dynamic, Tree-based layout API
  • Extensible widget trait
  • First-class mouse events support
    • Automatic propagation
    • Hover and click support
  • Global and widget-local event handlers
  • Generic API
    • Custom user event type for message passing
    • Custom state type for core app state
  • Focus
    • Switch focus by direction or directly

Demo

SanguineDemoMenu.mp4
Demo Usage 
$ git clone git@github.com:willothy/sanguine.git

$ cd sanguine

$ cargo run --example demo

Keymaps:

  • Control + q: Quit
  • Shift + Tab: Cycle focus
  • Shift + Up/Down/Left/Right: Switch focus by direction
  • Up/Down/Left/Right: Switch menu item
  • Enter: Select menu item