Docker 扩展的 UI 样式概述
目录
我们的设计系统是一套不断演进的规范,旨在确保 Docker 产品之间的视觉一致性,并满足 AA 级辅助功能标准。我们已向扩展作者开放了部分内容,记录了基本样式(颜色、排版)和组件。请参阅:Docker 扩展样式指南。
我们要求扩展在一定程度上与更广泛的 Docker Desktop UI 保持一致,并保留将来使其更严格的权利。
要开始构建 UI,请按照以下步骤操作。
第一步:选择您的框架
推荐:React+MUI,使用我们的主题
Docker Desktop 的 UI 是用 React 和 MUI(具体指 Material UI)编写的。这是唯一官方支持的用于构建扩展的框架,也是我们的 init 命令自动为您配置的框架。使用它会给作者带来显著的好处。
- 您可以使用我们的 Material UI 主题 来自动复制 Docker Desktop 的外观和感觉。
- 将来,我们将发布专门针对这种组合的实用程序和组件(例如自定义 MUI 组件或用于与 Docker 交互的 React 钩子)。
阅读我们的 MUI 最佳实践 指南,了解与 Docker Desktop 配合使用 MUI 的未来实用方法。
不推荐:其他框架
您可能更喜欢使用其他框架,也许是因为您或您的团队更熟悉它,或者您有想要重用的现有资产。这是可以的,但非常不推荐。这意味着:
- 您需要手动复制 Docker Desktop 的外观和感觉。这需要大量的努力,如果您没有足够密切地匹配我们的主题,用户会觉得您的扩展不协调,我们可能会在审核过程中要求您进行更改。
- 您将承担更高的维护负担。每当 Docker Desktop 的主题发生变化时(这可能发生在任何版本中),您都需要手动更改您的扩展以匹配它。
- 如果您的扩展是开源的,故意避免常见的约定将使社区更难为其做出贡献。
第二步:遵循以下建议
遵循我们的 MUI 最佳实践(如适用)
请参阅我们的 MUI 最佳实践 文章。
仅使用我们调色板中的颜色
除了一些小例外,例如显示您的徽标,您应该只使用我们调色板中的颜色。这些颜色可以在我们的 样式指南文档 中找到,并且很快也将在我们的 MUI 主题和通过 CSS 变量提供。
在亮/暗模式下使用对应的颜色
我们选择的颜色使得调色板中每个变体的对应颜色应具有相同的基本特征。无论您在亮模式下使用 red-300,您在暗模式下也应使用 red-300。