组件
Dropdown

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

DownloadButton

DuplicateButton

Dropdown

gradio.Dropdown(···)

import gradio as gr with gr.Blocks() as demo: gr.Dropdown(choices=["First Choice", "Second Choice", "Third Choice"]) demo.launch()

描述

创建一个下拉菜单，从中可以选择单个条目或多个条目（作为输入组件）或显示（作为输出组件）。

行为

作为输入组件: 根据 `type`，将所选下拉选项的值作为 `str | int | float` 或其索引作为 `int` 传递到函数中。或者，如果 `multiselect` 为 True，则将所选下拉选项的值作为相应值/索引的列表传递。

你的函数应接受以下类型之一

def predict(
	value: str | int | float | list[str | int | float] | list[int | None] | None
)
	...

作为输出组件: 期望一个 `str | int | float`，对应于要选择的下拉条目的值。或者，如果 `multiselect` 为 True，则期望一个 `list` 的值，对应于所选的下拉条目。

你的函数应返回以下类型之一

def predict(···) -> str | int | float | list[str | int | float] | None
	...	
	return value

初始化

🔗

choices: list[str | int | float | tuple[str, str | int | float]] | None

choices = None

要从中选择的字符串或数字选项列表。选项也可以是 (name, value) 形式的元组，其中 name 是下拉选项的显示名称，value 是要传递给函数的值，或由函数返回的值。

🔗

value: str | int | float | list[str | int | float] | Callable | DefaultValue | None

default = DefaultValue()

下拉菜单中选定的值。如果 `multiselect` 为 true，则应为列表，否则应为 `choices` 中的单个字符串或数字。默认情况下，最初选择 `choices` 中的第一个选项。如果显式设置为 None，则最初不选择任何值。如果提供了函数，则每次加载应用程序时都会调用该函数以设置此组件的初始值。

🔗

filterable: bool

filterable = True

如果为 True，用户将能够在下拉菜单中键入内容，并通过键入内容来过滤选项。仅当 `allow_custom_value` 为 False 时才能设置为 False。

🔗

label: str | None

choices = None

此组件的标签，如果 `show_label` 为 `True`，则显示在组件上方，如果此组件有示例表，则也用作标题。如果为 None 且在 `gr.Interface` 中使用，则标签将是此组件对应的参数名称。

🔗

every: Timer | float | None

choices = None

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

🔗

inputs: Component | list[Component] | set[Component] | None

choices = None

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

🔗

scale: int | None

choices = None

与相邻组件相比的相对大小。例如，如果组件 A 和 B 在同一行中，并且 A 的 scale=2，而 B 的 scale=1，则 A 的宽度将是 B 的两倍。应为整数。scale 应用于行，以及 Blocks 中 fill_height=True 的顶级组件。

🔗

min_width: int

min_width = 160

最小像素宽度，如果屏幕空间不足以满足此值，则将换行。如果某个 scale 值导致此组件比 min_width 更窄，则将首先遵循 min_width 参数。

🔗

interactive: bool | None

choices = None

如果为 True，则此下拉菜单中的选项将是可选择的；如果为 False，则将禁用选择。如果未提供，则根据组件是用作输入还是输出进行推断。

快捷方式

类	Interface 字符串快捷方式	初始化
`gradio.Dropdown`	"dropdown"	使用默认值

演示

import gradio as gr def sentence_builder(quantity, animal, countries, place, activity_list, morning): return f"""The {quantity} {animal}s from {" and ".join(countries)} went to the {place} where they {" and ".join(activity_list)} until the {"morning" if morning else "night"}""" demo = gr.Interface( sentence_builder, [ gr.Slider(2, 20, value=4, label="Count", info="在 2 到 20 之间选择"), gr.Dropdown( ["cat", "dog", "bird"], label="Animal", info="稍后会添加更多动物！" ), gr.CheckboxGroup(["USA", "Japan", "Pakistan"], label="Countries", info="它们来自哪里？"), gr.Radio(["park", "zoo", "road"], label="Location", info="它们去了哪里？"), gr.Dropdown( ["ran", "swam", "ate", "slept"], value=["swam", "slept"], multiselect=True, label="Activity", info="Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed auctor, nisl eget ultricies aliquam, nunc nisl aliquet nunc, eget aliquam nisl nunc vel nisl。" ), gr.Checkbox(label="Morning", info="它们在早上做的吗？"), ], "text", examples=[ [2, "cat", ["Japan", "Pakistan"], "park", ["ate", "swam"], True], [4, "dog", ["Japan"], "zoo", ["ate", "swam"], False], [10, "bird", ["USA", "Pakistan"], "road", ["ran"], False], [8, "cat", ["Pakistan"], "zoo", ["ate"], True], ] ) if __name__ == "__main__": demo.launch()

import gradio as gr

def sentence_builder(quantity, animal, countries, place, activity_list, morning):
    return f"""The {quantity} {animal}s from {" and ".join(countries)} went to the {place} where they {" and ".join(activity_list)} until the {"morning" if morning else "night"}"""

demo = gr.Interface(
    sentence_builder,
    [
        gr.Slider(2, 20, value=4, label="Count", info="Choose between 2 and 20"),
        gr.Dropdown(
            ["cat", "dog", "bird"], label="Animal", info="Will add more animals later!"
        ),
        gr.CheckboxGroup(["USA", "Japan", "Pakistan"], label="Countries", info="Where are they from?"),
        gr.Radio(["park", "zoo", "road"], label="Location", info="Where did they go?"),
        gr.Dropdown(
            ["ran", "swam", "ate", "slept"], value=["swam", "slept"], multiselect=True, label="Activity", info="Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed auctor, nisl eget ultricies aliquam, nunc nisl aliquet nunc, eget aliquam nisl nunc vel nisl."
        ),
        gr.Checkbox(label="Morning", info="Did they do it in the morning?"),
    ],
    "text",
    examples=[
        [2, "cat", ["Japan", "Pakistan"], "park", ["ate", "swam"], True],
        [4, "dog", ["Japan"], "zoo", ["ate", "swam"], False],
        [10, "bird", ["USA", "Pakistan"], "road", ["ran"], False],
        [8, "cat", ["Pakistan"], "zoo", ["ate"], True],
    ]
)

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

事件侦听器

描述

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

支持的事件侦听器

Dropdown 组件支持以下事件侦听器。每个事件侦听器都采用相同的参数，这些参数在下面的事件参数表中列出。

侦听器	描述
`Dropdown.change(fn, ···)`	当 Dropdown 的值因用户输入（例如，用户在文本框中键入内容）或函数更新（例如，图像从事件触发器的输出接收值）而更改时触发。有关仅由用户输入触发的侦听器，请参见 `.input()`。
`Dropdown.input(fn, ···)`	当用户更改 Dropdown 的值时，将触发此侦听器。
`Dropdown.select(fn, ···)`	当用户选择或取消选择 Dropdown 时的事件侦听器。使用事件数据 gradio.SelectData 来传递 `value`（指 Dropdown 的标签）和 `selected`（指 Dropdown 的状态）。有关如何使用此事件数据的详细信息，请参见 EventData 文档
`Dropdown.focus(fn, ···)`	当 Dropdown 获得焦点时，将触发此侦听器。
`Dropdown.blur(fn, ···)`	当 Dropdown 失去焦点/模糊时，将触发此侦听器。
`Dropdown.key_up(fn, ···)`	当用户在 Dropdown 获得焦点时按下键时，将触发此侦听器。

事件参数

🔗

fn: Callable | None | Literal['decorator']

fn = "decorator"

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

🔗

inputs: Component | BlockContext | list[Component | BlockContext] | Set[Component | BlockContext] | None

choices = None

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

🔗

outputs: Component | BlockContext | list[Component | BlockContext] | Set[Component | BlockContext] | None

choices = None

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

🔗

api_name: str | None | Literal[False]

choices = None

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

🔗

scroll_to_output: bool

multiselect = False

如果为 True，则完成后将滚动到输出组件

🔗

show_progress: Literal['full', 'minimal', 'hidden']

api_name = "full"

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

🔗

show_progress_on: Component | list[Component] | None

choices = None

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

🔗

queue: bool

filterable = True

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

🔗

batch: bool

multiselect = False

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

🔗

max_batch_size: int

max_batch_size = 4

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

🔗

preprocess: bool

filterable = True

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

🔗

postprocess: bool

filterable = True

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

🔗

cancels: dict[str, Any] | list[dict[str, Any]] | None

choices = None

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

🔗

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

choices = None

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

🔗

js: str | Literal[True] | None

choices = None

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

🔗

concurrency_limit: int | None | Literal['default']

concurrency_limit = "default"

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

🔗

concurrency_id: str | None

choices = None

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

🔗

show_api: bool

filterable = True

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

🔗