https://github.com/sayanarijit/tui-input

TUI input library supporting multiple backends, tui-rs and ratatui
https://github.com/sayanarijit/tui-input

crossterm input ratatui terminal termion tui tui-rs

Last synced: 15 days ago
JSON representation

TUI input library supporting multiple backends, tui-rs and ratatui

• Host: GitHub
• URL: https://github.com/sayanarijit/tui-input
• Owner: sayanarijit
• License: mit
• Created: 2021-11-04T06:24:38.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-25T08:43:42.000Z (6 months ago)
• Last Synced: 2024-10-29T10:55:30.058Z (6 months ago)
• Topics: crossterm, input, ratatui, terminal, termion, tui, tui-rs
• Language: Rust
• Homepage:
• Size: 63.5 KB
• Stars: 124
• Watchers: 3
• Forks: 12
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# tui-input

[![Crate Status](https://img.shields.io/crates/v/tui-input.svg)](https://crates.io/crates/tui-input)

[![Docs Status](https://docs.rs/tui-input/badge.svg)](https://docs.rs/tui-input/)

[![tui-input.gif](https://s10.gifyu.com/images/tui-input.gif)](https://github.com/sayanarijit/tui-input/blob/main/examples/ratatui-input/src/main.rs)

A TUI input library supporting multiple backends.

This crate can be used with [tui-rs](https://github.com/fdehau/tui-rs) and [ratatui](https://github.com/tui-rs-revival/ratatui).

For people using `tui-rs` use version `v0.6.*` for people migrating to `ratatui` use latest version.

## Install

Cargo.toml

```toml

# crossterm

tui-input = "*"

# termion

tui-input = { version = "*", features = ["termion"], default-features = false }

```

## Features

- crossterm (default)

- termion

- serde

## Demo

See [examples](https://github.com/sayanarijit/tui-input/tree/main/examples).

```bash

# Run the example with crossterm as backend.

cargo run --example crossterm_input

# Run the example with termion as backend.

cargo run --example termion_input --features termion

# Run the tui-rs example

(cd ./examples/ratatui-input/ && cargo run)

```