组件
文本框

Gradio 新手？从这里开始：入门指南

状态 (State)

计时器 (Timer)

文本框

gradio.Textbox(···)

import gradio as gr with gr.Blocks() as demo: gr.Textbox() demo.launch()

描述

创建一个文本区域，供用户输入字符串或显示字符串输出。

行为

作为输入组件: 将文本值作为 `str` 传递给函数。

您的函数应接受以下类型之一

def predict(
	value: str | None
)
	...

作为输出组件: 期望从函数返回一个 `str` 并将其设置为文本区域的值。

您的函数应返回以下类型之一

def predict(···) -> str | None
	...	
	return value

初始化

🔗

value: str | I18nData | Callable | None

默认值 = None

要在文本框中显示的文本。如果提供了函数，则每次应用程序加载时都会调用该函数以设置此组件的初始值。

🔗

type: Literal['text', 'password', 'email']

默认值 = "text"

文本框类型。可选项之一：'text'（允许用户输入任意文本），'password'（对用户输入的文本进行掩码处理），'email'（建议浏览器进行电子邮件输入）。对于“password”和“email”类型，`lines` 必须为 1，`max_lines` 必须为 None 或 1。

🔗

lines: int

默认值 = 1

文本区域的最小行数。

🔗

max_lines: int | None

默认值 = None

文本区域的最大行数。必须至少为 `lines`。如果未提供，则“text”类型的最大行数为 max(lines, 20)，而“password”和“email”类型为 1。

🔗

placeholder: str | I18nData | None

默认值 = None

文本区域后提供的占位符提示。

🔗

label: str | I18nData | None

默认值 = None

此组件的标签，如果 `show_label` 为 `True`，则显示在组件上方；如果此组件有示例表格，则也用作标题。如果为 None 并在 `gr.Interface` 中使用，则标签将是此组件对应参数的名称。

🔗

info: str | I18nData | None

默认值 = None

附加组件描述，以较小字体显示在标签下方。支持 Markdown / HTML 语法。

🔗

every: Timer | float | None

默认值 = None

如果 `value` 是函数（否则无效），则连续调用 `value` 以重新计算它。可以提供一个 Timer，其滴答声会重置 `value`，或者提供一个浮点数，表示重置 Timer 的常规间隔。

🔗

inputs: Component | list[Component] | set[Component] | None

默认值 = None

如果 `value` 是函数（否则无效），则用作计算 `value` 的输入组件。每当输入更改时，`value` 都会重新计算。

🔗

show_label: bool | None

默认值 = None

如果为 True，将显示标签。如果为 False，则复制按钮和标签都将被隐藏。

🔗

container: bool

默认值 = True

如果为 True，组件将放置在容器中 - 在边框周围提供一些额外填充。

🔗

scale: int | None

默认值 = None

相对于相邻组件的相对大小。例如，如果组件 A 和 B 位于一行中，并且 A 的 scale=2，B 的 scale=1，则 A 的宽度将是 B 的两倍。应为整数。scale 适用于行，以及 Blocks 中 fill_height=True 的顶级组件。

🔗

min_width: int

默认值 = 160

最小像素宽度，如果屏幕空间不足以满足此值，则将换行。如果某个 scale 值导致此组件比 min_width 更窄，则将首先尊重 min_width 参数。

🔗

interactive: bool | None

默认值 = None

如果为 True，则将呈现为可编辑文本框；如果为 False，则编辑将被禁用。如果未提供，则根据组件是用作输入还是输出进行推断。

🔗

visible: bool

默认值 = True

如果为 False，组件将被隐藏。

🔗

elem_id: str | None

默认值 = None

一个可选字符串，作为此组件在 HTML DOM 中的 ID。可用于 CSS 样式定位。

🔗

autofocus: bool

默认值 = False

如果为 True，当页面加载时文本框将获得焦点。请谨慎使用此功能，因为它可能对视力正常和视力障碍用户造成可用性问题。

🔗

autoscroll: bool

默认值 = True

如果为 True，当值更改时会自动滚动到文本框底部，除非用户向上滚动。如果为 False，当值更改时不会滚动到文本框底部。

🔗

elem_classes: list[str] | str | None

默认值 = None

一个可选字符串列表，作为此组件在 HTML DOM 中的类。可用于 CSS 样式定位。

🔗

render: bool

默认值 = True

如果为 False，组件将不会在 Blocks 上下文中渲染。如果目的是现在分配事件监听器但稍后渲染组件，则应使用此选项。

🔗

key: int | str | tuple[int | str, ...] | None

默认值 = None

在 `gr.render` 中，跨重新渲染具有相同键的组件被视为同一组件，而不是新组件。在重新渲染时，'preserved_by_key' 中设置的属性不会被重置。

🔗

preserved_by_key: list[str] | str | None

默认值 = "value"

此组件构造函数中的参数列表。在 `gr.render()` 函数内部，如果组件使用相同的键重新渲染，这些（且仅这些）参数将保留在 UI 中（如果它们已被用户或事件监听器更改），而不是根据构造函数中提供的值重新渲染。

🔗

text_align: Literal['left', 'right'] | None

默认值 = None

文本框中的文本对齐方式，可以是："left"（左对齐）、"right"（右对齐）或 None（默认）。如果为 None，则在 `rtl` 为 False 时左对齐，在 `rtl` 为 True 时右对齐。只能在 `type` 为 "text" 时更改。

🔗

rtl: bool

默认值 = False

如果为 True 且 `type` 为 "text"，则将文本方向设置为从右到左（光标出现在文本左侧）。默认值为 False，光标显示在右侧。

🔗

show_copy_button: bool

默认值 = False

如果为 True，则包含一个复制按钮以复制文本框中的文本。仅当 `show_label` 为 True 时适用。

🔗

max_length: int | None

默认值 = None

文本框中允许的最大字符数（包括换行符）。如果为 None，则没有最大长度。

🔗

submit_btn: str | bool | None

默认值 = False

如果为 False，将不显示提交按钮。如果为 True，将显示带图标的提交按钮。如果为字符串，则将该字符串用作提交按钮文本。当显示提交按钮时，文本框的边框将被移除，这对于创建聊天界面很有用。

🔗

stop_btn: str | bool | None

默认值 = False

快捷方式

类	接口字符串快捷方式	初始化
`gradio.Textbox`	"textbox"	使用默认值
`gradio.TextArea`	"textarea"	使用 lines=7

演示

import gradio as gr def greet(name): return "Hello " + name + "!" demo = gr.Interface(fn=greet, inputs="textbox", outputs="textbox") if __name__ == "__main__": demo.launch()

import gradio as gr


def greet(name):
    return "Hello " + name + "!"


demo = gr.Interface(fn=greet, inputs="textbox", outputs="textbox")

if __name__ == "__main__":
    demo.launch()

from difflib import Differ import gradio as gr def diff_texts(text1, text2): d = Differ() return [ (token[2:], token[0] if token[0] != " " else None) for token in d.compare(text1, text2) ] demo = gr.Interface( diff_texts, [ gr.Textbox( label="Text 1", info="初始文本", lines=3, value="The quick brown fox jumped over the lazy dogs.", ), gr.Textbox( label="Text 2", info="比较文本", lines=3, value="The fast brown fox jumps over lazy dogs.", ), ], gr.HighlightedText( label="差异", combine_adjacent=True, show_legend=True, color_map={"+": "red", "-": "green"}), theme=gr.themes.Base() ) if __name__ == "__main__": demo.launch()

from difflib import Differ

import gradio as gr

def diff_texts(text1, text2):
    d = Differ()
    return [
        (token[2:], token[0] if token[0] != " " else None)
        for token in d.compare(text1, text2)
    ]

demo = gr.Interface(
    diff_texts,
    [
        gr.Textbox(
            label="Text 1",
            info="Initial text",
            lines=3,
            value="The quick brown fox jumped over the lazy dogs.",
        ),
        gr.Textbox(
            label="Text 2",
            info="Text to compare",
            lines=3,
            value="The fast brown fox jumps over lazy dogs.",
        ),
    ],
    gr.HighlightedText(
        label="Diff",
        combine_adjacent=True,
        show_legend=True,
        color_map={"+": "red", "-": "green"}),
    theme=gr.themes.Base()
)
if __name__ == "__main__":
    demo.launch()

import gradio as gr def sentence_builder(quantity, animal, countries, place, activity_list, morning): return f"""The {quantity} {animal}s from {" and ".join(countries)} went to the {place} where they {" and ".join(activity_list)} until the {"morning" if morning else "night"}""" demo = gr.Interface( sentence_builder, [ gr.Slider(2, 20, value=4, label="数量", info="选择 2 到 20 之间"), gr.Dropdown( ["cat", "dog", "bird"], label="动物", info="稍后将添加更多动物！" ), gr.CheckboxGroup(["USA", "Japan", "Pakistan"], label="国家", info="它们来自哪里？"), gr.Radio(["park", "zoo", "road"], label="地点", info="它们去了哪里？"), gr.Dropdown( ["ran", "swam", "ate", "slept"], value=["swam", "slept"], multiselect=True, label="活动", info="Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed auctor, nisl eget ultricies aliquam, nunc nisl aliquet nunc, eget aliquam nisl nunc vel nisl." ), gr.Checkbox(label="早晨", info="它们是在早上做的吗？"), ], "text", examples=[ [2, "cat", ["Japan", "Pakistan"], "park", ["ate", "swam"], True], [4, "dog", ["Japan"], "zoo", ["ate", "swam"], False], [10, "bird", ["USA", "Pakistan"], "road", ["ran"], False], [8, "cat", ["Pakistan"], "zoo", ["ate"], True], ] ) if __name__ == "__main__": demo.launch()

import gradio as gr

def sentence_builder(quantity, animal, countries, place, activity_list, morning):
    return f"""The {quantity} {animal}s from {" and ".join(countries)} went to the {place} where they {" and ".join(activity_list)} until the {"morning" if morning else "night"}"""

demo = gr.Interface(
    sentence_builder,
    [
        gr.Slider(2, 20, value=4, label="Count", info="Choose between 2 and 20"),
        gr.Dropdown(
            ["cat", "dog", "bird"], label="Animal", info="Will add more animals later!"
        ),
        gr.CheckboxGroup(["USA", "Japan", "Pakistan"], label="Countries", info="Where are they from?"),
        gr.Radio(["park", "zoo", "road"], label="Location", info="Where did they go?"),
        gr.Dropdown(
            ["ran", "swam", "ate", "slept"], value=["swam", "slept"], multiselect=True, label="Activity", info="Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed auctor, nisl eget ultricies aliquam, nunc nisl aliquet nunc, eget aliquam nisl nunc vel nisl."
        ),
        gr.Checkbox(label="Morning", info="Did they do it in the morning?"),
    ],
    "text",
    examples=[
        [2, "cat", ["Japan", "Pakistan"], "park", ["ate", "swam"], True],
        [4, "dog", ["Japan"], "zoo", ["ate", "swam"], False],
        [10, "bird", ["USA", "Pakistan"], "road", ["ran"], False],
        [8, "cat", ["Pakistan"], "zoo", ["ate"], True],
    ]
)

if __name__ == "__main__":
    demo.launch()

事件监听器

描述

事件监听器允许您响应用户与您在 Gradio Blocks 应用程序中定义的 UI 组件的交互。当用户与元素交互时，例如更改滑块值或上传图像，会调用一个函数。

支持的事件监听器

文本框组件支持以下事件监听器。每个事件监听器都接受相同的参数，这些参数列在下面的事件参数表中。

监听器	描述
`Textbox.change(fn, ···)`	当文本框的值因用户输入（例如用户在文本框中键入）或函数更新（例如图像从事件触发器的输出接收值）而更改时触发。有关仅由用户输入触发的监听器，请参阅 `.input()`。
`Textbox.input(fn, ···)`	当用户更改文本框的值时触发此监听器。
`Textbox.select(fn, ···)`	当用户选择或取消选择文本框时的事件监听器。使用事件数据 gradio.SelectData 来携带指代文本框标签的 `value`，以及指代文本框状态的 `selected`。有关如何使用此事件数据，请参阅 EventData 文档。
`Textbox.submit(fn, ···)`	当文本框聚焦时，用户按下 Enter 键时触发此监听器。
`Textbox.focus(fn, ···)`	当文本框获得焦点时触发此监听器。
`Textbox.blur(fn, ···)`	当文本框失去焦点/模糊时触发此监听器。
`Textbox.stop(fn, ···)`	当用户到达文本框中播放媒体的末尾时触发此监听器。
`Textbox.copy(fn, ···)`	当用户从文本框复制内容时触发此监听器。使用事件数据 gradio.CopyData 来携带有关复制内容的信息。有关如何使用此事件数据，请参阅 EventData 文档。

事件参数

🔗

fn: Callable | None | Literal['decorator']

默认值 = "decorator"

当此事件触发时要调用的函数。通常是机器学习模型的预测函数。函数的每个参数对应一个输入组件，函数应返回单个值或一个值元组，元组中的每个元素对应一个输出组件。

🔗

inputs: Component | BlockContext | list[Component | BlockContext] | Set[Component | BlockContext] | None

默认值 = None

要用作输入的 gradio.components 列表。如果函数不接受任何输入，则应为空列表。

🔗

outputs: Component | BlockContext | list[Component | BlockContext] | Set[Component | BlockContext] | None

默认值 = None

要用作输出的 gradio.components 列表。如果函数不返回任何输出，则应为空列表。

🔗

api_name: str | None | Literal[False]

默认值 = None

定义端点在 API 文档中如何显示。可以是字符串、None 或 False。如果设置为字符串，则端点将以给定名称在 API 文档中公开。如果为 None（默认），则将函数名称用作 API 端点。如果为 False，则端点将不会在 API 文档中公开，并且下游应用程序（包括通过 `gr.load` 加载此应用程序的应用程序）将无法使用此事件。

🔗

scroll_to_output: bool

默认值 = False

如果为 True，将在完成时滚动到输出组件

🔗

show_progress: Literal['full', 'minimal', 'hidden']

默认值 = "full"

事件运行时如何显示进度动画：“full”显示一个覆盖输出组件区域和右上角运行时显示的旋转器，“minimal”仅显示运行时显示，“hidden”完全不显示进度动画

🔗

show_progress_on: Component | list[Component] | None

默认值 = None

显示进度动画的组件或组件列表。如果为 None，则将在所有输出组件上显示进度动画。

🔗

queue: bool

默认值 = True

如果为 True，则请求将被放置在队列中，如果队列已启用。如果为 False，即使队列已启用，此事件也不会放入队列。如果为 None，则将使用 Gradio 应用程序的队列设置。

🔗

batch: bool

默认值 = False

如果为 True，则函数应处理一批输入，这意味着它应为每个参数接受一个输入值列表。这些列表的长度应相等（且最长可达 `max_batch_size`）。然后 *要求* 函数返回一个列表元组（即使只有一个输出组件），元组中的每个列表对应一个输出组件。

🔗

max_batch_size: int

默认值 = 4

如果从队列调用此函数，则批处理的最大输入数量（仅当 batch=True 时相关）

🔗

preprocess: bool

默认值 = True

如果为 False，在运行 'fn' 之前将不运行组件数据的预处理（例如，如果使用 `Image` 组件调用此方法，则将其保留为 base64 字符串）。

🔗

postprocess: bool

默认值 = True

如果为 False，在将 'fn' 输出返回到浏览器之前将不运行组件数据的后处理。

🔗

cancels: dict[str, Any] | list[dict[str, Any]] | None

默认值 = None

当此监听器触发时要取消的其他事件列表。例如，设置 cancels=[click_event] 将取消 click_event，其中 click_event 是另一个组件的 .click 方法的返回值。尚未运行的函数（或正在迭代的生成器）将被取消，但当前正在运行的函数将允许完成。

🔗

trigger_mode: Literal['once', 'multiple', 'always_last'] | None

默认值 = None

如果为“once”（除 `.change()` 之外所有事件的默认值），则在事件待处理时不允许任何提交。如果设置为“multiple”，则在待处理期间允许无限次提交，“always_last”（`.change()` 和 `.key_up()` 事件的默认值）则允许在待处理事件完成后进行第二次提交。

🔗

js: str | Literal[True] | None

默认值 = None

可选的前端 js 方法，在运行 'fn' 之前运行。js 方法的输入参数是 'inputs' 和 'outputs' 的值，返回值应为输出组件的值列表。

🔗

concurrency_limit: int | None | Literal['default']

默认值 = "default"

如果设置，这是可以同时运行此事件的最大数量。可以设置为 None 表示没有并发限制（可以同时运行任意数量的此事件）。设置为“default”以使用默认并发限制（由 `Blocks.queue()` 中的 `default_concurrency_limit` 参数定义，其本身默认为 1）。

🔗

concurrency_id: str | None

默认值 = None

如果设置，这是并发组的 ID。具有相同 concurrency_id 的事件将受最低设置的 concurrency_limit 限制。

🔗

show_api: bool

默认值 = True

是否在 Gradio 应用程序的“查看 API”页面或 Gradio 客户端的“.view_api()”方法中显示此事件。与将 api_name 设置为 False 不同，将 show_api 设置为 False 仍允许下游应用程序和客户端使用此事件。如果 fn 为 None，show_api 将自动设置为 False。

🔗

time_limit: int | None

默认值 = None

🔗

stream_every: float

默认值 = 0.5

🔗

like_user_message: bool

默认值 = False

🔗

key: int | str | tuple[int | str, ...] | None

默认值 = None

此事件监听器的唯一键，用于 `@gr.render()`。如果设置，此值在重新渲染时将事件识别为与键相同的事件。

指南

实时语音识别

←

状态 (State)

计时器 (Timer)

→

文本框

描述

创建一个文本区域，供用户输入字符串或显示字符串输出。

行为

作为输入组件: 将文本值作为 str 传递给函数。

您的函数应接受以下类型之一

作为输出组件: 期望从函数返回一个 str 并将其设置为文本区域的值。

您的函数应返回以下类型之一

初始化

快捷方式

演示

事件监听器

描述

支持的事件监听器

事件参数

指南

作为输入组件: 将文本值作为 `str` 传递给函数。

作为输出组件: 期望从函数返回一个 `str` 并将其设置为文本区域的值。