组件
颜色选择器

初次使用 Gradio？从这里开始：入门

代码

数据框

颜色选择器

gradio.ColorPicker(···)

import gradio as gr with gr.Blocks() as demo: with gr.Column(): input = gr.ColorPicker(interactive=True) output = gr.Markdown("You picked: **#000000**") def pick(color): return "You picked: **" + color + "**" input.change(pick, input, output) demo.launch()

描述

创建一个颜色选择器，供用户选择颜色作为字符串输入。可用作将颜色值传递给函数的输入，或用作显示颜色值的输出。

行为

作为输入组件: 将选定的颜色值作为十六进制 `str` 传递给函数。

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

def predict(
	value: str | None
)
	...

作为输出组件: 期望函数返回一个十六进制 `str` 并将其设置为颜色选择器值。

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

def predict(···) -> str | None
	...	
	return value

初始化

🔗

value: str | Callable | None

默认值 = None

在颜色选择器中提供的默认颜色十六进制代码。如果提供了函数，则每次应用程序加载时都会调用该函数以设置此组件的初始值。

🔗

label: str | I18nData | None

默认值 = None

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

🔗

info: str | I18nData | None

默认值 = None

附加组件描述，以较小字体显示在标签下方。支持 Markdown / HTML 语法。

🔗

every: Timer | float | None

默认值 = None

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

🔗

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

默认值 = None

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

🔗

show_label: bool | None

默认值 = None

如果为 True，将显示标签。

🔗

container: bool

默认值 = True

如果为 True，会将组件放置在容器中——在边框周围提供一些额外填充。

🔗

scale: int | None

默认值 = None

与相邻组件的相对大小。例如，如果组件 A 和 B 在一行中，且 A 的 scale=2，B 的 scale=1，则 A 的宽度是 B 的两倍。应为整数。scale 适用于行，以及 `fill_height=True` 的块中的顶层组件。

🔗

min_width: int

默认值 = 160

最小像素宽度，如果屏幕空间不足以满足此值，则会换行。如果某个 scale 值导致此组件的宽度小于 min_width，则 min_width 参数将首先被尊重。

🔗

interactive: bool | None

默认值 = None

如果为 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 中（如果它们已被用户或事件监听器更改），而不是根据构造函数中提供的值重新渲染。

快捷方式

类	接口字符串快捷方式	初始化
`gradio.ColorPicker`	"colorpicker"	使用默认值

演示

import gradio as gr import numpy as np from PIL import Image, ImageColor def change_color(icon, color): """ 给定 .png 格式的图标，更改其颜色的函数 Args: icon: 需要更改颜色的图标。 color: 用于编辑输入图标的选定颜色。 Returns: edited_image: 已编辑的图标。 """ img = icon.convert("LA") img = img.convert("RGBA") image_np = np.array(icon) _, _, _, alpha = image_np.T mask = alpha > 0 image_np[..., :-1][mask.T] = ImageColor.getcolor(color, "RGB") edited_image = Image.fromarray(image_np) return edited_image inputs = [ gr.Image(label="icon", type="pil", image_mode="RGBA"), gr.ColorPicker(label="color"), ] outputs = gr.Image(label="colored icon") demo = gr.Interface( fn=change_color, inputs=inputs, outputs=outputs ) if __name__ == "__main__": demo.launch()

import gradio as gr
import numpy as np
from PIL import Image, ImageColor

def change_color(icon, color):

    """
    Function that given an icon in .png format changes its color
    Args:
        icon: Icon whose color needs to be changed.
        color: Chosen color with which to edit the input icon.
    Returns:
        edited_image: Edited icon.
    """
    img = icon.convert("LA")
    img = img.convert("RGBA")
    image_np = np.array(icon)
    _, _, _, alpha = image_np.T
    mask = alpha > 0
    image_np[..., :-1][mask.T] = ImageColor.getcolor(color, "RGB")
    edited_image = Image.fromarray(image_np)
    return edited_image

inputs = [
    gr.Image(label="icon", type="pil", image_mode="RGBA"),
    gr.ColorPicker(label="color"),
]
outputs = gr.Image(label="colored icon")

demo = gr.Interface(
    fn=change_color,
    inputs=inputs,
    outputs=outputs
)

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

事件监听器

描述

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

支持的事件监听器

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

监听器	描述
`ColorPicker.change(fn, ···)`	当 ColorPicker 的值因用户输入（例如用户在文本框中输入）或函数更新（例如图像从事件触发器的输出接收值）而改变时触发。请参阅 `.input()`，以了解仅由用户输入触发的监听器。
`ColorPicker.input(fn, ···)`	当用户更改 ColorPicker 的值时触发此监听器。
`ColorPicker.submit(fn, ···)`	当 ColorPicker 获得焦点时，用户按下 Enter 键时触发此监听器。
`ColorPicker.focus(fn, ···)`	当 ColorPicker 获得焦点时触发此监听器。
`ColorPicker.blur(fn, ···)`	当 ColorPicker 失去焦点/模糊时触发此监听器。

事件参数

🔗

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 表示没有 `concurrency_limit`（此事件可以同时运行任意数量）。设置为“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 相同的情况下，会将事件识别为相同。

←

代码

数据框

→

颜色选择器

描述

创建一个颜色选择器，供用户选择颜色作为字符串输入。可用作将颜色值传递给函数的输入，或用作显示颜色值的输出。

行为

作为输入组件: 将选定的颜色值作为十六进制 str 传递给函数。

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

作为输出组件: 期望函数返回一个十六进制 str 并将其设置为颜色选择器值。

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

初始化

快捷方式

演示

事件监听器

描述

支持的事件监听器

事件参数

作为输入组件: 将选定的颜色值作为十六进制 `str` 传递给函数。

作为输出组件: 期望函数返回一个十六进制 `str` 并将其设置为颜色选择器值。