class TUI::EnumField

Overview

Single-select from a fixed Array(FormEnumOption), tracked by @focus_index — focus and selection are the same thing here, unlike FlagsField where they're independent. Wire format is the focused option's wire_value (see #value/#start); #value falls back to "" if @options is empty or @focus_index is somehow out of range, rather than raising. Up/Down move focus; Space or Enter commit; Esc cancels without writing back, per FormField's stated rationale that a picker with nothing chosen yet has no sensible commit value.

Defined in:

tui/form/enum_field.cr

Constructors

Instance Method Summary

Instance methods inherited from class TUI::FormField

handle_key(ev : KeyEvent) : Symbol | Nil handle_key, render(buffer : Buffer, y : Int32, x : Int32, width : Int32, height : Int32 = 1, focused : Bool = true) : Nil render, start(current_value : String) : Nil start, status_hint : String status_hint, value : String value

Constructor Detail

def self.new(options : Array(FormEnumOption)) #

[View source]

Instance Method Detail

def handle_key(ev : KeyEvent) : Symbol | Nil #
Description copied from class TUI::FormField

Returns :commit or :cancel once the edit finishes; nil while it's still in progress (the key was consumed either way).


[View source]
def render(buffer : Buffer, y : Int32, x : Int32, width : Int32, height : Int32 = 1, focused : Bool = true) : Nil #
Description copied from class TUI::FormField

Draws this field's current edit state. height bounds how many buffer rows this field may draw into. focused gates any keyboard-cursor decoration that should be suppressed when rendering a persisted value outside an active edit session (only FlagsField uses this — see its #render).


[View source]
def start(current_value : String) : Nil #
Description copied from class TUI::FormField

Loads a persisted wire-value string into this field's edit state.


[View source]
def status_hint : String #
Description copied from class TUI::FormField

Fragment of a host's status-bar hint describing this field's own key bindings while it's being edited — owned here (rather than left for a host to re-derive per kind) so the bindings shown to the user can never drift from what #handle_key actually does.


[View source]
def value : String #
Description copied from class TUI::FormField

The composed value after a :commit result.


[View source]