如需查看完整的文档索引,请参阅 llms.txt。在文档页面的 URL 末尾加上 .md 即可查看该页面的 Markdown 版本。
主导航
主题
概览 智能体访问 ChatGPT 与 Codex 用户文档 使用场景

UI 设计指南

在 ChatGPT 中设计可选插件界面的指南。

概览

可选的插件界面让用户在对话中完成更多操作,同时保持对话连贯。只有当可视化交互能让任务更容易完成时,才使用卡片、轮播、全屏视图等显示模式。

ChatGPT 移动端界面中的应用示例

设计系统

要设计与 ChatGPT 原生界面风格一致的高质量 UI,您可以使用 @openai/apps-sdk-ui 组件库。

该组件库提供基于 Tailwind 的基础样式、以 CSS 变量定义的设计令牌,以及一系列精心设计、支持无障碍访问的组件。

您可以按需使用该组件库,快速构建符合 ChatGPT 设计系统的组件。

在编写代码之前,先使用我们的 Figma 组件库进行设计。

显示模式

开发者可以通过不同的显示模式,在 ChatGPT 中构建应用界面。借助这些模式,合作伙伴可以在对话中自然地呈现内容和操作。从快速确认到沉浸式工作流程,每种模式都适用于特定的交互场景。

一致地使用这些模式,可以让操作保持简单,让用户知道接下来会发生什么。

内联模式

内联界面直接嵌入对话中。目前,内联界面始终显示在模型生成的回复之前。所有应用最初都以内联模式显示。

ChatGPT 中的内联卡片和轮播示例

布局

  • 图标与工具调用:标签显示应用名称和图标。
  • 内联界面:在模型回复上方以轻量界面展示应用内容。
  • 后续回复:小组件之后会显示模型生成的简短回复,建议用户如何修改、下一步可以做什么,或还有哪些相关操作。避免重复卡片中已有的内容。

内联卡片

内联卡片是直接嵌入对话的轻量小组件,每张卡片只服务于一个目的。用户可以通过卡片快速确认事项、执行基本操作或查看辅助图示。

适用场景

  • 执行一项操作或做出一个选择,例如确认预订。
  • 展示少量结构化数据,例如地图、订单摘要或简短的状态信息。
  • 提供一个功能完整、可独立使用的小组件或工具,例如音频播放器或记分卡。

布局

内联卡片布局示意图

  • 标题:如果卡片用于展示文档,或其中的条目同属一个上级元素(例如播放列表中的歌曲),请添加标题。
  • 展开:如果卡片包含富媒体或地图、交互式图表等交互内容,可通过此操作打开全屏视图。
  • 显示更多:如果以列表呈现多个结果,可通过此操作显示更多条目。
  • 编辑控件:让用户能直接在卡片中修改应用返回的内容,同时避免过多控件干扰对话。
  • 主要操作:在卡片底部放置最多两项操作。每项操作都应发起一轮对话或触发一次工具调用。

交互

内联卡片交互方式示意图

用户可以直接在卡片上进行简单的交互。

  • 状态:保存用户所做的修改。
  • 直接编辑:在适合的情况下,让用户直接在卡片中快速修改文本,无需向模型发送提示词。
  • 动态布局:卡片可随内容增高,但最高不超过移动端显示区域的高度。

设计要点

  • 限制每张卡片的主要操作数量:最多提供两项操作,其中一项为主要操作,另一项为可选的次要操作。
  • 避免在卡片内设置多层导航或多个视图。 卡片中不应包含多个通往下级视图的入口、选项卡或更深层级的导航。可考虑将这些内容拆分为独立的卡片或工具操作。
  • 避免嵌套滚动。卡片应根据内容自动调整大小,避免在卡片内部滚动。
  • 避免重复提供输入控件。不要在卡片中重复实现 ChatGPT 已有的功能。

内联卡片中应避免的设计示例

内联轮播

轮播将一组卡片横向并排展示,方便用户快速浏览多个选项并做出选择。

适用场景

  • 展示少量同类条目,例如餐厅、播放列表或活动。
  • 条目的视觉内容和元数据较多,普通列表行无法完整呈现。

布局

内联轮播布局示意图

  • 图片:每个条目都应包含图片或其他视觉元素。
  • 标题:轮播条目通常应带有标题,说明条目内容。
  • 元数据:结合当前回复,展示条目中最重要、最相关的信息。尽量将文本控制在两行以内。
  • 徽章:必要时使用徽章提供补充信息。
  • 操作:尽可能为每个条目提供一个清晰的操作入口。

设计要点

  • 为便于阅读,每组轮播应包含 3–8 个条目。
  • 元数据只保留最相关的信息,最多三行。
  • 每张卡片最多可提供一个操作入口,例如“预订”或“播放”。
  • 各张卡片的视觉层级应保持一致。

全屏模式

全屏视图将内容从内联卡片展开,为用户提供沉浸式体验,让他们有足够的空间完成多步流程或深入探索。ChatGPT 编辑器始终叠加显示在全屏视图上,用户可以围绕当前内容继续用自然语言“与应用对话”。

适用场景

  • 单张卡片无法承载的复杂任务,例如操作带标记的交互式地图、使用功能丰富的编辑画布或探索交互式图表。
  • 浏览详细内容,例如房源信息或菜单。

布局

全屏视图布局示意图

  • 系统关闭控件:关闭面板或视图。
  • 全屏视图:用于展示内容的区域。
  • 编辑器:ChatGPT 的原生编辑器,用户可在其中围绕当前全屏视图的内容继续提问或提出要求。

交互

全屏视图的交互方式

  • 聊天面板:在全屏界面中保留对话上下文。
  • 思考中:编辑器的输入框会出现微光动画,表示模型正在流式输出回复。
  • 回复:模型完成回复后,编辑器上方会短暂显示一小段回复内容。轻点即可打开聊天面板。

设计要点

  • 设计交互时,应考虑用户如何使用系统编辑器。编辑器在全屏模式下始终可见,因此请确保用户可以自然地通过对话输入提示词,触发工具调用。
  • 需要更大操作空间的任务应使用全屏模式。 如果现有的编辑器或管理界面符合 iframe 要求,就可以将其嵌入全屏视图。

画中画(PiP)

画中画是 ChatGPT 内持续显示的悬浮窗口,适合游戏或视频等需要持续运行或实时更新的场景。用户继续对话时,画中画窗口仍然可见,还可以根据用户的提示词动态更新。

适用场景

  • 与对话同时进行的活动,例如游戏、实时协作、测验或学习活动。
  • 画中画小组件可以响应聊天输入的场景,例如根据用户的请求继续当前回合的游戏或刷新实时数据。

交互

画中画的交互方式

  • 已激活: 用户滚动时,画中画窗口固定在显示区域顶部。
  • 已固定: 画中画窗口保持固定,直到用户将其关闭或会话结束。
  • 会话结束: 画中画窗口回到对话中的内联位置,并随内容滚动移出屏幕。

设计要点

  • 当用户通过系统编辑器交互时,确保画中画能更新状态或作出响应。
  • 会话结束时,自动关闭画中画窗口。
  • 避免在画中画窗口中堆放控件或静态内容,更适合内联或全屏模式的内容应在相应模式中展示。

视觉设计指南

统一的外观和交互方式能让合作伙伴开发的工具自然融入 ChatGPT 平台。这些视觉设计指南有助于保持界面清晰、易用且无障碍,也为合作伙伴在合适的位置展现品牌特色留出了空间。

以下原则说明如何运用色彩、字体、间距和图像,在保持系统界面清晰的同时,突出合作伙伴自身服务的特色。

为什么要保持一致

一致的视觉和交互设计能改善用户在 ChatGPT 中使用应用的整体体验。遵循这些指南,合作伙伴就能以用户熟悉的方式呈现工具,让用户专注于工具提供的功能。

色彩

使用系统定义的调色板,有助于让操作和回复的视觉风格始终与 ChatGPT 平台保持一致。合作伙伴可以通过局部点缀、图标或内联图片体现品牌特色,但不应重新定义系统颜色。

调色板

设计要点

  • 文本、图标和分隔线等划分空间的元素应使用系统颜色。
  • 品牌标志或图标等品牌元素不应覆盖背景色或文字颜色。
  • 避免使用破坏 ChatGPT 简洁风格的自定义渐变或图案。
  • 在应用的各类显示模式中,主要按钮应使用品牌强调色。

色彩使用示例

使用品牌色点缀界面并为徽章着色。不要更改文字颜色或其他核心组件样式。

色彩使用示例

不要给文本区域的背景着色。

字体排版

ChatGPT 使用各平台的原生系统字体(iOS 上为 SF Pro,Android 上为无衬线字体),以确保文本在不同设备上都易于阅读,并支持无障碍访问。

字体排版

设计要点

  • 始终继承系统字体栈,并遵循系统对标题、正文和图注的字号规定。
  • 合作伙伴自定义的粗体、斜体或高亮等样式仅用于内容区域,不应用于构成界面框架的元素。
  • 尽量减少字号变化,优先使用正文和小号正文两种字号。

字体排版示例

即使在全屏模式下,也不要使用自定义字体。尽可能使用系统字体变量。

间距与布局

保持外边距、内边距和对齐方式一致,让用户在对话中能快速浏览合作伙伴提供的内容,也能预期各类信息出现的位置。

间距与布局

设计要点

  • 卡片、集合和检查器面板应使用系统网格间距。
  • 保持内边距一致,避免内容拥挤或文字紧贴边缘。
  • 尽可能采用系统规定的圆角半径,保持形状一致。
  • 按照标题、辅助说明、操作入口的顺序组织内容,形成清晰的视觉层级。

图标与图像

系统图标有助于清楚传达信息,合作伙伴的品牌标志和图片则方便用户识别内容所属的品牌。

图标

设计要点

  • 使用系统图标,或使用符合 ChatGPT 视觉风格的自定义单色线框图标。
  • 不要在回复内容中加入您的品牌标志。ChatGPT 始终会在渲染小组件前添加您的品牌标志和应用名称。
  • 所有图像都必须遵循规定的宽高比,以免变形。

图标与图像

无障碍设计

合作伙伴设计的每种体验都应让尽可能多的用户能够使用。在为 ChatGPT 构建应用时,您应将无障碍设计作为核心考量。

设计要点

  • 文字与背景之间的对比度必须达到 WCAG AA 规定的最低要求。
  • 为所有图片提供替代文本。
  • 支持调整文字大小,并确保调整后布局仍然正常。

内容安全策略(CSP)

配置内容安全策略(CSP),明确组件在发送网络请求、加载资源和嵌入框架时可以访问哪些域名。每份允许列表都应仅包含插件实现相应功能所需的域名,避免因允许的来源范围过宽而引入重大安全风险。具体配置方法请参阅 CSP 配置指南。