Hypervel\Prompts
Namespaces
Hypervel\Prompts\ConcernsHypervel\Prompts\ExceptionsHypervel\Prompts\OutputHypervel\Prompts\SupportHypervel\Prompts\Themes
Classes
Functions
void
alert(string $message)
Display an alert.
at line 206
string
autocomplete(string $label, array|Collection|Closure $options = [], string $placeholder = '', string $default = '', bool|string $required = false, mixed $validate = null, string $hint = '', Closure|null $transform = null)
Prompt the user for text input with auto-completion.
at line 26
void
clear()
Clear the terminal.
at line 113
bool
confirm(string $label, bool $default = true, string $yes = 'Yes', string $no = 'No', bool|string $required = false, mixed $validate = null, string $hint = '', Closure|null $transform = null)
Prompt the user to confirm an action.
at line 93
mixed
datatable(array|Collection $headers = [], array|Collection|null $rows = null, int $scroll = 10, string $label = '', string $hint = '', bool|string $required = false, mixed $validate = null, Closure|null $transform = null, Closure|null $filter = null)
Display an interactive data table.
at line 355
void
error(string $message)
Display an error.
at line 186
void
info(string $message)
Display an informational message.
at line 216
void
intro(string $message)
Display an introduction.
at line 226
array
multisearch(string $label, Closure $options, string $placeholder = '', int $scroll = 5, bool|string $required = false, mixed $validate = null, string $hint = 'Use the space bar to select options.', Closure|null $transform = null, string|Closure $info = '')
Allow the user to search for multiple option.
at line 151
array
multiselect(string $label, array|Collection $options, array|Collection $default = [], int $scroll = 5, bool|string $required = false, mixed $validate = null, string $hint = 'Use the space bar to select options.', Closure|null $transform = null, string|Closure $info = '')
Prompt the user to select multiple options.
at line 83
void
note(string $message, string|null $type = null)
Display a note.
at line 176
void
notify(string $title, string $body = '', string $subtitle = '', string $sound = '', string $icon = '')
Send a notification to the user. (macOS and Linux only).
at line 252
int|string
number(string $label, string $placeholder = '', string $default = '', bool|string $required = false, mixed $validate = null, string $hint = '', int|null $min = null, int|null $max = null, int|null $step = null)
Prompt the user for number input.
at line 36
void
outro(string $message)
Display a closing message.
at line 236
string
password(string $label, string $placeholder = '', bool|string $required = false, mixed $validate = null, string $hint = '', Closure|null $transform = null)
Prompt the user for input, hiding the value.
at line 56
bool
pause(string $message = 'Press enter to continue...')
Prompt the user to continue or cancel after pausing.
at line 103
array|Progress
progress(string $label, int|iterable $steps, Closure|null $callback = null, string $hint = '')
Display a progress bar.
at line 294
int|string
search(string $label, Closure $options, string $placeholder = '', int $scroll = 5, mixed $validate = null, string $hint = '', bool|string $required = true, Closure|null $transform = null, string|Closure $info = '')
Allow the user to search for an option.
at line 138
int|string
select(string $label, array|Collection $options, int|string|null $default = null, int $scroll = 5, mixed $validate = null, string $hint = '', bool|string $required = true, Closure|null $transform = null, string|Closure $info = '')
Prompt the user to select an option.
at line 69
mixed
spin(Closure $callback, string $message = '')
Render a spinner while the given callback is executing.
at line 166
string
suggest(string $label, array|Closure|Collection $options, string $placeholder = '', string $default = '', int $scroll = 5, bool|string $required = false, mixed $validate = null, string $hint = '', Closure|null $transform = null, string|Closure $info = '')
Prompt the user for text input with auto-completion.
at line 125
void
at line 265
mixed
task(string $label, Closure $callback, int|null $limit = null, bool $keepSummary = false, string|null $subLabel = null)
Display a task with a spinner and live output.
at line 342
string
text(string $label, string $placeholder = '', string $default = '', bool|string $required = false, mixed $validate = null, string $hint = '', Closure|null $transform = null)
Prompt the user for text input.
at line 14
string
textarea(string $label, string $placeholder = '', string $default = '', bool|string $required = false, mixed $validate = null, string $hint = '', int $rows = 5, Closure|null $transform = null)
Prompt the user for multiline text input.
at line 46
void
title(string $title)
Update the title of the terminal.
at line 317
void
warning(string $message)
Display a warning.
at line 196