Skip to content

InquirerTextArea

Bases: InquirerWidget

A text input prompt that allows the user to enter multiline text.

__init__(message, name=None, default='', mandatory=False, height=10)

Parameters:

Name Type Description Default
message str

The prompt message to display.

required
name str | None

The name of the prompt, used as the key in the answers dictionary.

None
default str

The default value if the user presses Enter without input.

''
mandatory bool

Whether this prompt is mandatory.

False
height int | str | None

If None, for inline apps the height will be determined based on the number of choices.

10