Aptivi - Deprecated Manuals
ProjectsWebsiteBlog
Terminaux 1.x - Manual
Terminaux 1.x - Manual
  • 👋Welcome!
  • 🥛Breaking changes
  • Usage
    • 🖥️How to use
      • 🖱️Input Reader
        • ⌨️Keybindings
        • 🔌Custom bindings
        • ⚙️Reader Settings
      • ⌨️Interactive TUI
      • 🎨Color Sequences
      • 🎨Color Wheel
      • 🖊️Console Writers
      • 🖊️Figlet Font Selector
      • 🗑️VT Sequences
      • 🖥️Console Size Requirements
    • ⚒️How it works
      • 🪛Input Reader Internals
      • 🔧Color Sequences Internals
      • ⛏️Color Wheel Internals
      • 🔨VT Sequences Internals
  • 🧱Project Dependencies
  • Report an issue
  • Source code
  • Our projects
  • API Reference
Powered by GitBook
On this page
Edit on GitHub
  1. Usage

How to use

How do you use it?

To use this library, you first need to know exactly why do you need to install Terminaux into your console application. If your application is intended to be an interactive one, or if your application shows graphics (text, info box, ...), then Terminaux is the right library for you.

Terminaux provides several terminal actions, like reading an input (was on TermRead), getting color information (was on ColorSeq), and using VT sequences and filtering them (was on VT.NET).

For complete overview of functionality, consult the below pages:

Reading an input

Just use the Terminaux.Reader class that contains:

  • Read()

  • Read(string)

  • Read(string, string, bool, bool)

  • ReadPassword()

  • ReadPassword(string)

Each one of these functions creates a reader state, TermReaderState, that contains essential information about the current reader state, including, but not limited to:

  • Current text

  • Input prompt text

  • Current text position

  • Kill buffer

Any key will append the selected characters to the current text input, and RETURN will accept the input. For more information about key bindings, go to the below page.

🖥️
🖱️Input Reader
⌨️Keybindings
🎨Color Sequences
🗑️VT Sequences
🎨Color Wheel
🖊️Console Writers
🖊️Figlet Font Selector
🖥️Console Size Requirements