Gradio 代理与 MCP 黑客马拉松

获奖者
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”用于停止按钮，“huggingface”用于黑色背景和白色文本，与 Hugging Face 的按钮样式一致。

🔗 
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 | tuple[int | str, ...] | None
default = None

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

🔗 
preserved_by_key: list[str] | str | None
default = "value"

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

🔗 
scale: int | None
default = None

相对于相邻组件的相对大小。例如，如果组件 A 和 B 在一个行中，A 的 scale=2，B 的 scale=1，则 A 将是 B 的两倍宽。应为整数。scale 适用于行，以及 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

快捷方式

类 界面字符串快捷方式 初始化

gradio.ClearButton

"clearbutton"

 使用默认值

事件监听器

描述

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

支持的事件监听器

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

监听器 描述

ClearButton.add(fn, ···)

将一个或多个组件添加到点击按钮时将被清除的组件列表中。

ClearButton.click(fn, ···)

当按钮被点击时触发。

事件参数

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

CheckboxGroup

Code

→