term-kit 0.2.1

A simple terminal UI toolkit for Rust
Documentation

TermKit

A simple terminal widget kit made in Rust.

Features

Using crossterm for terminal manipulation, TermKit gives you drop-in widgets for your CLI or terminal applications.

Widgets Available

[!NOTE] Linux and MacOS is tested with the Ghostty Terminal, and Windows is tested with the Windows Terminal. If you find any bugs, on other terminals please open an issue.

  • infobox: A simple infobox widget that displays a message in the terminal.
    • Color Customization
    • Padding Customization
    • Linux + Windows + MacOS
  • listselector: A list selector widget that allows you to select an item from a list.
    • Color Customization
    • Linux + MacOS
    • Windows
  • progressbar: A progress bar widget that displays a progress bar in the terminal.
    • Color Customization
    • Linux + Windows + MacOS
  • spinner: A spinner widget that displays a spinner in the terminal.
    • Color Customization
    • Linux + Windows + MacOS
  • meter: A meter that displays quantative and changing data in the terminal.
    • gatekept behind full-tui-interface feature
    • Color Customization
    • Linux + Windows + MacOS
  • prompt: A prompt widget that displays a prompt with configurable options in the terminal.
    • Color Customization
    • Linux + MacOS
    • Windows (untested, may have the same problems as the listselector)
  • table: A table widget that displays a table in the terminal.

and more per request

Usage

Add this to your Cargo.toml:

[dependencies]
term-kit = "*"

and refer to the examples for usage.

License

Licensed under the MIT license.