Gradio Agents & MCP 黑客马拉松

获奖者
Gradio logo
  1. 组件
  2. 侧边栏

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

查看发布历史

←

ScatterPlot

SimpleImage

→

侧边栏

gradio.Sidebar(···)

描述

侧边栏是一个可折叠面板，在 Blocks 布局中渲染位于屏幕左侧的子组件。

使用示例

with gr.Blocks() as demo:
    with gr.Sidebar():
        gr.Textbox()
        gr.Button()

初始化

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

侧边栏的名称。不向用户显示。

🔗 
open: bool
默认值 = True

如果为 True，侧边栏默认打开。

🔗 
visible: bool
默认值 = True
🔗 
elem_id: str | None
默认值 = None

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

🔗 
elem_classes: list[str] | str | None
默认值 = None

一个可选字符串或字符串列表，作为此组件在 HTML DOM 中的 class。可用于定位 CSS 样式。

🔗 
render: bool
默认值 = True

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

🔗 
width: int | str
默认值 = 320

侧边栏的宽度，如果传递数字则以像素为单位，如果传递字符串则以 CSS 单位为单位。

🔗 
position: Literal['left', 'right']
默认值 = "left"

侧边栏在布局中的位置，可以是 "left" 或 "right"。默认值为 "left"。

🔗 
key: int | str | tuple[int | str, ...] | None
默认值 = None

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

🔗 
preserved_by_key: list[str] | str | None
默认值 = None

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

方法

expand 

gradio.Sidebar.expand(···)

描述

当侧边栏展开时触发此监听器。

参数
🔗 
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 文档中的显示方式。可以是 string, None 或 False。如果设置为 string，端点将以给定名称在 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 表示没有 concurrency_limit（任意数量的此事件都可以同时运行）。设置为 "default" 以使用默认的并发限制（由 `Blocks.queue()` 中的 `default_concurrency_limit` 参数定义，其本身默认为 1）。

🔗 
concurrency_id: str | None
默认值 = None

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

🔗 
show_api: bool
默认值 = True

是否在 Gradio 应用的 "view 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 相同时标识跨重新渲染的事件是相同的。

collapse 

gradio.Sidebar.collapse(···)

描述

当侧边栏折叠时触发此监听器。

参数
🔗 
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 文档中的显示方式。可以是 string, None 或 False。如果设置为 string，端点将以给定名称在 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 表示没有 concurrency_limit（任意数量的此事件都可以同时运行）。设置为 "default" 以使用默认的并发限制（由 `Blocks.queue()` 中的 `default_concurrency_limit` 参数定义，其本身默认为 1）。

🔗 
concurrency_id: str | None
默认值 = None

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

🔗 
show_api: bool
默认值 = True

是否在 Gradio 应用的 "view 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 相同时标识跨重新渲染的事件是相同的。

指南

控制布局

←

ScatterPlot

SimpleImage

→