- 组件
- ClearButton
ClearButton
gradio.ClearButton(···)描述
一个按钮,点击时会清除一个组件或一个组件列表的值。实例化时需要传入要清除的组件列表。
行为
作为输入组件: (很少使用)按钮被点击时对应的按钮标签的 str
您的函数应接受其中一种类型
def predict(
value: str | None
)
...作为输出组件: 对应按钮标签的字符串
您的函数应返回其中一种类型
def predict(···) -> str | None
...
return value初始化
every: Timer | float | None
every: Timer | float | None= None如果 `value` 是一个函数,则持续调用 `value` 来重新计算它(否则无效)。可以提供一个 Timer,其 tick 会重置 `value`,或者一个 float 来提供重置 Timer 的常规间隔。
inputs: Component | list[Component] | set[Component] | None
inputs: Component | list[Component] | set[Component] | None= None如果 `value` 是一个函数(否则不起作用),则用作计算 `value` 的输入的组件。`value` 在输入更改时会重新计算。
variant: Literal['primary', 'secondary', 'stop']
variant: Literal['primary', 'secondary', 'stop']= "secondary"设置按钮的背景和文本颜色。使用 'primary' 用于主要行动号召按钮,'secondary' 用于更柔和的风格,'stop' 用于停止按钮,'huggingface' 用于与 Hugging Face 的按钮样式一致的黑色背景和白色文本。
visible: bool | Literal['hidden']
visible: bool | Literal['hidden']= True如果为 False,则组件将隐藏。如果为“hidden”,则组件将视觉上隐藏并且不会在布局中占用空间,但仍存在于 DOM 中。
key: int | str | tuple[int | str, ...] | None
key: int | str | tuple[int | str, ...] | None= None在 `gr.render` 中,跨重渲染具有相同键的组件被视为同一个组件,而不是一个新组件。在 `preserved_by_key` 中设置的属性在重渲染时不会重置。
preserved_by_key: list[str] | str | None
preserved_by_key: list[str] | str | None= "value"此组件构造函数中的参数列表。在 `gr.render()` 函数内部,如果一个组件使用相同的键进行重渲染,则这些(也是唯一的)参数将在 UI 中被保留(如果它们已被用户或事件监听器更改),而不是根据构造函数中提供的值进行重渲染。
scale: int | None
scale: int | None= None与相邻组件相比的相对大小。例如,如果组件 A 和 B 在一个 Row 中,A 的 scale 为 2,B 的 scale 为 1,则 A 的宽度将是 B 的两倍。应为整数。scale 适用于 Rows,以及 Blocks 中 fill_height=True 的顶级组件。
快捷方式
gradio.ClearButton
gradio.ClearButton"clearbutton"事件监听器
描述
事件监听器允许您响应 Gradio Blocks 应用中定义的 UI 组件的用户交互。当用户与元素交互时(例如,更改滑块值或上传图像),会调用一个函数。
支持的事件监听器
ClearButton 组件支持以下事件监听器。每个事件监听器都接受相同的参数,参数列表如下方的 事件参数 表格所示。
ClearButton.add(fn, ···)
ClearButton.add(fn, ···)向要清除的组件列表中添加一个组件或一个组件列表,当按钮点击时这些组件将被清除。
ClearButton.click(fn, ···)
ClearButton.click(fn, ···)在按钮被点击时触发。