selthi

Crates.ioselthi
lib.rsselthi
version0.2.7
sourcesrc
created_at2024-06-05 11:56:18.544773
updated_at2024-08-02 15:24:44.53062
descriptionA Rust library for building interactive prompts
homepage
repositoryhttps://github.com/anotherlusitano/selthi
max_upload_size
id1262687
size754,493
João Ribeiro (anotherlusitano)

documentation

README

Selthi

Latest Version Docs License

selthi is a library for building interactive prompts, inspired by inquire.

It provides two prompts, one for asking the user to select one option from a given list, with the ability to display images for each option, and other prompt for asking the user for a string.

Demo

Animated GIF making a demonstration of this library

Source

Examples

Examples can be found in the examples directory. Run them to see basic behavior:

cargo run --example images --features with_images

Usage

Add Selthi to your dependencies.

cargo add selthi

* If you want to support images, add the feature with_images

selthi = { version = "0.2.7", features = ["with_images"] }

Prompts

Currently, there are 2 different prompt types supported.

Input

Input displays a message to the user, prompting them to type something back. The user's input is then stored in a String and returned to the prompt caller.

let ans = Input::new("What's your name?").prompt();

match ans {
  Some(name) => println!("Hello {}!", name),
  None => println!("There was an error, please try again"),
}

Animated GIF making a demonstration of a simple prompt with Input created with this library.

Select

Select prompts are suitable for when you need the user to select one option among many.

    let options: Vec<&str> = vec![
        "Rust",
        "C",
        "C++",
        "Javascript",
        "Java",
        "C#",
        "Python",
        "Haskell",
        "Lisp",
        "Erlang",
    ];
    let ans = Select::new("What's your favorite programming language?", options).prompt();

    match ans {
        Some(language) => println!("{} rocks!", language),
        None => println!("There was an error, please try again"),
    }

Animated GIF making a demonstration of a simple prompt with Input created with this library.

You can also display images when users are choosing the options.

    let options: Vec<&str> = vec!["Linux", "Windows", "macOS"];
    let images: Vec<&str> = vec![
        "./examples/images/linux.png",
        "./examples/images/windows.png",
        "./examples/images/macos.png",
    ];

    let ans = Select::new("What's your favorite operating system?", options)
        .with_images(images)
        .without_help_message()
        .prompt();

    match ans {
        Some(os) => println!("{} is a good choice!", os),
        None => println!("There was an error, please try again"),
    }
Commit count: 32

cargo fmt