Gradio Agents 与 MCP Hackathon

获奖者
Gradio logo
  1. 组件
  2. HTML

Gradio 新用户？从这里开始：快速入门

查看发布历史

←

HighlightedText

Image

→

HTML

gradio.HTML(···)
import gradio as gr with gr.Blocks() as demo: with gr.Group(): gr.HTML(value="<p style='margin-top: 1rem, margin-bottom: 1rem'>This <em>example</em> was <strong>written</strong> in <a href='https://en.wikipedia.org/wiki/HTML' _target='blank'>HTML</a> </p>") demo.launch()

描述

创建一个用于显示任意 HTML 输出的组件。由于此组件不接受用户输入，因此很少用作输入组件。

行为

作为输入组件: (很少使用) 将 HTML 作为 str 传递。

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

作为输出组件: 期望一个由有效 HTML 组成的 str。

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

初始化

参数
🔗 
value: str | Callable | None
默认值 = None

要显示的 HTML 内容。只渲染静态 HTML (例如，没有 JavaScript。要渲染 JavaScript，请在 `Blocks` 构造函数中使用 `js` 或 `head` 参数)。如果提供函数，则每次应用加载时都会调用该函数以设置此组件的初始值。

🔗 
label: str | I18nData | None
默认值 = None

此组件的标签。如果此组件有示例表格，则用作标题。如果为 None 并在 `gr.Interface` 中使用，则标签将为此组件分配的参数名称。

🔗 
every: Timer | float | None
默认值 = None

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

🔗 
inputs: Component | list[Component] | set[Component] | None
默认值 = None

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

🔗 
show_label: bool
默认值 = False

如果为 True，则显示标签。如果为 False，则隐藏标签。

🔗 
visible: 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() 函数内部，如果一个组件以相同的 key 重新渲染，则这些（且仅这些）参数将在 UI 中保留（如果它们已被用户或事件监听器更改），而不是根据构造函数期间提供的值重新渲染。

🔗 
min_height: int | None
默认值 = None

组件的最小高度，如果传入数字则以像素为单位指定，如果传入字符串则以 CSS 单位指定。如果 HTML 内容超出高度，组件将扩展以适应内容。

🔗 
max_height: int | None
默认值 = None

组件的最大高度，如果传入数字则以像素为单位指定，如果传入字符串则以 CSS 单位指定。如果内容超出高度，组件将滚动。

🔗 
container: bool
默认值 = False

如果为 True，HTML 组件将显示在一个容器中。默认值为 False。

🔗 
padding: bool
默认值 = True

如果为 True，HTML 组件将在所有方向上具有一定的内边距（由 `--block-padding` CSS 变量设置）。默认值为 True。

快捷方式

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

gradio.HTML

"html"

 使用默认值

演示

import gradio as gr

demo = gr.Blocks()

with demo:
    inp = gr.Textbox(placeholder="Enter text.")
    scroll_btn = gr.Button("Scroll")
    no_scroll_btn = gr.Button("No Scroll")
    big_block = gr.HTML("""
    

    """)
    out = gr.Textbox()

    scroll_btn.click(lambda x: x,
               inputs=inp,
               outputs=out,
                scroll_to_output=True)
    no_scroll_btn.click(lambda x: x,
               inputs=inp,
               outputs=out)

if __name__ == "__main__":
    demo.launch()

事件监听器

描述

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

支持的事件监听器

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

监听器 描述

HTML.change(fn, ···)

当 HTML 的值因用户输入（例如，用户在文本框中输入）或函数更新（例如，图像接收来自事件触发器输出的值）而改变时触发。对于仅由用户输入触发的监听器，请参见 .input()。

HTML.click(fn, ···)

当 HTML 被点击时触发。

事件参数

参数
🔗 
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() 的此事件监听器的唯一 key。如果设置，此值在 key 相同时跨重新渲染将事件标识为相同。

←

HighlightedText

Image

→