Prompt (prompt v0.1.1)
Build interactive command line interfaces.
Link to this section Summary
Functions
Display a Y/n prompt.
Displays options to the user denoted by numbers.
Display text on the screen and wait for the users text imput.
Link to this section Functions
Link to this function
confirm(question, opts \\ [])
Specs
Display a Y/n prompt.
Sets 'Y' as the the default answer, allowing the user to just press the enter key. To make 'n' the default answer pass the option default_answer: :no
Available options:
- color: A color from the
IO.ANSI
module - default_answer: :yes or :no
Examples
iex> Prompt.confirm("Send the email?")
Send the email? (Y/n): Y
iex> :yes
iex> Prompt.confirm("Send the email?", default_answer: :no)
Send the email? (y/N): [enter]
iex> :no
Link to this function
select(display, choices, opts \\ [])
Specs
Displays options to the user denoted by numbers.
Available options:
- color: A color from the
IO.ANSI
module
Examples
iex> Prompt.select("Choose One", ["Choice A", "Choice B"])
[0] Choice A
[1] Choice B
Choose One [0-1]: 1
iex> "Choice B"
Link to this function
text(display, opts \\ [])
Specs
Display text on the screen and wait for the users text imput.
Available options:
- color: A color from the
IO.ANSI
module
Examples
iex> Prompt.text("Enter your email")
Enter your email: t@t.com
iex> t@t.com