Skip to main content


Requests a string value.


const text = await io.input.text("Company name", {
placeholder: "Acme Inc.",


defaultValueOptional stringDefault value for the input.
helpTextOptional stringSecondary label for providing additional context.
linesOptional numberInitial number of lines when `multiline` is set to true. Defaults to 3.
maxLengthOptional numberMaximum number of characters allowed in the input.
minLengthOptional numberMinimum number of characters allowed in the input.
multilineOptional booleanWhether the text input should be resizable and support multiple lines. Defaults to false.
placeholderOptional stringText to display in the input when no value is set.

Returns: String

Was this section useful?
On this page