Gradio 用户月活量达到 100 万！

阅读更多
Gradio logo
  1. 组件
  2. ClearButton

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

查看发布历史

←

CheckboxGroup

Code

→

ClearButton

gradio.ClearButton(···)
import gradio as gr with gr.Blocks() as demo: textbox = gr.Textbox(value="This is some text") gr.ClearButton(textbox) demo.launch()

描述

点击时清除组件或组件列表的值的按钮。它使用要清除的组件列表进行实例化。

行为

作为输入组件: （极少使用）点击按钮时，与按钮标签对应的 str

你的函数应接受以下类型之一
def predict(
	value: str | None
)
	...

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

你的函数应返回以下类型之一
def predict(···) -> str | None
	...	
	return value

初始化

参数
🔗 
components: None | list[Component] | Component
default = None
🔗 
value: str
default = "Clear"

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

🔗 
every: Timer | float | None
default = None

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

🔗 
inputs: Component | list[Component] | set[Component] | None
default = None

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

🔗 
variant: Literal['primary', 'secondary', 'stop']
default = "secondary"

设置按钮的背景和文本颜色。主操作按钮使用“primary”，更柔和的样式使用“secondary”，停止按钮使用“stop”，与 Hugging Face 的按钮样式一致的黑色背景白色文本使用“huggingface”。

🔗 
size: Literal['sm', 'md', 'lg']
default = "lg"

按钮的大小。可以是“sm”、“md”或“lg”。

🔗 
icon: str | Path | None
default = None

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

🔗 
visible: bool
default = True

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

🔗 
interactive: bool
default = True

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

🔗 
elem_id: str | None
default = None

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

🔗 
elem_classes: list[str] | str | None
default = None

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

🔗 
render: bool
default = True

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

🔗 
key: int | str | None
default = None

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

🔗 
scale: int | None
default = None

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

🔗 
min_width: int | None
default = None

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

🔗 
api_name: str | None | Literal['False']
default = None
🔗 
show_api: bool
default = False

快捷方式

类 Interface 字符串快捷方式 初始化

gradio.ClearButton

"clearbutton"

 使用默认值

事件侦听器

描述

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

支持的事件侦听器

ClearButton 组件支持以下事件侦听器。每个事件侦听器都采用相同的参数，这些参数在下面的事件参数表中列出。

侦听器 描述

ClearButton.add(fn, ···)

向单击按钮时将清除的组件列表中添加一个组件或组件列表。

ClearButton.click(fn, ···)

在单击按钮时触发。

事件参数

参数
🔗 
components: None | Component | list[Component]
←

CheckboxGroup

Code

→