Table of Contents - RDoc Documentation

Pages

• CHANGELOG
  • Change log
  • 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
• CODE_OF_CONDUCT
  • Contributor Code of Conduct
• Gemfile
• 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 echo
  • 2.1.4 error messages
  • 2.1.5 in
  • 2.1.6 modify
  • 2.1.7 required
  • 2.1.8 validate
  • 2.2. keypress
  • 2.2.1 timeout
  • 2.3 multiline
  • 2.4 mask
  • 2.5 yes?/no?
  • 2.6 menu
  • 2.6.1 select
  • 2.6.2 multi_select
  • 2.6.2.1 echo
  • 2.6.2.2 filter
  • 2.6.3 enum_select
  • 2.7 expand
  • 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 active_color
  • 3.2 enable_color
  • 3.3 help_color
  • 3.4 interrupt
  • 3.5 prefix
  • 3.6 track_history
  • Contributing
  • Copyright
• Rakefile
• changelog
• compat
• control
• copyright
• dh_ruby.mk
• rock-master-18.09-ruby-tty-prompt.docs
• rock-master-18.09-ruby-tty-prompt.examples
• rules
• format
• watch
• console.rake
• coverage.rake
• spec.rake
• tty-prompt.gemspec

Classes and Modules

• TTY
• TTY::Prompt
• TTY::Prompt::AnswersCollector
• TTY::Prompt::Choice
• TTY::Prompt::Choices
• TTY::Prompt::ConfirmQuestion
• TTY::Prompt::ConverterDSL
• TTY::Prompt::ConverterRegistry
• TTY::Prompt::Converters
• TTY::Prompt::Distance
• TTY::Prompt::EnumList
• TTY::Prompt::EnumPaginator
• 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::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::Slider
• TTY::Prompt::Statement
• TTY::Prompt::Suggestion
• TTY::Prompt::Symbols
• TTY::Prompt::Timeout
• TTY::TestPrompt
• 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
• ::cast — TTY::Prompt::Question::Checks::CheckRange
• ::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::Slider
• ::new — TTY::Prompt::Statement
• ::new — TTY::Prompt::Suggestion
• ::new — TTY::Prompt::Timeout
• ::new — TTY::TestPrompt
• ::on_error — TTY::Prompt::Converters
• ::symbols — TTY::Prompt::Symbols
• ::timeout — TTY::Prompt::Timeout
• ::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
• #any_key? — TTY::Prompt::Keypress
• #apply_to — TTY::Prompt::Question::Modifier
• #ask — TTY::Prompt
• #async_run — TTY::Prompt::Timeout
• #blank? — TTY::Utils
• #call — TTY::Prompt::AnswersCollector
• #call — TTY::Prompt::ConfirmQuestion
• #call — TTY::Prompt::ConverterRegistry
• #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
• #cancel — TTY::Prompt::Timeout
• #check — TTY::Prompt::Evaluator
• #check_page_size! — TTY::Prompt::Paginator
• #choice — TTY::Prompt::EnumList
• #choice — TTY::Prompt::Expander
• #choice — TTY::Prompt::List
• #choices — TTY::Prompt::EnumList
• #choices — TTY::Prompt::Expander
• #choices — TTY::Prompt::List
• #coerce — TTY::Prompt::Question::Validation
• #collapsed? — TTY::Prompt::Expander
• #collect — TTY::Prompt
• #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
• #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::Question
• #default_help — TTY::Prompt::List
• #distance — TTY::Prompt::Distance
• #each — TTY::Prompt::Choices
• #echo — TTY::Prompt::Question
• #echo? — TTY::Prompt::Question
• #enum — TTY::Prompt::EnumList
• #enum — TTY::Prompt::List
• #enum_select — TTY::Prompt
• #enumerate? — TTY::Prompt::List
• #error — TTY::Prompt
• #expand — TTY::Prompt
• #expand — TTY::Prompt::Expander
• #expanded? — TTY::Prompt::Expander
• #extract_options — TTY::Utils
• #extract_options! — TTY::Utils
• #failure? — TTY::Prompt::Result
• #find_by — TTY::Prompt::Choices
• #format — TTY::Prompt::Slider
• #help — TTY::Prompt::List
• #help — TTY::Prompt::Multiline
• #in — TTY::Prompt::Question
• #in? — TTY::Prompt::Question
• #initial — TTY::Prompt::Slider
• #inspect — TTY::Prompt
• #inspect — TTY::Prompt::ConverterRegistry
• #inspect — TTY::Prompt::Question
• #invoke_question — TTY::Prompt
• #invoke_select — TTY::Prompt
• #key — TTY::Prompt::AnswersCollector
• #key? — TTY::Prompt::ConverterRegistry
• #keybackspace — TTY::Prompt::List
• #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::Multiline
• #keyenter — TTY::Prompt::Slider
• #keyleft — TTY::Prompt::EnumList
• #keyleft — TTY::Prompt::Slider
• #keynum — 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::Multiline
• #keyreturn — TTY::Prompt::Slider
• #keyright — TTY::Prompt::EnumList
• #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
• #marker — TTY::Prompt::List
• #mask — TTY::Prompt
• #mask — TTY::Prompt::MaskQuestion
• #max — TTY::Prompt::Slider
• #max_index — TTY::Prompt::Paginator
• #message_for — TTY::Prompt::Question
• #min — TTY::Prompt::Slider
• #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
• #page_help — TTY::Prompt::EnumList
• #page_help — TTY::Prompt::List
• #page_size — TTY::Prompt::EnumList
• #page_size — TTY::Prompt::List
• #paginate — TTY::Prompt::EnumPaginator
• #paginate — TTY::Prompt::Paginator
• #paginated? — TTY::Prompt::EnumList
• #paginated? — 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
• #process_input — TTY::Prompt::Keypress
• #process_input — TTY::Prompt::Multiline
• #process_input — TTY::Prompt::Question
• #range — TTY::Prompt::Slider
• #raw — TTY::Prompt::Question
• #raw? — TTY::Prompt::Question
• #read_input — TTY::Prompt::MaskQuestion
• #read_input — TTY::Prompt::Multiline
• #read_input — TTY::Prompt::Question
• #refresh — TTY::Prompt::Keypress
• #refresh — TTY::Prompt::Multiline
• #refresh — TTY::Prompt::Question
• #register — TTY::Prompt::ConverterRegistry
• #render — TTY::Prompt::Question
• #render_error — TTY::Prompt::MaskQuestion
• #render_error — TTY::Prompt::Question
• #render_question — TTY::Prompt::ConfirmQuestion
• #render_question — TTY::Prompt::Keypress
• #render_question — TTY::Prompt::MaskQuestion
• #render_question — TTY::Prompt::Multiline
• #render_question — TTY::Prompt::Question
• #required — TTY::Prompt::Question
• #required? — TTY::Prompt::Question
• #say — TTY::Prompt
• #select — TTY::Prompt
• #select_choice — TTY::Prompt::Expander
• #setup_defaults — TTY::Prompt::ConfirmQuestion
• #slider — TTY::Prompt
• #stderr — TTY::Prompt
• #stdin — TTY::Prompt
• #stdout — TTY::Prompt
• #step — TTY::Prompt::Slider
• #success? — TTY::Prompt::Result
• #suffix — TTY::Prompt::ConfirmQuestion
• #suffix? — TTY::Prompt::ConfirmQuestion
• #suggest — TTY::Prompt
• #suggest — TTY::Prompt::Suggestion
• #time — TTY::Prompt::Keypress
• #timeout — TTY::Prompt::Timeout
• #timeout? — TTY::Prompt::Keypress
• #to_s — TTY::Prompt::Choice
• #to_s — TTY::Prompt::Question
• #tty? — TTY::Prompt
• #validate — TTY::Prompt::Question
• #validation? — TTY::Prompt::Question
• #value — TTY::Prompt::Choice
• #values — TTY::Prompt::AnswersCollector
• #warn — TTY::Prompt
• #with — TTY::Prompt::Result
• #yes? — TTY::Prompt