组件
按钮

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

条形图

聊天机器人

按钮

gradio.Button(···)

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

描述

创建一个按钮，可以为其分配任意的 .click() 事件。按钮的值（标签）可以用作函数的输入（很少使用），也可以通过函数的输出来设置。

行为

作为输入组件: （很少使用）当按钮被点击时，对应于按钮标签的`str`字符串。

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

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

作为输出组件: 对应于按钮标签的字符串

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

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

初始化

🔗

value: str | I18nData | Callable

默认值 = "Run"

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

🔗

every: Timer | float | None

默认值 = None

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

🔗

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

默认值 = None

如果 `value` 是一个函数，则用作计算 `value` 的输入组件（否则无效）。每当输入发生变化时，都会重新计算 `value`。

🔗

variant: Literal['primary', 'secondary', 'stop', 'huggingface']

默认值 = "secondary"

设置按钮的背景和文本颜色。'primary' 用于主要行动号召按钮，'secondary' 用于更柔和的样式，'stop' 用于停止按钮，'huggingface' 用于黑色背景白色文本，与 Hugging Face 的按钮样式保持一致。

🔗

size: Literal['sm', 'md', 'lg']

默认值 = "lg"

按钮大小。可以是 "sm"、"md" 或 "lg"。

🔗

icon: str | Path | None

默认值 = None

按钮中要显示的图标文件的 URL 或路径。如果为 None，则不显示图标。

🔗

link: str | None

默认值 = None

点击按钮时要打开的 URL。如果为 None，则不使用链接。

🔗

visible: bool

默认值 = True

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

🔗

interactive: bool

默认值 = True

如果为 False，则按钮将处于禁用状态。

🔗

elem_id: str | None

默认值 = None

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

🔗

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 中，在重新渲染时具有相同 key 的组件被视为同一组件，而不是新组件。'preserved_by_key' 中设置的属性在重新渲染时不会重置。

🔗

preserved_by_key: list[str] | str | None

默认值 = "value"

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

🔗

scale: int | None

默认值 = None

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

🔗

min_width: int | None

默认值 = None

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

快捷方式

类	界面字符串快捷方式	初始化
`gradio.Button`	"button"	使用默认值
`gradio.ClearButton`	"clearbutton"	使用默认值
`gradio.DeepLinkButton`	"deeplinkbutton"	使用默认值
`gradio.DuplicateButton`	"duplicatebutton"	使用默认值
`gradio.LoginButton`	"loginbutton"	使用默认值

事件监听器

描述

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

支持的事件监听器

按钮（Button）组件支持以下事件监听器。每个事件监听器都接受相同的参数，这些参数在下面的事件参数表中列出。

监听器	描述
`Button.click(fn, ···)`	当按钮被点击时触发。

事件参数

🔗

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

在运行 'fn' 之前运行的可选前端 js 方法。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()。如果设置，当键相同时，此值会将事件标识为在重新渲染时是相同的。

←

条形图

聊天机器人

→

按钮

描述

创建一个按钮，可以为其分配任意的 .click() 事件。按钮的值（标签）可以用作函数的输入（很少使用），也可以通过函数的输出来设置。

行为

作为输入组件: （很少使用）当按钮被点击时，对应于按钮标签的str字符串。

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

作为输出组件: 对应于按钮标签的字符串

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

初始化

快捷方式

事件监听器

描述

支持的事件监听器

事件参数

作为输入组件: （很少使用）当按钮被点击时，对应于按钮标签的`str`字符串。