Skip to main content
Browse the docs

The developer docs are currently available in Chinese only. The SDK, the CLI and every code sample work the same in any language.

Chapter 14

设计规范

面板与文案的质量标准

插件面板是 UniFlow 的一部分,用户不该感觉「进了另一个应用」。官方插件(闪卡、考试规划、日历同步)是标准答案。

视觉

  • 用语义色,不写死颜色:bg-surface-raised(卡片)、bg-surface-base(底)、text-content-primary / secondary / tertiary、 bg-brand(主操作)、bg-danger / warn / ok 系列(状态)。深浅色由宿主切换,不要自己判断。
  • 卡片:rounded-xl bg-surface-raised ring-1 ring-line-subtle p-4;分组标题:11px、大写、text-content-secondary、字距加宽。
  • 字号:正文 12–13px,次要 11–12px,页面标题 20px,小节标题 15px;数字用 tabular-nums。
  • 按钮:主操作一个(rounded-full bg-brand text-white px-3.5 py-1.5 text-[12px]),次要操作用文字按钮;图标用 lucide,14–16px。
  • 动效克制:进入用 animate-fade-in / animate-scale-in,不做无意义的循环动画。

状态

每个视图都要有:

  • 空状态:说明这是什么、怎么开始,给 1–3 个入口(手动创建、从文件导入、「让 UniMind 帮我…」带示例提示词);
  • 加载中:骨架或居中的小转圈,不要白屏;
  • 错误:一句人话 + 重试;
  • 部分失败:例如「3 个订阅里 1 个刷新失败」—— 标在出问题的那一项上,而不是整页报错。

交互

  • 不可逆操作(删除、清空):行内二次确认(按钮原地变成「确认删除 / 取消」),不用弹窗。
  • 高频操作给快捷键,并在界面上提示(? 显示快捷键表)。
  • 面板的写入不进撤销栈:删除类操作做软删除或提供「最近删除」。
  • 长操作显示进度;可以取消的给取消。

与 UniMind 配合

插件没有自己的 LLM 能力:需要「生成内容」的地方(出题、做计划、总结)用 askUniMind(提示词) 交给 UniMind, UniMind 再调用你的写命令把结果落地 —— 用量计量、确认卡片都走应用的统一通道。提示词写具体(「根据《第 4 章》课件生成 20 张闪卡,存进卡组"生物期中"」)。 askUniMind 为 undefined 时(宿主没有提供这个动作;应用里的插件面板总会提供)隐藏这些入口,需要的话留一句说明。

文案

  • 说人话,说结果:「已导入 32 个日程,跳过 3 个重复」而不是「操作成功」。
  • 错误说原因和下一步:「这个地址返回的不是日历文件(可能需要先登录),请换成公开的 iCal 地址」。
  • 中英文都要自然,不要机翻腔。