Support configuring submit action key in select

CHANGELOG.md

@@ -1,5 +1,15 @@
 # Change log
 
+## [v0.24.0] - 2021-??-??
+
+### Changed
+* Change #select and #multi_select to accept a :submit_keys option, instead of always defaulting to space and return
+* Change #multi_select to accept a :select_key option, instead of always defaulting to space
+
+### Fixed
+* Fix #select and #multi_select hint to print out the correct submit_keys
+* Fix typo in #slider show_help
+
 ## [v0.23.1] - 2021-04-17
 
 ### Changed

README.md

@@ -89,6 +89,7 @@ Or install it yourself as:
       * [2.6.2.5 :per_page](#2625-per_page)
       * [2.6.2.6 :disabled](#2626-disabled)
       * [2.6.2.7 :filter](#2627-filter)
+      * [2.6.2.8 :submit_keys](#2628-submit_keys)
     * [2.6.3 multi_select](#263-multi_select)
       * [2.6.3.1 :cycle](#2631-cycle)
       * [2.6.3.2 :enum](#2632-enum)
@@ -99,6 +100,8 @@ Or install it yourself as:
       * [2.6.3.7 :filter](#2637-filter)
       * [2.6.3.8 :min](#2638-min)
       * [2.6.3.9 :max](#2639-max)
+      * [2.6.3.10 :submit_keys](#26310-submit_keys)
+      * [2.6.3.11 :select_key](#262311-select_key)
     * [2.6.4 enum_select](#264-enum_select)
       * [2.6.4.1 :per_page](#2641-per_page)
       * [2.6.4.1 :disabled](#2641-disabled)
@@ -158,7 +161,7 @@ Asking question with list of options couldn't be easier using `select` like so:
 ```ruby
 prompt.select("Choose your destiny?", %w(Scorpion Kano Jax))
 # =>
-# Choose your destiny? (Use ↑/↓ arrow keys, press Enter to select)
+# Choose your destiny? (Press ↑/↓ arrow to move, Space or Enter to select)
 # ‣ Scorpion
 #   Kano
 #   Jax
@@ -636,7 +639,7 @@ By default the choice name is also the value the prompt will return when selecte
 choices = {small: 1, medium: 2, large: 3}
 prompt.select("What size?", choices)
 # =>
-# What size? (Press ↑/↓ arrow to move and Enter to select)
+# What size? (Press ↑/↓ arrow to move and Space or Enter to select)
 # ‣ small
 #   medium
 #   large
@@ -663,7 +666,7 @@ prompt.select("What size?") do |menu|
   menu.choice name: "large",  value: 3
 end
 # =>
-# What size? (Press ↑/↓ arrow to move and Enter to select)
+# What size? (Press ↑/↓ arrow to move and Space or Enter to select)
 # ‣ small
 # ✘ medium (out of stock)
 #   large
@@ -698,7 +701,7 @@ For asking questions involving list of options use `select` method by passing th
 ```ruby
 prompt.select("Choose your destiny?", %w(Scorpion Kano Jax))
 # =>
-# Choose your destiny? (Use ↑/↓ arrow keys, press Enter to select)
+# Choose your destiny? (Press ↑/↓ arrow to move and Space or Enter to select)
 # ‣ Scorpion
 #   Kano
 #   Jax
@@ -713,7 +716,7 @@ prompt.select("Choose your destiny?") do |menu|
   menu.choice "Jax"
 end
 # =>
-# Choose your destiny? (Use ↑/↓ arrow keys, press Enter to select)
+# Choose your destiny? (Press ↑/↓ arrow to move and Space or Enter to select)
 # ‣ Scorpion
 #   Kano
 #   Jax
@@ -728,7 +731,7 @@ prompt.select("Choose your destiny?") do |menu|
   menu.choice "Jax", -> { "Nice choice captain!" }
 end
 # =>
-# Choose your destiny? (Use ↑/↓ arrow keys, press Enter to select)
+# Choose your destiny? (Press ↑/↓ arrow to move and Space or Enter to select)
 # ‣ Scorpion
 #   Kano
 #   Jax
@@ -753,7 +756,7 @@ prompt.select("Choose your destiny?") do |menu|
   menu.choice "Jax", 3
 end
 # =>
-# Choose your destiny? (Use ↑/↓ arrow keys, press Enter to select)
+# Choose your destiny? (Press ↑/↓ arrow to move and Space or Enter to select)
 #   Scorpion
 #   Kano
 # ‣ Jax
@@ -766,7 +769,7 @@ You can navigate the choices using the arrow keys or define your own key mapping
 ```ruby
 prompt.select("Choose your destiny?", %w(Scorpion Kano Jax), cycle: true)
 # =>
-# Choose your destiny? (Use ↑/↓ arrow keys, press Enter to select)
+# Choose your destiny? (Press ↑/↓ arrow to move and Space or Enter to select)
 # ‣ Scorpion
 #   Kano
 #   Jax
@@ -785,7 +788,7 @@ prompt.select("Choose your destiny?") do |menu|
   menu.choice "Jax", 3
 end
 # =>
-# Choose your destiny? (Use ↑/↓ arrow or number (0-9) keys, press Enter to select)
+# Choose your destiny? (Press ↑/↓ arrow or 1-9 number to move and Space or Enter to select)
 #   1. Scorpion
 #   2. Kano
 # ‣ 3. Jax
@@ -813,7 +816,7 @@ You can configure active marker like so:
 choices = %w(Scorpion Kano Jax)
 prompt.select("Choose your destiny?", choices, symbols: { marker: ">" })
 # =>
-# Choose your destiny? (Use ↑/↓ and ←/→ arrow keys, press Enter to select)
+# Choose your destiny? (Press ↑/↓ to move and Space or Enter to select)
 # > Scorpion
 #   Kano
 #   Jax
@@ -827,7 +830,7 @@ By default the menu is paginated if selection grows beyond `6` items. To change
 letters = ("A".."Z").to_a
 prompt.select("Choose your letter?", letters, per_page: 4)
 # =>
-# Which letter? (Use ↑/↓ and ←/→ arrow keys, press Enter to select)
+# Which letter? (Press ↑/↓/←/→ arrow to move and press Space or Enter to select)
 # ‣ A
 #   B
 #   C
@@ -870,7 +873,7 @@ The disabled choice will be displayed with a cross `✘` character next to it an
 ```ruby
 prompt.select("Choose your destiny?", warriors)
 # =>
-# Choose your destiny? (Use ↑/↓ arrow keys, press Enter to select)
+# Choose your destiny? (Press ↑/↓ arrow to move and Space or Enter to select)
 # ‣ Scorpion
 #   Kano
 # ✘ Goro (injury)
@@ -887,7 +890,7 @@ To activate dynamic list searching on letter/number key presses use `:filter` op
 warriors = %w(Scorpion Kano Jax Kitana Raiden)
 prompt.select("Choose your destiny?", warriors, filter: true)
 # =>
-# Choose your destiny? (Use ↑/↓ arrow keys, press Enter to select, and letter keys to filter)
+# Choose your destiny? (Press ↑/↓ arrow to move, Space or Enter to select and letters to filter)
 # ‣ Scorpion
 #   Kano
 #   Jax
@@ -916,6 +919,52 @@ Filter characters can be deleted partially or entirely via, respectively, Backsp
 
 If the user changes or deletes a filter, the choices previously selected remain selected.
 
+#### 2.6.2.8 `:submit_keys`
+
+You can configure which key(s) submit your selection (`:space` and `:return` by default): 
+
+```ruby
+choices = %w(Scorpion Kano Jax)
+prompt.select("Choose your destiny?", choices, submit_keys: [:tab])
+# =>
+# Choose your destiny? (Press ↑/↓ to move and Tab to select)
+# ‣ Scorpion
+#   Kano
+#   Jax
+```
+
+This is particularly useful in conjunction with `:filter`, as you may have choices that include spaces.
+
+```ruby
+choices = ["Jax Sr", "Jax", "Jax Jr"]
+prompt.select("Choose your destiny?", choices, submit_keys: [:tab], filter: true)
+# =>
+# Choose your destiny? (Press ↑/↓ to move and Tab to select and letters to filter)
+# ‣ Jax Sr
+#   Jax
+#   Jax Jr
+```
+
+After the user types "Jax":
+
+```ruby
+# =>
+# Choose your destiny? (Filter: "Jax")
+# ‣ Jax Sr
+#   Jax
+#   Jax Jr
+```
+
+After the user presses space:
+```ruby
+# =>
+# Choose your destiny? (Filter: "Jax ")
+# ‣ Jax Sr
+#   Jax Jr
+```
+
+Please note that alphanumeric keys are *not* supported.
+
 ### 2.6.3 multi_select
 
 For asking questions involving multiple selection list use `multi_select` method by passing the question and possible choices:
@@ -925,7 +974,7 @@ choices = %w(vodka beer wine whisky bourbon)
 prompt.multi_select("Select drinks?", choices)
 # =>
 #
-# Select drinks? (Use ↑/↓ arrow keys, press Space to select and Enter to finish)"
+# Select drinks? (Press ↑/↓ arrow keys to move, Space/Ctrl+A|R to select (all|rev) and Enter to finish)
 # ‣ ⬡ vodka
 #   ⬡ beer
 #   ⬡ wine
@@ -1038,7 +1087,7 @@ By default the menu is paginated if selection grows beyond `6` items. To change
 letters = ("A".."Z").to_a
 prompt.multi_select("Choose your letter?", letters, per_page: 4)
 # =>
-# Which letter? (Use ↑/↓ and ←/→ arrow keys, press Space to select and Enter to finish)
+# Which letter? (Press ↑/↓/←/→ arrow keys to move, Space/Ctrl+A|R to select (all|rev) and Enter to finish)
 # ‣ ⬡ A
 #   ⬡ B
 #   ⬡ C
@@ -1065,7 +1114,7 @@ The disabled choice will be displayed with a cross `✘` character next to it an
 ```ruby
 prompt.multi_select("Choose your favourite drink?", drinks)
 # =>
-# Choose your favourite drink? (Use ↑/↓ arrow keys, press Space to select and Enter to finish)
+# Choose your favourite drink? (Press ↑/↓ arrow keys to move, Space/Ctrl+A|R to select (all|rev) and Enter to finish)
 # ‣ ⬡ bourbon
 #   ✘ sake (out of stock)
 #   ⬡ vodka
@@ -1083,7 +1132,7 @@ header use the :echo option:
 choices = %w(vodka beer wine whisky bourbon)
 prompt.multi_select("Select drinks?", choices, echo: false)
 # =>
-# Select drinks?
+# Select drinks? (Press ↑/↓ arrow keys to move, Space/Ctrl+A|R to select (all|rev) and Enter to finish)
 #   ⬡ vodka
 #   ⬢ 2) beer
 #   ⬡ 3) wine
@@ -1099,7 +1148,7 @@ To activate dynamic list filtering on letter/number typing, use the :filter opti
 choices = %w(vodka beer wine whisky bourbon)
 prompt.multi_select("Select drinks?", choices, filter: true)
 # =>
-# Select drinks? (Use ↑/↓ arrow keys, press Space to select and Enter to finish, and letter keys to filter)
+# Select drinks? (Press ↑/↓ arrow keys to move, Space/Ctrl+A|R to select (all|rev), Enter to finish and letters to filter)
 # ‣ ⬡ vodka
 #   ⬡ beer
 #   ⬡ wine
@@ -1153,6 +1202,76 @@ prompt.multi_select("Select drinks?", choices, max: 3)
 # ‣ ⬡ bourbon
 ```
 
+#### 2.6.3.10 `:submit_keys`
+
+This works similar to the [same option for `select`](#2628-submit_keys).
+You can configure which key(s) submit your selection (`:return` by default): 
+
+```ruby
+choices = %w(vodka beer wine whisky bourbon)
+prompt.multi_select("Select drinks?", choices, submit_keys: [:tab])
+# =>
+# Select drinks? vodka, beer, whisky
+#   ⬢ vodka
+#   ⬢ beer
+#   ⬡ wine
+#   ⬢ whisky
+# ‣ ⬡ bourbon
+```
+
+The user can then press the `tab` key to confirm their selection:
+```ruby
+# =>
+# Select drinks? vodka, beer, whisky
+```
+
+Please note that alphanumeric keys are *not* supported.
+
+#### 2.6.3.11 `:select_key`
+
+You can configure which key selects an option (`:space` default).
+This is particularly useful in conjunction with the `filter` option, as you may have choices that include spaces.
+
+```ruby
+choices = ["gin", "gin tonic", "gin fizz", "beer"]
+prompt.multi_select("Select drinks?", choices, filter: true, select_key: :tab)
+# =>
+# Select drinks? (Press ↑/↓ arrow keys to move, Tab/Ctrl+A|R to select (all|rev), Enter to finish and letters to filter)
+# ‣ ⬡ gin
+#   ⬡ gin tonic
+#   ⬡ gin fizz
+#   ⬡ beer
+```
+
+After the user types "gin":
+
+```ruby
+# =>
+# Select drinks? (Filter: "gin")
+# ‣ ⬡ gin
+#   ⬡ gin tonic
+#   ⬡ gin fizz
+```
+
+and then presses space:
+
+```ruby
+# =>
+# Select drinks? (Filter: "gin ")
+# ‣ ⬡ gin tonic
+#   ⬡ gin fizz
+```
+
+The user can then press the `tab` key to select the options:
+```ruby
+# =>
+# Select drinks? (Filter: "gin ")
+# ‣ ⬢ gin tonic
+#   ⬡ gin fizz
+```
+
+Please note that alphanumeric keys are *not* supported.
+
 ### 2.6.4 enum_select
 
 In order to ask for standard selection from indexed list you can use `enum_select` and pass question together with possible choices:

examples/multi_select_filtered.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "../lib/tty-prompt"
+
+prompt = TTY::Prompt.new
+
+drinks = %w[vodka beer wine whisky bourbon]
+prompt.multi_select("Choose your favourite drink?", drinks, filter: true)

examples/select_filtered_with_spaces.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "../lib/tty-prompt"
+
+prompt = TTY::Prompt.new
+
+warriors = ["Jax", "Jax Jr", "Kitana", "Raiden ft. Thunder"]
+
+answer = prompt.select("Choose your destiny?", warriors, filter: true, submit_keys: [:return, :tab])
+
+puts answer.inspect