组件
Textbox

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

State

Timer

Textbox

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 | Callable | None

default = None

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

🔗

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

default = "text"

文本框的类型。选项包括：'text'（允许用户输入任何文本），'password'（掩盖用户输入的文本），'email'（向浏览器建议电子邮件输入）。对于“password”和“email”类型，`lines` 必须为 1，`max_lines` 必须为 None 或 1。

🔗

lines: int

default = 1

文本区域中提供的最小行数。

🔗

max_lines: int | None

default = None

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

🔗

placeholder: str | None

default = None

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

🔗

label: str | None

default = None

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

🔗

info: str | None

default = None

额外的组件描述，显示在标签下方，字体较小。支持 markdown / HTML 语法。

🔗

every: Timer | float | None

default = None

如果 `value` 是函数，则持续调用 `value` 以重新计算它（否则无效）。可以提供一个 Timer，其刻度重置 `value`，或者提供一个浮点数作为重置 Timer 的固定间隔。

🔗

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

default = None

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

🔗

show_label: bool | None

default = None

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

🔗

container: bool

default = True

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

🔗

scale: int | None

default = None

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

🔗

min_width: int

default = 160

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

🔗

interactive: bool | None

default = None

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

🔗

visible: bool

default = True

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

🔗

elem_id: str | None

default = None

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

🔗

autofocus: bool

default = False

如果为 True，则在页面加载时将焦点放在文本框上。请谨慎使用此功能，因为它可能会给有视觉和无视觉障碍的用户带来可用性问题。

🔗

autoscroll: bool

default = True

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

🔗

elem_classes: list[str] | str | None

default = None

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

🔗

render: bool

default = True

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

🔗

key: int | str | None

default = None

如果已分配，将用于在重新渲染时假定身份。在重新渲染中具有相同 key 的组件将保留其值。

🔗

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

default = None

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

🔗

rtl: bool

default = False

如果为 True 且 `type` 为“text”，则将文本方向设置为从右到左（光标出现在文本的左侧）。默认值为 False，这会将光标呈现在右侧。

🔗

show_copy_button: bool

default = False

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

🔗

max_length: int | None

default = None

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

🔗

submit_btn: str | bool | None

default = False

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

🔗

stop_btn: str | bool | None

default = False

快捷方式

类	Interface 字符串快捷方式	初始化
`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="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()

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="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()

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 组件支持以下事件监听器。每个事件监听器都采用相同的参数，这些参数在下面的事件参数表中列出。

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

事件参数

🔗

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

default = "decorator"

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

🔗

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

default = None

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

🔗

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

default = None

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

🔗

api_name: str | None | Literal[False]

default = None

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

🔗

scroll_to_output: bool

default = False

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

🔗

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

default = "full"

在事件运行时如何显示进度动画：“full”显示一个覆盖输出组件区域的微调器，以及右上角的运行时显示，“minimal”仅显示运行时显示，“hidden”不显示任何进度动画

🔗

show_progress_on: Component | list[Component] | None

default = None

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

🔗

queue: bool

default = True

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

🔗

batch: bool

default = False

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

🔗

max_batch_size: int

default = 4

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

🔗

preprocess: bool

default = True

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

🔗

postprocess: bool

default = True

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

🔗

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

default = None

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

🔗

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

default = None

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

🔗

js: str | Literal[True] | None

default = None

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

🔗

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

default = "default"

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

🔗

concurrency_id: str | None

default = None

如果设置，则这是 concurrency 组的 id。具有相同 concurrency_id 的事件将受到最低设置的 concurrency_limit 的限制。

🔗

show_api: bool

default = True

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

🔗