Display a single-line text input widget.
Function signature

st.text_input(label: str, value: str = '', max_chars: Optional[int] = None, key: Union[str, int, NoneType] = None, type: str = 'default', help: Optional[str] = None, autocomplete: Optional[str] = None, on_change: Optional[Callable[..., NoneType]] = None, args: Optional[Tuple[Any, ...]] = None, kwargs: Optional[Dict[str, Any]] = None) -> str

Parameters

label (str)

A short label explaining to the user what this input is for.

value (any)

The text value of this widget when it first renders. This will be cast to str internally.

max_chars (int or None)

Max number of characters allowed in text input.

key (str or int)

An optional string or integer to use as the unique key for the widget. If this is omitted, a key will be generated for the widget based on its content. Multiple widgets of the same type may not share the same key.

type (str)

The type of the text input. This can be either "default" (for a regular text input), or "password" (for a text input that masks the user's typed value). Defaults to "default".

help (str)

An optional tooltip that gets displayed next to the input.

autocomplete (str)

An optional value that will be passed to the <input> element's autocomplete property. If unspecified, this value will be set to "new-password" for "password" inputs, and the empty string for "default" inputs. For more details, see https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete

on_change (callable)

An optional callback invoked when this text_input's value changes.

args (tuple)

An optional tuple of args to pass to the callback.

kwargs (dict)

An optional dict of kwargs to pass to the callback.

Was this page helpful?

forum

Still have questions?

Our forums are full of helpful information and Streamlit experts.