Aptivi - Deprecated Manuals
ProjectsWebsiteBlog
Terminaux 2.x - Manual
Terminaux 2.x - Manual
  • 👋Welcome!
  • 🥛Breaking changes
    • ⬆️API v1.0
    • ⬆️API v2.0
  • Usage
    • 💡Preface
    • 🖥️Console Tools
      • ✅Console Checker
        • ☑️Console Size Requirements
      • 🔌Console Wrapper
      • ⌨️Interactive TUI
      • 🖊️Console Writers
      • 🌈Console Colors
      • 📺Console Screen
      • ☎️Console Resize Listener
      • 📽️Presentation System
    • 🖱️Input Reader
      • ⌨️Keybindings
      • 🔌Custom bindings
      • ⚙️Reader Settings
    • 🎨Color Sequences
      • ⛱️Color Model Conversions
      • 🧭Color Model Parsing
      • 🖌️Interop with System.Drawing.Color
      • 🎨Color Wheel
    • 🖊️Figlet Font Selector
  • Report an issue
  • Source code
  • Our projects
  • API Reference
Powered by GitBook
On this page
  • Reading an input
  • Other console tools
Edit on GitHub
  1. Usage

Preface

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(bool interruptible = false)

  • Read(string, bool interruptible = false)

  • Read(string, string, bool, bool, bool interruptible = false)

  • ReadPassword(bool interruptible = false)

  • ReadPassword(string, bool interruptible = false)

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.

Other console tools

For other console tools that Terminaux provides, you can access the below page:

💡
🖱️Input Reader
⌨️Keybindings
🎨Color Sequences
🎨Color Wheel
🖊️Figlet Font Selector
🖥️Console Tools