term-kit

Crates.ioterm-kit
lib.rsterm-kit
version0.2.5
created_at2024-06-24 23:11:11.378023+00
updated_at2025-02-26 04:10:44.518343+00
descriptionA simple terminal UI toolkit for Rust
homepagehttps://github.com/tylercritchlow/termkit
repositoryhttps://github.com/tylercritchlow/termkit
max_upload_size
id1282805
size84,223
Tyler Critchlow (tylercritchlow)

documentation

README

TermKit

TermKit Logo

A set of drop in terminal widgets 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
  • list selector: A list selector widget that allows you to select an item from a list.
    • Color Customization
    • Linux + Windows + MacOS
  • progressbar: A progress bar widget that displays a progress bar in the terminal.
    • Color Customization
    • Linux + Windows + MacOS
  • progressbar manager: A progress bar manager that helps manage multiple progress bars 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 quantitative and changing data in the terminal.
    • kept 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 + Windows + MacOS
  • table: A table widget that displays a table in the terminal.
    • Color Customization
    • Linux + Windows + MacOS

and more per request

Usage

Add this to your Cargo.toml:

[dependencies]
term-kit = "0.2.5"

and refer to the examples for usage.

License

Licensed under the MIT license. See LICENSE for more information.

Commit count: 38

cargo fmt