Display a multi-line text input widget.
Function signature

st.text_area(label: str, value: str = '', height: Optional[int] = None, max_chars: Optional[int] = None, key: Union[str, int, NoneType] = None, help: 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.

height (int or None)

Desired height of the UI element expressed in pixels. If None, a default height is used.

max_chars (int or None)

Maximum number of characters allowed in text area.

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.

help (str)

An optional tooltip that gets displayed next to the textarea.

on_change (callable)

An optional callback invoked when this text_area'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.