tty-prompt 0.18.1 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4993a3639c2dec47c658cddd6a8c3d98b4efb7bec6cc3d1b90dfd184d9b6f889
-  data.tar.gz: d069f2c94118978bbfa04e54c967a0d8ce185adc6d7eb74446988350bca21d06
+  metadata.gz: 5b95f394284033f244487a624ca98d9d4aca8a1d5b01c08d181a3bbfe509aa4a
+  data.tar.gz: 32031c9ca43c3098418f54051af00bdcba6075532ba0878a3b8efda844ba076f
 SHA512:
-  metadata.gz: c1dd9287d14e3aa2eb8357d9ff759cdec52182535bc9697f97d4da7ab7c111f27ec61bfc176cc16cc7c8f4f2ca1dcd3af4784df1c82e95b0382f4cb2dc7cc782
-  data.tar.gz: 62ed0bc598c3a6b6b65ed7a5f14a7bacd769a5d46dfa041afb67d4d7a4de407e4cb5334fc25942351551414c0c29d68a9fc51aa238e198931677639c3ad4d382
+  metadata.gz: decec13d7b8a65ba78d5c2eea5ed3366976670c1a7e0ebe228c25cf5b494aa82fe3131e5521fe3c8d882d10b2db2aa6934749f1583f767630f4bf3a4fc59eb96
+  data.tar.gz: 7d1e877c0f4e1df2db06726cd8748b6e777f59cf055177d480610687db46ad7de12ee7cfe7aa454414816020bfa35ab5a1e273b680946a45d287b6563e7a1ff6

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Change log
 
+## [v0.19.0] - 2019-05-27
+
+### Added
+* Add Prompt#debug to allow displaying values in terminal's top right corner
+* Add :max to limit number of choices in #multi_select prompt
+* Add :value to pre populate #ask prompt line content
+* Add :auto_hint to expand default hint in #expand prompt by Ewoudt Kellerman(@hellola)
+* Add Timer to track and timeout code execution
+
+### Changed
+* Change Paginator to expose #start_index & #end_index
+* Change Paginator to figure out #start_index based on per page size and adjust boundaries to match active selection
+* Change #ask prompt to allow no question
+* Change #enum_select to automatically assigned non-disabled default option
+* Change #enum_select to set default choice when navigating by page
+* Change #select & #multi_select to allow navigation by page with left/right keys
+* Change #keypress to use Timer
+* Change Choice#from to allow any object coercible to string
+* Change to remove test artifacts from the gem bundle
+* Change to remove timers dependency
+* Change to update tty-reader dependency
+
 ## [v0.18.1] - 2018-12-29
 
 ### Changed
@@ -304,6 +326,7 @@
 
 * Initial implementation and release
 
+[v0.19.0]: https://github.com/piotrmurach/tty-prompt/compare/v0.18.1...v0.19.0
 [v0.18.1]: https://github.com/piotrmurach/tty-prompt/compare/v0.18.0...v0.18.1
 [v0.18.0]: https://github.com/piotrmurach/tty-prompt/compare/v0.17.2...v0.18.0
 [v0.17.2]: https://github.com/piotrmurach/tty-prompt/compare/v0.17.1...v0.17.2

data/README.md

@@ -65,12 +65,13 @@ Or install it yourself as:
   * [2.1 ask](#21-ask)
     * [2.1.1 convert](#211-convert)
     * [2.1.2 default](#212-default)
-    * [2.1.3 echo](#213-echo)
-    * [2.1.4 error messages](#214-error-messages)
-    * [2.1.5 in](#215-in)
-    * [2.1.6 modify](#216-modify)
-    * [2.1.7 required](#217-required)
-    * [2.1.8 validate](#218-validate)
+    * [2.1.3 value](#213-value)
+    * [2.1.4 echo](#214-echo)
+    * [2.1.5 error messages](#215-error-messages)
+    * [2.1.6 in](#216-in)
+    * [2.1.7 modify](#217-modify)
+    * [2.1.8 required](#218-required)
+    * [2.1.9 validate](#219-validate)
   * [2.2 keypress](#22-keypress)
     * [2.2.1 :timeout](#221-timeout)
   * [2.3 multiline](#23-multiline)
@@ -80,14 +81,19 @@ Or install it yourself as:
     * [2.6.1 choices](#261-choices)
     * [2.6.1.1 :disabled](#2611-disabled)
     * [2.6.2 select](#262-select)
-      * [2.6.2.1 :disabled](#2621-disabled)
-      * [2.6.2.2 :filter](#2622-filter)
+      * [2.6.2.1 :per_page](#2621-per_page)
+      * [2.6.2.2 :disabled](#2622-disabled)
+      * [2.6.2.3 :filter](#2623-filter)
     * [2.6.3 multi_select](#263-multi_select)
       * [2.6.3.1 :disabled](#2631-disabled)
       * [2.6.3.2 :echo](#2632-echo)
       * [2.6.3.3 :filter](#2633-filter)
+      * [2.6.3.4 :max](#2634-max)
     * [2.6.4 enum_select](#264-enum_select)
+      * [2.6.4.1 :per_page](#2641-per_page)
+      * [2.6.4.1 :disabled](#2641-disabled)
   * [2.7 expand](#27-expand)
+    * [2.7.1 auto_hint](#271-auto_hint)
   * [2.8 collect](#28-collect)
   * [2.9 suggest](#29-suggest)
   * [2.10 slider](#210-slider)
@@ -97,12 +103,13 @@ Or install it yourself as:
     * [2.11.3 error](#2113-error)
   * [2.12 keyboard events](#212-keyboard-events)
 * [3. settings](#3-settings)
-  * [3.1 active_color](#31-active_color)
-  * [3.2 enable_color](#32-enable-color)
-  * [3.3 help_color](#33-help_color)
-  * [3.4 interrupt](#34-interrupt)
-  * [3.5 prefix](#35-prefix)
-  * [3.6 track_history](#36-track_history)
+  * [3.1 :symbols](#31-symbols)
+  * [3.2 :active_color](#32-active_color)
+  * [3.3 :enable_color](#33-enable-color)
+  * [3.4 :help_color](#34-help_color)
+  * [3.5 :interrupt](#35-interrupt)
+  * [3.6 :prefix](#36-prefix)
+  * [3.7 :track_history](#37-track_history)
 
 ## 1. Usage
 
@@ -112,7 +119,7 @@ In order to start asking questions on the command line, create prompt:
 prompt = TTY::Prompt.new
 ```
 
-and then call `ask` with the question for simple input:
+And then call `ask` with the question for simple input:
 
 ```ruby
 prompt.ask('What is your name?', default: ENV['USER'])
@@ -138,7 +145,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? (Use ↑/↓ arrow keys, press Enter to select)
 # ‣ Scorpion
 #   Kano
 #   Jax
@@ -151,7 +158,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? (Use ↑/↓ arrow keys, press Space to select and Enter to finish)"
 # ‣ ⬡ vodka
 #   ⬡ beer
 #   ⬡ wine
@@ -274,7 +281,17 @@ prompt.ask('What is your name?', default: 'Anonymous')
 # What is your name? (Anonymous)
 ```
 
-#### 2.1.3 echo
+#### 2.1.3 value
+
+To pre-populate the input line for editing use `:value` option:
+
+```ruby
+prompt.ask("What is your name?", value: "Piotr")
+# =>
+# What is your name? Piotr
+```
+
+#### 2.1.4 echo
 
 To control whether the input is shown back in terminal or not use `:echo` option like so:
 
@@ -282,7 +299,7 @@ To control whether the input is shown back in terminal or not use `:echo` option
 prompt.ask('password:', echo: false)
 ```
 
-#### 2.1.4 error messages
+#### 2.1.5 error messages
 
 By default `tty-prompt` comes with predefined error messages for `required`, `in`, `validate` options.
 
@@ -294,7 +311,7 @@ prompt.ask('What is your email?') do |q|
 end
 ```
 
-or change the `messages` key entry out of `:required?`, `:valid?`, `:range?`:
+Or change the `messages` key entry out of `:required?`, `:valid?`, `:range?`:
 
 ```ruby
 prompt.ask('What is your email?') do |q|
@@ -303,7 +320,7 @@ prompt.ask('What is your email?') do |q|
 end
 ```
 
-to change default range validation error message do:
+To change default range validation error message do:
 
 ```ruby
 prompt.ask('How spicy on scale (1-5)? ') do |q|
@@ -312,7 +329,7 @@ prompt.ask('How spicy on scale (1-5)? ') do |q|
 end
 ```
 
-#### 2.1.5 in
+#### 2.1.6 in
 
 In order to check that provided input falls inside a range of inputs use the `in` option. For example, if we wanted to ask a user for a single digit in given range we may do following:
 
@@ -320,7 +337,7 @@ In order to check that provided input falls inside a range of inputs use the `in
 ask("Provide number in range: 0-9?") { |q| q.in('0-9') }
 ```
 
-#### 2.1.6 modify
+#### 2.1.7 modify
 
 Set the `:modify` option if you want to handle whitespace or letter capitalization.
 
@@ -345,7 +362,7 @@ Available whitespace settings are:
 :remove   # remove all whitespace
 ```
 
-#### 2.1.7 required
+#### 2.1.8 required
 
 To ensure that input is provided use `:required` option:
 
@@ -355,7 +372,7 @@ prompt.ask("What's your phone number?", required: true)
 # >> Value must be provided
 ```
 
-#### 2.1.8 validate
+#### 2.1.9 validate
 
 In order to validate that input matches a given patter you can pass the `validate` option. Validate setting accepts `Regex`, `Proc` or `Symbol`.
 
@@ -420,7 +437,7 @@ The `multiline` uses similar options to those supported by `ask` prompt. For exa
 prompt.multiline("Description?", default: 'A super sweet prompt.')
 ```
 
-or using DSL:
+Or using DSL:
 
 ```ruby
 prompt.multiline("Description?") do |q|
@@ -438,12 +455,12 @@ prompt.mask('What is your secret?')
 # => What is your secret? ••••
 ```
 
-The masking character can be changed by passing `:mask` option:
+The masking character can be changed by passing `:symbols` option with `:mask` key:
 
 ```ruby
-heart = prompt.decorate('❤ ', :magenta)
-prompt.mask('What is your secret?', mask: heart)
-# => What is your secret? ❤  ❤  ❤  ❤  ❤ 
+heart = prompt.decorate(prompt.symbols[:heart] + ' ', :magenta)
+prompt.mask('What is your secret?', symbols: {mask: heart})
+# => What is your secret? ❤  ❤  ❤  ❤  ❤
 ```
 
 If you don't wish to show any output use `:echo` option like so:
@@ -584,7 +601,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? (Use ↑/↓ arrow keys, press Enter to select)
 # ‣ Scorpion
 #   Kano
 #   Jax
@@ -599,7 +616,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? (Use ↑/↓ arrow keys, press Enter to select)
 # ‣ Scorpion
 #   Kano
 #   Jax
@@ -614,7 +631,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? (Use ↑/↓ arrow keys, press Enter to select)
 # ‣ Scorpion
 #   Kano
 #   Jax
@@ -638,7 +655,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? (Use ↑/↓ arrow keys, press Enter to select)
 #   Scorpion
 #   Kano
 # ‣ Jax
@@ -649,7 +666,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? (Use ↑/↓ arrow keys, press Enter to select)
 # ‣ Scorpion
 #   Kano
 #   Jax
@@ -666,7 +683,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? (Use ↑/↓ arrow or number (0-9) keys, press Enter to select)
 #   1. Scorpion
 #   2. Kano
 # ‣ 3. Jax
@@ -676,7 +693,7 @@ You can configure help message and/or marker like so
 
 ```ruby
 choices = %w(Scorpion Kano Jax)
-prompt.select("Choose your destiny?", choices, help: "(Bash keyboard)", marker: '>')
+prompt.select("Choose your destiny?", choices, help: "(Bash keyboard)", symbols: {marker: '>'})
 # =>
 # Choose your destiny? (Bash keyboard)
 # > Scorpion
@@ -684,18 +701,19 @@ prompt.select("Choose your destiny?", choices, help: "(Bash keyboard)", marker:
 #   Jax
 ```
 
+#### 2.6.1.1 `:per_page`
+
 By default the menu is paginated if selection grows beyond `6` items. To change this setting use `:per_page` configuration.
 
 ```ruby
 letters = ('A'..'Z').to_a
 prompt.select("Choose your letter?", letters, per_page: 4)
 # =>
-# Which letter? (Use arrow keys, press Enter to select)
+# Which letter? (Use ↑/↓ and ←/→ arrow keys, press Enter to select)
 # ‣ A
 #   B
 #   C
 #   D
-# (Move up or down to reveal more choices)
 ```
 
 You can also customise page navigation text using `:page_help` option:
@@ -708,7 +726,7 @@ prompt.select("Choose your letter?") do |menu|
 end
 ```
 
-#### 2.6.2.1 `:disabled`
+#### 2.6.2.2 `:disabled`
 
 To disable menu choice, use the `:disabled` key with a value that explains the reason for the choice being unavailable. For example, out of all warriors, the Goro is currently injured:
 
@@ -728,7 +746,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? (Use ↑/↓ arrow keys, press Enter to select)
 # ‣ Scorpion
 #   Kano
 # ✘ Goro (injury)
@@ -737,7 +755,7 @@ prompt.select('Choose your destiny?', warriors)
 #   Raiden
 ```
 
-#### 2.6.2.2 `:filter`
+#### 2.6.2.3 `:filter`
 
 To activate dynamic list searching on letter/number key presses use `:filter` option:
 
@@ -745,7 +763,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? (Use ↑/↓ arrow keys, press Enter to select, and letter keys to filter)
 # ‣ Scorpion
 #   Kano
 #   Jax
@@ -783,7 +801,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? (Use ↑/↓ arrow keys, press Space to select and Enter to finish)"
 # ‣ ⬡ vodka
 #   ⬡ beer
 #   ⬡ wine
@@ -887,12 +905,11 @@ 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 arrow keys, press Space to select and Enter to finish)
+# Which letter? (Use ↑/↓ and ←/→ arrow keys, press Space to select and Enter to finish)
 # ‣ ⬡ A
 #   ⬡ B
 #   ⬡ C
 #   ⬡ D
-# (Move up or down to reveal more choices)
 ```
 
 #### 2.6.3.1 `:disabled`
@@ -915,7 +932,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? (Use ↑/↓ arrow keys, press Space to select and Enter to finish)
 # ‣ ⬡ bourbon
 #   ✘ sake (out of stock)
 #   ⬡ vodka
@@ -949,7 +966,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? (Use ↑/↓ arrow keys, press Space to select and Enter to finish, and letter keys to filter)
 # ‣ ⬡ vodka
 #   ⬡ beer
 #   ⬡ wine
@@ -971,6 +988,22 @@ If the user changes or deletes a filter, the choices previously selected remain
 
 The `filter` option is not compatible with `enum`.
 
+#### 2.6.3.4 `:max`
+
+To limit the number of choices an user can select, use `:max` option:
+
+```ruby
+choices = %w(vodka beer wine whisky bourbon)
+prompt.multi_select("Select drinks?", choices, max: 3)
+# =>
+# Select drinks? (max. 3) vodka, beer, whisky
+#   ⬢ vodka
+#   ⬢ beer
+#   ⬡ wine
+#   ⬢ whisky
+# ‣ ⬡ bourbon
+```
+
 ### 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:
@@ -1030,6 +1063,8 @@ end
 # Select an editor? /usr/bin/vim
 ```
 
+#### 2.6.4.1 `:per_page`
+
 By default the menu is paginated if selection grows beyond `6` items. To change this setting use `:per_page` configuration.
 
 ```ruby
@@ -1045,11 +1080,42 @@ prompt.enum_select("Choose your letter?", letters, per_page: 4)
 # (Press tab/right or left to reveal more choices)
 ```
 
+#### 2.6.4.2 `:disabled`
+
+To make a choice unavailable use the `:disabled` option and, if you wish, as value provide a reason:
+
+```ruby
+choices = [
+  {name: "Emacs", disabled: '(not installed)'},
+  "Atom",
+  "GNU nano",
+  {name: "Notepad++", disabled: '(not installed)'},
+  "Sublime",
+  "Vim"
+]
+```
+
+The disabled choice will be displayed with a cross ✘ character next to it and followed by an explanation:
+
+
+```ruby
+prompt.enum_select('Select an editor', choices)
+# =>
+# Select an editor
+# ✘ 1) Emacs (not installed)
+#   2) Atom
+#   3) GNU nano
+# ✘ 4) Notepad++ (not installed)
+#   5) Sublime
+#   6) Vim
+#   Choose 1-6 [2]:
+```
+
 ### 2.7 expand
 
 The `expand` provides a compact way to ask a question with many options.
 
-As first argument `expand` takes the message to display and as a second an array of choices. Compared to the `select`, `multi_select` and `enum_select`, the choices need to be objects that include `:key`, `:name` and `:value` keys. The `:key` must be a single character. The help choice is added automatically as the last option and the key `h`.
+As first argument `expand` takes the message to display and as a second an array of choices. Compared to the `select`, `multi_select` and `enum_select`, the choices need to be objects that include `:key`, `:name` and `:value` keys. The `:key` must be a single character. The help choice is added automatically as the last option under the key `h`.
 
 ```ruby
 choices = [
@@ -1109,6 +1175,17 @@ If user types `h` and presses enter, an expanded view will be shown which furthe
 
 Run `examples/expand.rb` to see the prompt in action.
 
+#### 2.7.1 `:auto_hint`
+
+To show hint by default use `:auto_hint` option:
+
+```ruby
+prompt.expand('Overwrite Gemfile?', choices, auto_hint: true)
+# =>
+# Overwrite Gemfile? (enter "h" for help) [y,n,q,h]
+# >> overwrite this file
+```
+
 ### 2.8 collect
 
 In order to collect more than one answer use `collect` method. Using the `key` you can describe the answers key name. All the methods for asking user input such as `ask`, `mask`, `select` can be directly invoked on the key. The key composition is very flexible by allowing nested keys. If you want the value to be automatically converted to required type use [convert](#221-convert).
@@ -1184,12 +1261,12 @@ prompt.suggest('b', possible, indent: 4, single_text: 'Perhaps you meant?')
 
 If you have constrained range of numbers for user to choose from you may consider using `slider`.
 
-The slider provides easy visual way of picking a value marked by `O` marker. You can set `:min`(defaults to 0), `:max` and `:step`(defaults to 1) options to configure slider range:
+The slider provides easy visual way of picking a value marked by `●` symbol. You can set `:min`(defaults to 0), `:max` and `:step`(defaults to 1) options to configure slider range:
 
 ```ruby
 prompt.slider('Volume', max: 100, step: 5)
 # =>
-# Volume ──────────O────────── 50
+# Volume ──────────●────────── 50
 # (Use arrow keys, press Enter to select)
 ```
 
@@ -1198,16 +1275,16 @@ By default the slider is configured to pick middle of the range as a start value
 ```ruby
 prompt.slider('Volume', max: 100, step: 5, default: 75)
 # =>
-# Volume ───────────────O───── 75
+# Volume ───────────────●────── 75
 # (Use arrow keys, press Enter to select)
 ```
 
-You can also change the default slider formatting using the `:format`. The value must contain the `:slider` token for placing the actual animation and any `sprintf` compatible flag for number display, in our case `%d`:
+You can also change the default slider formatting using the `:format`. The value must contain the `:slider` token to show current value and any `sprintf` compatible flag for number display, in our case `%d`:
 
 ```ruby
 prompt.slider('Volume', max: 100, step: 5, default: 75, format: "|:slider| %d%")
 # =>
-# Volume |───────────────O─────| 75%
+# Volume |───────────────●──────| 75%
 # (Use arrow keys, press Enter to select)
 ```
 
@@ -1216,7 +1293,16 @@ You can also specify slider range with decimal numbers. For example, to have a s
 ```ruby
 prompt.slider("Volume", max: 10, step: 0.5, default: 5, format: "|:slider| %.1f")
 # =>
-# Volume |───────────────O─────| 7.5
+# Volume |───────────────●──────| 7.5
+# (Use arrow keys, press Enter to select)
+```
+
+If you wish to change the slider handle and the slider range display use `:symbols` option:
+
+```ruby
+prompt.slider("Volume", max: 100, step: 5, default: 75, symbols: {bullet: 'x', line: '_'})
+# =>
+# Volume _______________x______ 75%
 # (Use arrow keys, press Enter to select)
 ```
 
@@ -1230,13 +1316,13 @@ prompt.slider('What size?') do |range|
   range.format "|:slider| %d%"
 end
 # =>
-# Volume |───────────────O─────| 75%
+# Volume |───────────────●──────| 75%
 # (Use arrow keys, press Enter to select)
 ```
 
 ### 2.11 say
 
-To simply print message out to stdout use `say` like so:
+To simply print message out to standard output use `say` like so:
 
 ```ruby
 prompt.say(...)
@@ -1324,7 +1410,32 @@ The available events are:
 
 ## 3 settings
 
-### 3.1 active_color
+### 3.1. `:symbols`
+
+Many prompts use symbols to display information. You can overwrite the default symbols for all the prompts using the `:symbols` key and hash of symbol names as value:
+
+```ruby
+prompt = TTY::Prompt.new(symbols: {marker: '>'})
+```
+
+The following symbols can be overwritten:
+
+| Symbols     | Unicode | ASCII |
+| ----------- |:-------:|:-----:|
+|  tick       | `✓`     | `√`   |
+|  cross      | `✘`     | `x`   |
+|  marker     | `‣`     | `>`   |
+|  dot        | `•`     | `.`   |
+|  bullet     | `●`     | `O`   |
+|  line       | `─`     | `-`   |
+|  radio_on   | `⬢`     | `(*)` |
+|  radio_off  | `⬡`     | `( )` |
+|  arrow_up   | `↑`     | `↑`   |
+|  arrow_down | `↓`     | `↓`   |
+|  arrow_left | `←`     | `←`   |
+|  arrow_right| `→`     | `→`   |
+
+### 3.2 `:active_color`
 
 All prompt types support `:active_color` option. In case of `select`, `multi_select`, `enum_select` or `expand` this color is used to highlight the currently selected choice. All the resulted inputs provided by user that are read in by the prompt as answer are highlighted with this color. This option can be applied either globally for all prompts or individually.
 
@@ -1340,7 +1451,7 @@ prompt.select('What size?', %w(Large Medium Small), active_color: :cyan)
 
 Please [see pastel](https://github.com/piotrmurach/pastel#3-supported-colors) for all supported colors.
 
-### 3.2 enable_color
+### 3.3 `:enable_color`
 
 If you wish to disable coloring for a prompt simply pass `:enable_color` option
 
@@ -1348,7 +1459,7 @@ If you wish to disable coloring for a prompt simply pass `:enable_color` option
 prompt = TTY::Prompt.new(enable_color: true)
 ```
 
-### 3.3 help_color
+### 3.4 `:help_color`
 
 Prompts such as `select`, `multi_select`, `expand` support `:help_color` which is used to customize the help text. This option can be applied either globally for all prompts or individually.
 
@@ -1362,7 +1473,7 @@ or per individual input do:
 prompt.select('What size?', %w(Large Medium Small), help_color: :cyan)
 ```
 
-### 3.4 interrupt
+### 3.5 `:interrupt`
 
 By default `InputInterrupt` error will be raised when the user hits the interrupt key(Control-C). However, you can customise this behaviour by passing the `:interrupt` option. The available options are:
 
@@ -1377,7 +1488,7 @@ For example, to send interrupt signal do:
 prompt = TTY::Prompt.new(interrupt: :signal)
 ```
 
-### 3.5 prefix
+### 3.6 `:prefix`
 
 You can prefix each question asked using the `:prefix` option. This option can be applied either globally for all prompts or individual for each one:
 
@@ -1385,7 +1496,7 @@ You can prefix each question asked using the `:prefix` option. This option can b
 prompt = TTY::Prompt.new(prefix: '[?] ')
 ```
 
-### 3.6 track_history
+### 3.7 `:track_history`
 
 The prompts that accept line input such as `multiline` or `ask` provide history buffer that tracks all the lines entered during `TTY::Prompt.new` interactions. The history buffer provides previous or next lines when user presses up/down arrows respectively. However, if you wish to disable this behaviour use `:track_history` option like so: