显示一个多行文本输入小部件。

函数签名[来源]

st.text_area(label, value="", height=None, max_chars=None, key=None, help=None, on_change=None, args=None, kwargs=None, *, placeholder=None, disabled=False, label_visibility="visible")

参数

label (str)

一个简短的标签,向用户解释此输入的用途。 标签可以选择性地包含以下类型的GitHub风格的Markdown:粗体、斜体、删除线、内联代码、链接和图片。图片显示为图标,最大高度等于字体高度。

不支持的Markdown元素会被解包,因此只有它们的子元素(文本内容)会呈现。通过反斜杠转义不支持的元素,将其显示为字面字符。例如, "1\. 不是一个有序列表"

有关其他支持的Markdown指令,请参见st.markdownbody参数。

出于可访问性原因,您不应设置空标签,但如有需要,可以使用label_visibility隐藏它。将来,我们可能会通过引发异常来禁止空标签。

value (object or None)

此小部件首次渲染时的文本值。这将在内部转换为字符串。如果为None,将初始化为空,并在用户提供输入之前返回None。默认为空字符串。

height (int or None)

UI元素的期望高度,以像素表示。如果为None(默认值),则小部件的初始高度适合三行。高度必须至少为68像素,适合两行。

max_chars (int or None)

文本区域中允许的最大字符数。

key (str or int)

一个可选的字符串或整数,用作小部件的唯一键。 如果省略,将根据小部件的内容生成一个键。 任何两个小部件都不能有相同的键。

help (str)

一个可选的小提示,显示在小部件标签旁边。 只有当label_visibility="visible"时,Streamlit才会显示这个小提示。

on_change (callable)

当此文本区域的值更改时调用的可选回调。

args (tuple)

传递给回调函数的可选参数元组。

kwargs (dict)

一个可选的字典,用于传递给回调函数。

placeholder (str or None)

当文本区域为空时显示的可选字符串。如果为 None,则不显示任何文本。

disabled (bool)

一个可选的布尔值,如果设置为True,则禁用文本区域。 默认值为False

label_visibility ("visible", "hidden", or "collapsed")

标签的可见性。默认是"visible"。如果这是"hidden",Streamlit会显示一个空白的间隔符而不是标签,这有助于保持小部件与其他小部件对齐。如果这是"collapsed",Streamlit不会显示标签或间隔符。

返回

(str or None)

文本区域小部件的当前值,如果用户未提供值则为None

示例

import streamlit as st

txt = st.text_area(
    "Text to analyze",
    "It was the best of times, it was the worst of times, it was the age of "
    "wisdom, it was the age of foolishness, it was the epoch of belief, it "
    "was the epoch of incredulity, it was the season of Light, it was the "
    "season of Darkness, it was the spring of hope, it was the winter of "
    "despair, (...)",
)

st.write(f"You wrote {len(txt)} characters.")
forum

还有问题吗?

我们的 论坛 充满了有用的信息和Streamlit专家。