Table of Contents - tty-prompt-0.23.1 Documentation
Pages
-
CHANGELOG
- Change log
- v0.23.1 - 2021-04-17
- Changed
- Fixed
- v0.23.0 - 2020-12-14
- Added
- Changed
- Fixed
- v0.22.0 - 2020-07-20
- Added
- Changed
- Fixed
- v0.21.0 - 2020-03-08
- Added
- Changed
- Fixed
- v0.20.0 - 2019-11-24
- Changed
- Fixed
- v0.19.0 - 2019-05-27
- Added
- Changed
- v0.18.1 - 2018-12-29
- Changed
- Fixed
- v0.18.0 - 2018-11-24
- Changed
- Fixed
- v0.17.2 - 2018-11-01
- Fixed
- v0.17.1 - 2018-10-03
- Change
- Fixed
- v0.17.0 - 2018-08-05
- Changed
- v0.16.1 - 2018-04-29
- Fixed
- v0.16.0 - 2018-03-11
- Added
- Changed
- Fixed
- v0.15.0 - 2018-02-08
- Added
- Changed
- v0.14.0 - 2018-01-01
- Added
- Changed
- Fixed
- v0.13.2 - 2017-08-30
- Changed
- v0.13.1 - 2017-08-16
- Added
- Changed
- Fix
- v0.13.0 - 2017-08-11
- Changed
- Fixed
- v0.12.0 - 2017-03-19
- Added
- Changed
- Fixed
- v0.11.0 - 2017-02-26
- Added
- Changed
- Fixed
- v0.10.1 - 2017-02-06
- Fixed
- v0.10.0 - 2017-01-01
- Added
- Changed
- v0.9.0 - 2016-12-20
- Added
- Fixed
- v0.8.0 - 2016-11-29
- Added
- Fixed
- v0.7.1 - 2016-08-07
- Fixed
- v0.7.0 - 2016-07-17
- Added
- Changed
- Fixed
- v0.6.0 - 2016-05-21
- Changed
- Fixed
- v0.5.0 - 2016-03-28
- Added
- Changed
- Fixed
- v0.4.0 - 2016-02-08
- Added
- Changed
- v0.3.0 - 2015-12-28
- Added
- Changed
- v0.2.0 - 2015-11-23
- Added
- Changed
- v0.1.0 - 2015-11-01
- LICENSE
-
README
- TTY::Prompt
- Features
- Windows support
- Installation
- Contents
- 1. Usage
- 2. Interface
- 2.1 ask
- 2.1.1
:convert
- 2.1.2
:default
- 2.1.3
:value
- 2.1.4
:echo
- 2.1.5 error messages
- 2.1.6
:in
- 2.1.7
:modify
- 2.1.8
:required
- 2.1.9
:validate
- 2.2. keypress
- 2.2.1 timeout
- 2.3 multiline
- 2.4 mask
- 2.5 yes?/no?
- 2.6 menu
- 2.6.1 choices
- 2.6.1.1
:disabled
- 2.6.2 select
- 2.6.2.1
:cycle
- 2.6.2.2
:enum
- 2.6.2.3
:help
- 2.6.2.4
:marker
- 2.6.2.5
:per_page
- 2.6.2.6
:disabled
- 2.6.2.7
:filter
- 2.6.3 multi_select
- 2.6.3.1
:cycle
- 2.6.3.2
:enum
- 2.6.3.3
:help
- 2.6.3.4
:per_page
- 2.6.3.5
:disabled
- 2.6.3.6
:echo
- 2.6.3.7
:filter
- 2.6.3.8
:min
- 2.6.3.9
:max
- 2.6.4 enum_select
- 2.6.4.1
:per_page
- 2.6.4.2
:disabled
- 2.7 expand
- 2.7.1
:auto_hint
- 2.8 collect
- 2.9 suggest
- 2.10 slider
- 2.11 say
- 2.11.1 ok
- 2.12.2 warn
- 2.11.3 error
- 2.12 keyboard events
- 3 settings
- 3.1.
:symbols
- 3.2
:active_color
- 3.3
:enable_color
- 3.4
:help_color
- 3.5
:interrupt
- 3.6
:prefix
- 3.7
:quiet
- Contributing
- Copyright
- TTY::Prompt
Classes and Modules
- TTY
- TTY::Prompt
- TTY::Prompt::AnswersCollector
- TTY::Prompt::BlockPaginator
- TTY::Prompt::Choice
- TTY::Prompt::Choices
- TTY::Prompt::ConfirmQuestion
- TTY::Prompt::Const
- TTY::Prompt::ConverterDSL
- TTY::Prompt::ConverterRegistry
- TTY::Prompt::Converters
- TTY::Prompt::Distance
- TTY::Prompt::EnumList
- TTY::Prompt::Evaluator
- TTY::Prompt::Expander
- TTY::Prompt::Keypress
- TTY::Prompt::List
- TTY::Prompt::MaskQuestion
- TTY::Prompt::MultiList
- TTY::Prompt::Multiline
- TTY::Prompt::Paginator
- TTY::Prompt::Question
- TTY::Prompt::Question::Checks
- TTY::Prompt::Question::Checks::CheckConversion
- TTY::Prompt::Question::Checks::CheckDefault
- TTY::Prompt::Question::Checks::CheckModifier
- TTY::Prompt::Question::Checks::CheckRange
- TTY::Prompt::Question::Checks::CheckRequired
- TTY::Prompt::Question::Checks::CheckValidation
- TTY::Prompt::Question::Modifier
- TTY::Prompt::Question::Validation
- TTY::Prompt::Result
- TTY::Prompt::Result::Failure
- TTY::Prompt::Result::Success
- TTY::Prompt::SelectedChoices
- TTY::Prompt::Slider
- TTY::Prompt::Statement
- TTY::Prompt::StringIOExtensions
- TTY::Prompt::Suggestion
- TTY::Prompt::Symbols
- TTY::Prompt::Test
- TTY::Prompt::Timer
- TTY::Prompt::Timer::Process
- TTY::Utils
Methods
- ::[] — TTY::Prompt::Choices
- ::call — TTY::Prompt::Question::Checks::CheckModifier
- ::call — TTY::Prompt::Question::Checks::CheckRange
- ::call — TTY::Prompt::Question::Checks::CheckValidation
- ::call — TTY::Prompt::Question::Checks::CheckDefault
- ::call — TTY::Prompt::Question::Checks::CheckRequired
- ::call — TTY::Prompt::Question::Checks::CheckConversion
- ::cast — TTY::Prompt::Question::Checks::CheckRange
- ::cast_to_num — TTY::Prompt::Converters
- ::convert_array — TTY::Prompt::Choice
- ::convert_hash — TTY::Prompt::Choice
- ::float? — TTY::Prompt::Question::Checks::CheckRange
- ::from — TTY::Prompt::Choice
- ::int? — TTY::Prompt::Question::Checks::CheckRange
- ::letter_case — TTY::Prompt::Question::Modifier
- ::messages — TTY::Prompt
- ::new — TTY::Prompt
- ::new — TTY::Prompt::AnswersCollector
- ::new — TTY::Prompt::Choice
- ::new — TTY::Prompt::Choices
- ::new — TTY::Prompt::ConfirmQuestion
- ::new — TTY::Prompt::ConverterRegistry
- ::new — TTY::Prompt::EnumList
- ::new — TTY::Prompt::Evaluator
- ::new — TTY::Prompt::Expander
- ::new — TTY::Prompt::Keypress
- ::new — TTY::Prompt::List
- ::new — TTY::Prompt::MaskQuestion
- ::new — TTY::Prompt::MultiList
- ::new — TTY::Prompt::Multiline
- ::new — TTY::Prompt::Paginator
- ::new — TTY::Prompt::Question
- ::new — TTY::Prompt::Question::Modifier
- ::new — TTY::Prompt::Question::Validation
- ::new — TTY::Prompt::Result
- ::new — TTY::Prompt::SelectedChoices
- ::new — TTY::Prompt::Slider
- ::new — TTY::Prompt::Statement
- ::new — TTY::Prompt::Suggestion
- ::new — TTY::Prompt::Test
- ::new — TTY::Prompt::Timer
- ::symbols — TTY::Prompt::Symbols
- ::whitespace — TTY::Prompt::Question::Modifier
- ::windows? — TTY::Prompt::Symbols
- #<< — TTY::Prompt::Choices
- #<< — TTY::Prompt::Evaluator
- #== — TTY::Prompt::Choice
- #[] — TTY::Prompt::Choices
- #[] — TTY::Prompt::ConverterRegistry
- #add_answer — TTY::Prompt::AnswersCollector
- #answer — TTY::Prompt::EnumList
- #answer — TTY::Prompt::Expander
- #answer — TTY::Prompt::List
- #answer — TTY::Prompt::MultiList
- #answer — TTY::Prompt::Slider
- #any_key? — TTY::Prompt::Keypress
- #apply_to — TTY::Prompt::Question::Modifier
- #arrows_help — TTY::Prompt::List
- #ask — TTY::Prompt
- #blank? — TTY::Utils
- #build_multiple_suggestions — TTY::Prompt::Suggestion
- #build_single_suggestion — TTY::Prompt::Suggestion
- #call — TTY::Prompt::AnswersCollector
- #call — TTY::Prompt::ConfirmQuestion
- #call — TTY::Prompt::EnumList
- #call — TTY::Prompt::Evaluator
- #call — TTY::Prompt::Expander
- #call — TTY::Prompt::List
- #call — TTY::Prompt::Question
- #call — TTY::Prompt::Question::Validation
- #call — TTY::Prompt::Slider
- #call — TTY::Prompt::Statement
- #cast_to_num — TTY::Prompt::Converters
- #check — TTY::Prompt::Evaluator
- #check_options_consistency — TTY::Prompt::List
- #check_page_size! — TTY::Prompt::Paginator
- #choice — TTY::Prompt::EnumList
- #choice — TTY::Prompt::Expander
- #choice — TTY::Prompt::List
- #choice — TTY::Prompt::Slider
- #choices — TTY::Prompt::EnumList
- #choices — TTY::Prompt::Expander
- #choices — TTY::Prompt::List
- #choices — TTY::Prompt::Slider
- #clear — TTY::Prompt::SelectedChoices
- #coerce — TTY::Prompt::Question::Validation
- #collapsed? — TTY::Prompt::Expander
- #collect — TTY::Prompt
- #contain? — TTY::Prompt::ConverterRegistry
- #conversion — TTY::Prompt::ConfirmQuestion
- #convert — TTY::Prompt::Question
- #convert — TTY::Prompt::ConverterDSL
- #convert? — TTY::Prompt::Question
- #convert_result — TTY::Prompt::Question
- #converter — TTY::Prompt::ConverterDSL
- #converter_registry — TTY::Prompt::ConverterDSL
- #countdown — TTY::Prompt::Keypress
- #create_collector — TTY::Prompt::AnswersCollector
- #create_default_labels — TTY::Prompt::ConfirmQuestion
- #create_suffix — TTY::Prompt::ConfirmQuestion
- #debug — TTY::Prompt
- #decorate — TTY::Prompt
- #deep_copy — TTY::Utils
- #default — TTY::Prompt::EnumList
- #default — TTY::Prompt::Expander
- #default — TTY::Prompt::List
- #default — TTY::Prompt::Question
- #default — TTY::Prompt::Slider
- #default? — TTY::Prompt::EnumList
- #default? — TTY::Prompt::Question
- #default_help — TTY::Prompt::List
- #default_help — TTY::Prompt::MultiList
- #default_help — TTY::Prompt::Slider
- #delete_at — TTY::Prompt::SelectedChoices
- #disabled? — TTY::Prompt::Choice
- #distance — TTY::Prompt::Distance
- #each — TTY::Prompt::Choices
- #each — TTY::Prompt::SelectedChoices
- #echo — TTY::Prompt::Question
- #echo? — TTY::Prompt::Question
- #enabled — TTY::Prompt::Choices
- #enabled_indexes — TTY::Prompt::Choices
- #enum — TTY::Prompt::EnumList
- #enum — TTY::Prompt::List
- #enum_select — TTY::Prompt
- #enumerate? — TTY::Prompt::List
- #error — TTY::Prompt
- #error_message — TTY::Prompt::EnumList
- #evaluate — TTY::Prompt::Suggestion
- #expand — TTY::Prompt
- #expand — TTY::Prompt::Expander
- #expanded? — TTY::Prompt::Expander
- #extract_options — TTY::Utils
- #extract_options! — TTY::Utils
- #failure? — TTY::Prompt::Result
- #fetch — TTY::Prompt::ConverterRegistry
- #filter_help — TTY::Prompt::List
- #filterable? — TTY::Prompt::List
- #find_by — TTY::Prompt::Choices
- #find_index_by — TTY::Prompt::SelectedChoices
- #format — TTY::Prompt::Slider
- #help — TTY::Prompt::List
- #help — TTY::Prompt::Multiline
- #help — TTY::Prompt::Slider
- #help_always? — TTY::Prompt::List
- #help_always? — TTY::Prompt::Slider
- #help_start? — TTY::Prompt::List
- #help_start? — TTY::Prompt::Slider
- #in — TTY::Prompt::Question
- #in? — TTY::Prompt::Question
- #infer_default — TTY::Prompt::ConfirmQuestion
- #initial — TTY::Prompt::Slider
- #insert — TTY::Prompt::SelectedChoices
- #inspect — TTY::Prompt
- #inspect — TTY::Prompt::ConverterRegistry
- #inspect — TTY::Prompt::Question
- #interval_handler — TTY::Prompt::Keypress
- #invoke_question — TTY::Prompt
- #invoke_select — TTY::Prompt
- #ioctl — TTY::Prompt::StringIOExtensions
- #key — TTY::Prompt::AnswersCollector
- #keybackspace — TTY::Prompt::List
- #keyctrl_a — TTY::Prompt::MultiList
- #keyctrl_r — TTY::Prompt::MultiList
- #keydelete — TTY::Prompt::List
- #keydown — TTY::Prompt::List
- #keydown — TTY::Prompt::Slider
- #keyenter — TTY::Prompt::EnumList
- #keyenter — TTY::Prompt::Expander
- #keyenter — TTY::Prompt::List
- #keyenter — TTY::Prompt::MaskQuestion
- #keyenter — TTY::Prompt::MultiList
- #keyenter — TTY::Prompt::Multiline
- #keyenter — TTY::Prompt::Slider
- #keyleft — TTY::Prompt::EnumList
- #keyleft — TTY::Prompt::List
- #keyleft — TTY::Prompt::Slider
- #keynum — TTY::Prompt::List
- #keypage_down — TTY::Prompt::List
- #keypage_up — TTY::Prompt::List
- #keypress — TTY::Prompt
- #keypress — TTY::Prompt::EnumList
- #keypress — TTY::Prompt::Expander
- #keypress — TTY::Prompt::Keypress
- #keypress — TTY::Prompt::List
- #keypress — TTY::Prompt::MaskQuestion
- #keyreturn — TTY::Prompt::EnumList
- #keyreturn — TTY::Prompt::Expander
- #keyreturn — TTY::Prompt::List
- #keyreturn — TTY::Prompt::MaskQuestion
- #keyreturn — TTY::Prompt::MultiList
- #keyreturn — TTY::Prompt::Multiline
- #keyreturn — TTY::Prompt::Slider
- #keyright — TTY::Prompt::EnumList
- #keyright — TTY::Prompt::List
- #keyright — TTY::Prompt::Slider
- #keyspace — TTY::Prompt::List
- #keyspace — TTY::Prompt::MultiList
- #keyspace — TTY::Prompt::Slider
- #keytab — TTY::Prompt::EnumList
- #keytab — TTY::Prompt::List
- #keyup — TTY::Prompt::List
- #keyup — TTY::Prompt::Slider
- #load_auto_hint — TTY::Prompt::Expander
- #mark_choice_as_active — TTY::Prompt::EnumList
- #mask — TTY::Prompt
- #mask — TTY::Prompt::MaskQuestion
- #max — TTY::Prompt::MultiList
- #max — TTY::Prompt::Slider
- #measure_distances — TTY::Prompt::Suggestion
- #message_for — TTY::Prompt::Question
- #method_missing — TTY::Prompt::AnswersCollector
- #min — TTY::Prompt::MultiList
- #min — TTY::Prompt::Slider
- #minmax_help — TTY::Prompt::MultiList
- #modify — TTY::Prompt::Question
- #multi_select — TTY::Prompt
- #multiline — TTY::Prompt
- #negative — TTY::Prompt::ConfirmQuestion
- #negative? — TTY::Prompt::ConfirmQuestion
- #no? — TTY::Prompt
- #ok — TTY::Prompt
- #on_tick — TTY::Prompt::Timer
- #page_help — TTY::Prompt::EnumList
- #page_help_message — TTY::Prompt::EnumList
- #page_size — TTY::Prompt::EnumList
- #page_size — TTY::Prompt::List
- #paginate — TTY::Prompt::BlockPaginator
- #paginate — TTY::Prompt::Paginator
- #paginated? — TTY::Prompt::EnumList
- #paginated? — TTY::Prompt::List
- #paginator — TTY::Prompt::List
- #per_page — TTY::Prompt::EnumList
- #per_page — TTY::Prompt::List
- #pluck — TTY::Prompt::Choices
- #positive — TTY::Prompt::ConfirmQuestion
- #positive? — TTY::Prompt::ConfirmQuestion
- #possible_keys — TTY::Prompt::Expander
- #process_input — TTY::Prompt::ConfirmQuestion
- #process_input — TTY::Prompt::Keypress
- #process_input — TTY::Prompt::Multiline
- #process_input — TTY::Prompt::Question
- #question_lines_count — TTY::Prompt::EnumList
- #question_lines_count — TTY::Prompt::List
- #quiet — TTY::Prompt::EnumList
- #quiet — TTY::Prompt::Expander
- #quiet — TTY::Prompt::List
- #quiet — TTY::Prompt::Question
- #quiet — TTY::Prompt::Slider
- #raw — TTY::Prompt::Question
- #raw? — TTY::Prompt::Question
- #read_input — TTY::Prompt::Expander
- #read_input — TTY::Prompt::MaskQuestion
- #read_input — TTY::Prompt::Multiline
- #read_input — TTY::Prompt::Question
- #refresh — TTY::Prompt::EnumList
- #refresh — TTY::Prompt::Expander
- #refresh — TTY::Prompt::Keypress
- #refresh — TTY::Prompt::List
- #refresh — TTY::Prompt::Multiline
- #refresh — TTY::Prompt::Question
- #refresh — TTY::Prompt::Slider
- #register — TTY::Prompt::ConverterRegistry
- #render — TTY::Prompt::EnumList
- #render — TTY::Prompt::Expander
- #render — TTY::Prompt::List
- #render — TTY::Prompt::Question
- #render — TTY::Prompt::Slider
- #render_error — TTY::Prompt::EnumList
- #render_error — TTY::Prompt::MaskQuestion
- #render_error — TTY::Prompt::Question
- #render_footer — TTY::Prompt::EnumList
- #render_footer — TTY::Prompt::Expander
- #render_header — TTY::Prompt::EnumList
- #render_header — TTY::Prompt::Expander
- #render_header — TTY::Prompt::List
- #render_header — TTY::Prompt::MultiList
- #render_hint — TTY::Prompt::Expander
- #render_menu — TTY::Prompt::EnumList
- #render_menu — TTY::Prompt::Expander
- #render_menu — TTY::Prompt::List
- #render_menu — TTY::Prompt::MultiList
- #render_page_help — TTY::Prompt::EnumList
- #render_question — TTY::Prompt::ConfirmQuestion
- #render_question — TTY::Prompt::EnumList
- #render_question — TTY::Prompt::Expander
- #render_question — TTY::Prompt::Keypress
- #render_question — TTY::Prompt::List
- #render_question — TTY::Prompt::MaskQuestion
- #render_question — TTY::Prompt::Multiline
- #render_question — TTY::Prompt::Question
- #render_question — TTY::Prompt::Slider
- #render_slider — TTY::Prompt::Slider
- #required — TTY::Prompt::Question
- #required? — TTY::Prompt::Question
- #reset! — TTY::Prompt::Paginator
- #runtime — TTY::Prompt::Timer
- #say — TTY::Prompt
- #search_choice_in — TTY::Prompt::List
- #select — TTY::Prompt
- #select_choice — TTY::Prompt::Expander
- #selected_names — TTY::Prompt::MultiList
- #setup_defaults — TTY::Prompt::ConfirmQuestion
- #setup_defaults — TTY::Prompt::EnumList
- #setup_defaults — TTY::Prompt::Expander
- #setup_defaults — TTY::Prompt::List
- #setup_defaults — TTY::Prompt::MultiList
- #show_help — TTY::Prompt::List
- #show_help — TTY::Prompt::Slider
- #slider — TTY::Prompt
- #start — TTY::Prompt::Timer
- #stderr — TTY::Prompt
- #stdin — TTY::Prompt
- #stdout — TTY::Prompt
- #step — TTY::Prompt::Slider
- #stop — TTY::Prompt::Timer
- #success? — TTY::Prompt::Result
- #suffix — TTY::Prompt::ConfirmQuestion
- #suffix? — TTY::Prompt::ConfirmQuestion
- #suggest — TTY::Prompt
- #suggest — TTY::Prompt::Suggestion
- #symbols — TTY::Prompt::EnumList
- #symbols — TTY::Prompt::List
- #symbols — TTY::Prompt::Slider
- #symbols — TTY::Prompt::Symbols
- #sync_paginators — TTY::Prompt::List
- #time_now — TTY::Prompt::Timer
- #timeout? — TTY::Prompt::Keypress
- #to_s — TTY::Prompt::Choice
- #to_s — TTY::Prompt::Question
- #tty? — TTY::Prompt
- #validate — TTY::Prompt::Question
- #validate_choices — TTY::Prompt::Expander
- #validate_default_name — TTY::Prompt::EnumList
- #validate_default_name — TTY::Prompt::List
- #validate_defaults — TTY::Prompt::EnumList
- #validate_defaults — TTY::Prompt::List
- #validation? — TTY::Prompt::Question
- #value — TTY::Prompt::Choice
- #value — TTY::Prompt::Question
- #value? — TTY::Prompt::Question
- #values — TTY::Prompt::AnswersCollector
- #wait_readable — TTY::Prompt::StringIOExtensions
- #warn — TTY::Prompt
- #while_remaining — TTY::Prompt::Timer
- #windows? — TTY::Prompt::Symbols
- #with — TTY::Prompt::Result
- #yes? — TTY::Prompt