Gradio 的百万月活用户之旅！

阅读更多
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
default = None

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

🔗 
label: str | None
default = None

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

🔗 
every: Timer | float | None
default = None

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

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

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

🔗 
show_label: bool
default = False

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

🔗 
visible: 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

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

🔗 
min_height: int | None
default = None

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

🔗 
max_height: int | None
default = None

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

🔗 
container: bool
default = False

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

🔗 
padding: bool
default = 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']
default = "decorator"

触发此事件时要调用的函数。通常是机器学习模型的预测函数。函数的每个参数对应一个输入组件，并且函数应返回单个值或值元组，元组中的每个元素对应一个输出组件。

🔗 
inputs: Component | BlockContext | list[Component | BlockContext] | Set[Component | BlockContext] | None
default = None

用作输入的 gradio.components 列表。如果函数不接受任何输入，则应为空列表。

🔗 
outputs: Component | BlockContext | list[Component | BlockContext] | Set[Component | BlockContext] | None
default = None

用作输出的 gradio.components 列表。如果函数不返回任何输出，则应为空列表。

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

定义端点在 API 文档中的显示方式。可以是字符串、None 或 False。如果设置为字符串，则端点将在 API 文档中以给定的名称公开。如果为 None（默认值），则函数的名称将用作 API 端点。如果为 False，则端点将不会在 API 文档中公开，并且下游应用（包括 `gr.load` 此应用的那些应用）将无法使用此事件。

🔗 
scroll_to_output: bool
default = False

如果为 True，则在完成时滚动到输出组件

🔗 
show_progress: Literal['full', 'minimal', 'hidden']
default = "full"

在事件运行时如何显示进度动画：“full”显示一个覆盖输出组件区域的微调器以及右上角的运行时显示，“minimal”仅显示运行时显示，“hidden”不显示任何进度动画

🔗 
show_progress_on: Component | list[Component] | None
default = None

要在其上显示进度动画的组件或组件列表。如果为 None，则将在所有输出组件上显示进度动画。

🔗 
queue: bool
default = True

如果为 True，则将请求放在队列中（如果已启用队列）。如果为 False，则不会将此事件放在队列中，即使已启用队列也是如此。如果为 None，将使用 gradio 应用的队列设置。

🔗 
batch: bool
default = False

如果为 True，则函数应处理一批输入，这意味着它应接受每个参数的输入值列表。列表的长度应相等（并且最多为 `max_batch_size`）。然后*需要*函数返回列表元组（即使只有一个输出组件），元组中的每个列表对应一个输出组件。

🔗 
max_batch_size: int
default = 4

如果从队列中调用此方法，则要批量处理的最大输入数（仅在 batch=True 时相关）

🔗 
preprocess: bool
default = True

如果为 False，则在运行“fn”之前不会运行组件数据的预处理（例如，如果使用 `Image` 组件调用此方法，则将其保留为 base64 字符串）。

🔗 
postprocess: bool
default = True

如果为 False，则在将“fn”输出返回到浏览器之前，不会运行组件数据的后处理。

🔗 
cancels: dict[str, Any] | list[dict[str, Any]] | None
default = None

触发此侦听器时要取消的其他事件的列表。例如，设置 cancels=[click_event] 将取消 click_event，其中 click_event 是另一个组件的 .click 方法的返回值。尚未运行（或正在迭代的生成器）的函数将被取消，但当前正在运行的函数将允许完成。

🔗 
trigger_mode: Literal['once', 'multiple', 'always_last'] | None
default = None

如果为“once”（除 `.change()` 之外的所有事件的默认值），则在事件挂起时不允许任何提交。如果设置为“multiple”，则在挂起时允许无限次提交；“always_last”（`.change()` 和 `.key_up()` 事件的默认值）将在挂起事件完成后允许第二次提交。

🔗 
js: str | Literal[True] | None
default = None

在运行“fn”之前要运行的可选前端 js 方法。js 方法的输入参数是“inputs”和“outputs”的值，返回值应为输出组件的值列表。

🔗 
concurrency_limit: int | None | Literal['default']
default = "default"

如果设置，这是可以同时运行的此事件的最大数量。可以设置为 None，表示没有 concurrency_limit（可以同时运行任意数量的此事件）。设置为“default”以使用默认并发限制（由 `Blocks.queue()` 中的 `default_concurrency_limit` 参数定义，其本身默认为 1）。

🔗 
concurrency_id: str | None
default = None

如果设置，这是并发组的 id。具有相同 concurrency_id 的事件将受到最低设置 concurrency_limit 的限制。

🔗 
show_api: bool
default = True

是否在 Gradio 应用的“查看 API”页面或 Gradio 客户端的 “.view_api()” 方法中显示此事件。与将 api_name 设置为 False 不同，将 show_api 设置为 False 仍将允许下游应用以及客户端使用此事件。如果 fn 为 None，show_api 将自动设置为 False。

🔗 
time_limit: int | None
default = None
🔗 
stream_every: float
default = 0.5
🔗 
like_user_message: bool
default = False
←

HighlightedText

Image

→