choice-based-inputs.md

icon	description
pen	Select your choice

Choice-based inputs

Terminaux provides a choice-based input style group that has several styles that present the choices in different shapes, such as informational boxes and selection styles. These inputs simplify the way you present your choices for applications to perform a specific action based on a selected choice.

{% hint style="info" %} You can group instances of InputChoiceInfo classes using an array of InputChoiceCategoryInfo instances that provide the category name and a list of choice group instances, InputChoiceGroupInfo, that also provide the group name and a list of input choices. {% endhint %}

Choices

Input choices are required to make use of all choice-based input methods that use the InputChoiceInfo class instances, which you can define them yourself. You can define them using the following variables in a constructor:

• Required variables
  • Choice name: Name of the choice, which is usually an index number.
  • Choice title: Title of the choice that summarizes the choice.
• Optional variables
  • Choice description: Description of the choice that describes even further about the choice and what it represents.
  • Choice default: Determines whether this choice is a default choice or not.
  • Choice default selected: Determines whether the choice is a selected choice by default for multiple choice selections or not.
  • Choice disabled: Determines whether this choice is a disabled choice or not.

{% hint style="warning" %} There may be only one default choice, but in case you have defined multiple choices as default, the first choice that has been set as default is selected as default, ignoring all the other defaults. A disabled choice may not be a default choice. {% endhint %}

In general, if you have an array of choices that is represented either as a tuple of both the choice name and the choice title, or as an array of choice title names, you can use the InputChoiceTools class to generate an array of InputChoiceInfo instances quickly.

• GetInputChoices(string[] Answers)
• GetInputChoices((string, string)[] Answers)

All inputs that use the InputChoiceInfo instances are mentioned here:

• Choice
  • One line
  • Two lines
  • Modern
• Informational boxes
  • Buttons
  • Selection
  • Multiple choices
• Selection
  • Single choice
  • Multiple choices

{% hint style="danger" %} All input styles that use choices must require that at least one of the choices is enabled by default. Otherwise, an exception will be thrown. {% endhint %}

Normal choice style

This is the simplest choice style that doesn't use any kind of screen or fancy aesthetics to provide you with the choices. This style is found in the ChoiceStyle class, but it only supports single answer. This style presents the choices in the following forms:

• Single line: Presents you with a question and a list of choices in a single line.
• Multi line: Presents you with a question and a list of choices in two lines.
• Modern: Presents you with a question and a list of choices in a modern way.

This style supports either answers that require a single letter to be pressed or answers that require more than a letter, which is what PressEnter in a ChoiceStyleSettings instance does. Here's how will the normal choice style use the InputChoiceInfo instance in terms of required variables:

• Choice names represent the answers that you'll have to answer with.
• Choice titles are shown only in the modern choice style.

You can customize the choice style using an instance of ChoiceStyleSettings, which you can easily make an instance of. This class comes with the following settings:

• Choice output type: One line, two lines, or modern.
• Press Enter: Enable if your choice names have multiple letters. It allows the input to consist of multiple characters.
• Color settings: Consists of properties that allow you to change the style colors:
  • Question color
  • Input color
  • Option color
  • Alternative option color
  • Disabled option color

{% hint style="info" %} Alternative answers are separate from the main answers, and are completely optional. {% endhint %}

Choice-based infoboxes

You can access information from here:

{% content-ref url="../../console-tools/console-writers/informational-boxes.md" %} informational-boxes.md {% endcontent-ref %}

Selection style

Selection style input method uses choices to present you with a full-screen interactive choice selector powered by the textual UI feature. This style allows you to select a choice interactively. This style is found in the SelectionStyle and the SelectionMultipleStyle classes for both the single-choice selection style and the multiple-choice selection style, respectively.

{% hint style="info" %} All selection style answers return the following:

• A one-based answer number if it's a single selection.
• A zero-based array of answer numbers if it's a multiple selection.

Write your code accordingly to avoid errors. {% endhint %}

Your selection style is customizable, because these classes contain a settings argument that uses SelectionStyleSettings. You can easily make a class instance out of it to customize the selection style to match your application's aesthetics. This class contains a singleton property that serves as a global settings for the selection input settings. This class currently contains the following color settings:

• Question
• Slider
• Input
• Option
• Alternative Option
• Selected Option
• Disabled Option
• Separator
• Text

{% hint style="info" %} Here are some tips that apply to selection style inputs:

• The overloads that contain a settings argument let you pass your custom settings to the current selection style invocation, while the overloads that don't contain this parameter use the global settings.
• In multiple choice selections, you can press A to select all the choices. You can also press F to initiate a regular expression search for long choice selections to point you quickly to the desired choice.
• You can press P to show the current choice selection count and the current page count, as well as total choices and pages. {% endhint %}

If you want to render the selection panel, you may want to use the SelectionInputTools class, which all selection styles internally use, that contains the RenderSelections() function with the following arguments:

• List of selections
• Zero-based left and top position for the upper left corner
• Current selection index
• (optional) List of zero-based current selection numbers (for multiple choice selection)
• One-based count of choices to be displayed in a single panel
• Width of the selection panel
• (optional) Whether to render the slider inside or outside
• (optional) Alternate choice position (zero-based) that is a marker for the start of the alternate choice
• (optional) Whether to swap the selected choice color or not
• (optional) Selection element colors that are of the following:
  • Foreground color of the unselected item
  • Background color of the unselected item
  • Foreground color of the selected item
  • Background color of the selected item
  • Foreground color of the unselected alternate item
  • Background color of the unselected alternate item
  • Foreground color of the selected alternate item
  • Background color of the selected alternate item
  • Foreground color of the disabled item
  • Background color of the disabled item
  • Background color of the overall UI

{% hint style="info" %} If you want to get more information about an item that you've selected, either press TAB, or open the sidebar using the S key and navigate through it using the E and the D keys.

{% endhint %}