Class: Clack::Prompts::SelectKey

Inherits:
Core::Prompt show all
Defined in:
lib/clack/prompts/select_key.rb

Overview

Quick selection via keyboard shortcuts.

Each option has an associated key. Pressing that key immediately selects the option and submits (running validate: and transform: like every other prompt).

Options format:

  • { value: "x", label: "Do X", key: "x" } - explicit key
  • { value: "create", label: "Create" } - key defaults to first char
  • { create: "Create", quit: "Quit" } - Hash shorthand (value => label, key defaults to first char)
  • { create: { label: "New project", key: "n" } } - Hash shorthand with explicit key

Examples:

Basic usage

action = Clack.select_key(
  message: "What to do?",
  options: [
    { value: "create", label: "Create new", key: "c" },
    { value: "open", label: "Open existing", key: "o" },
    { value: "quit", label: "Quit", key: "q" }
  ]
)

Constant Summary

Constants inherited from Core::Prompt

Core::Prompt::MIN_TERMINAL_WIDTH

Instance Attribute Summary

Attributes inherited from Core::Prompt

#error_message, #state, #value, #warning_message

Instance Method Summary collapse

Methods inherited from Core::Prompt

flush_resize, register, #request_redraw, #run, setup_signal_handler, unregister

Constructor Details

#initialize(message:, options:, case_sensitive: false, initial_value: nil, **opts) ⇒ SelectKey

Returns a new instance of SelectKey.

Parameters:

  • message (String) —

    the prompt message

  • options (Array<Hash>, Hash) —

    options with :value, :label, and optionally :key, :hint, or a Hash of value => label (or value => key:, hint:)

  • case_sensitive (Boolean) (defaults to: false) —

    match keys exactly instead of case-insensitively (default: false)

  • initial_value (Object, nil) (defaults to: nil) —

    value of the option highlighted at start; Enter submits it. The highlight is a color effect, so when colors are off mark the default in that option's hint:. A value that matches no option is ignored with a warning on stderr.

  • opts (Hash) —

    additional options passed to Core::Prompt



36
37
38
39
40
41
42
 
# File 'lib/clack/prompts/select_key.rb', line 36

def initialize(message:, options:, case_sensitive: false, initial_value: nil, **opts)
  super(message:, **opts)
  @options = normalize_options(options)
  @case_sensitive = case_sensitive
  @option_index = find_initial_index(initial_value)
  @value = current_option&.value
end