text method

String? text(String prompt, { String? placeholder, String? validator(String)?, bool required = true, })

Text input prompt with optional validation, placeholder text, and a required flag for quick enforcement.

Returns the entered text, or null if the user cancels.

Example:

final handle = terminice.text(
  'Handle',
  placeholder: '@terminice',
  required: true,
);

Implementation

String? text(
  String prompt, {
  String? placeholder,
  String? Function(String)? validator,
  bool required = true,
}) {
  return runWithExecutionMode<String?>(
    rich: () => TextPromptSync(
      title: prompt,
      theme: defaultTheme,
      placeholder: placeholder,
      validator: validator,
      required: required,
    ).run(),
    line: () => FallbackPrompt.text(
      title: prompt,
      required: required,
      validator: validator,
      returnDefaultOnEndOfInput: false,
    ),
    unattended: () => null,
  );
}