/textual-inputs

Textual Inputs is a collection of input widgets for the Textual TUI framework.

Primary LanguagePythonMIT LicenseMIT

Textual Inputs 🔡

Python Versions License: MIT Code style: black Imports: isort

Textual Inputs is a collection of input widgets for the Textual TUI framework.

⚠️ This library is experimental and its interfaces are likely to change, much like the underlying Textual library.

Supported Widgets

TextInput 🔡

  • value - string
  • one line of text
  • placeholder and title support
  • password mode to hide input
  • support for ASCII printable characters
  • controls: arrow right/left, home, end, delete, backspace/ctrl+h, escape
  • emits - InputOnChange, InputOnFocus messages

IntegerInput 🔢

  • value - integer or None
  • placeholder and title support
  • type a number or arrow up/down to increment/decrement the integer.
  • controls: arrow right/left, home, end, delete, backspace/ctrl+h, escape
  • emits - InputOnChange, InputOnFocus messages

Quick Start

python -m pip install textual-inputs

Checkout the examples for reference.

git clone https://github.com/sirfuzzalot/textual-inputs.git
cd textual-inputs
python3 -m venv venv
source venv/bin/activate
python -m pip install -r requirements.txt
python examples/simple_form.py

To use Textual Inputs

from textual_inputs import TextInput, IntegerInput