io.input.text

Requests a string value.

Usage

TypeScript

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

JavaScript

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

Python Experimental

text = await io.input.text("Company name",
  placeholder="Acme Inc.",
)

interval.com

Props

TypeScript

defaultValue

Optional

string

Default value for the input.

disabled

Optional

boolean

Whether the input is disabled, preventing edits to the `defaultValue`.

helpText

Optional

string

Secondary label for providing additional context.

lines

Optional

number

Initial number of lines when `multiline` is set to true. Defaults to 3.

maxLength

Optional

number

Maximum number of characters allowed in the input.

minLength

Optional

number

Minimum number of characters allowed in the input.

multiline

Optional

boolean

Whether the text input should be resizable and support multiple lines. Defaults to false.

placeholder

Optional

string

Text to display in the input when no value is set.

Returns

string

JavaScript

defaultValue

Optional

string

Default value for the input.

disabled

Optional

boolean

Whether the input is disabled, preventing edits to the `defaultValue`.

helpText

Optional

string

Secondary label for providing additional context.

lines

Optional

number

Initial number of lines when `multiline` is set to true. Defaults to 3.

maxLength

Optional

number

Maximum number of characters allowed in the input.

minLength

Optional

number

Minimum number of characters allowed in the input.

multiline

Optional

boolean

Whether the text input should be resizable and support multiple lines. Defaults to false.

placeholder

Optional

string

Text to display in the input when no value is set.

Returns

string

Python Experimental

default_value

Optional

str

Default value for the input.

disabled

Optional

bool

Whether the input is disabled, preventing edits to the default value.

help_text

Optional

str

Secondary label for providing additional context.

lines

Optional

int

Initial number of lines when `multiline` is set to true. Defaults to 3.

max_length

Optional

int

Maximum number of characters allowed in the input.

min_length

Optional

int

Minimum number of characters allowed in the input.

multiline

Optional

bool

Whether the text input should be resizable and support multiple lines. Defaults to false.

placeholder

Optional

str

Text to display in the input when no value is set.

Returns

str

Did this section clearly explain what you wanted to learn?