API 状态仪表盘指南

TIP

本使用指南由 AI 协助生成。如果您发现任何不准确之处,请通过提交 Pull Request 帮助我们改进。

本指南解释了如何使用 Lynx API 状态仪表盘来探索不同平台的 API 兼容性。

API 状态仪表盘概览


1. 选择平台

在仪表盘顶部,您会找到 平台选择器,它允许您选择一个或多个平台以查看其特定的 API 覆盖率。

原生平台

  • Android - 移动 Android 平台
  • iOS - Apple iOS 平台
  • Harmony - 鸿蒙平台
  • Web - Web Lynx 实现

使用复选框同时选择多个平台。仪表盘将更新以显示组合选择的覆盖率统计信息。

Clay 平台

点击 Clay 切换按钮以显示额外的 Clay 平台选项:

Clay 平台展开

Clay 平台包括:

  • Clay (Android) - 在 Android 上运行的 Clay
  • Clay (iOS) - 在 iOS 上运行的 Clay
  • Clay (macOS) - 在 macOS 上运行的 Clay
  • Clay (Windows) - 在 Windows 上运行的 Clay

2. 搜索、过滤和查看 API

搜索框

使用搜索框按名称或描述快速查找特定 API。搜索不区分大小写并匹配部分文本。

示例:

  • 搜索 image 查找所有图像相关 API
  • 搜索 scroll 查找滚动功能
  • 搜索 animation 查找动画 API

类别过滤器

第一个下拉菜单允许您按类别过滤 API:

  • All - 显示所有类别
  • ELEMENT - 元素相关 API
  • CSS - CSS 属性支持
  • API - JavaScript API 方法

状态过滤器

第二个下拉菜单根据所选平台的支持状态过滤 API:

  • All - 显示所有 API
  • Supported - 仅显示受支持的 API
  • Unsupported - 仅显示不受支持的 API

API 列表

API 列表以双列网格布局显示所有匹配的 API。每个 API 项目显示:

  • 类别徽章 (例如 ELEMENT, CSS, API)
  • API 名称 (例如 commonality, image.loop-count)
  • 颜色编码
    • 🟢 绿色背景 - 所有选定平台均支持该 API
    • 🟡 黄色背景 - 该 API 受到部分支持(在某些选定平台上支持,但并非全部)
    • 🔴 红色背景 - 任何选定平台均不支持该 API

对于部分支持的 API,一个小指标(例如 "2/3")会显示选定平台中有多少支持该功能。

默认情况下,出于性能考虑,仅显示前 100 个结果。点击 "Show All" 显示所有匹配结果。

API 详情抽屉

点击任何 API 项目以打开详细的兼容性抽屉:

API �详情抽屉

抽屉显示一个兼容性表格,包含:

  • - 每个子 API 或属性
  • - 所有平台 (Android, iOS, HarmonyOS, macOS, Windows, Web)
图标含义
✓ with version自该版本起支持
✗ No不支持
?支持状态未知

点击 "View source" 链接以查看 GitHub 仓库中的原始兼容性数据。


3. 查看平台覆盖率和趋势

底部部分显示平台统计数据和历史趋势:

覆盖率卡片和趋势图

覆盖率卡片 (左侧)

  • Percentage - 总体 API 覆盖率 (例如 87%)
  • Fraction - 确切数量 (例如 945 / 1,092)
  • Progress bar - 带有平台特定颜色的可视化表示

趋势图 (右侧)

  • X-axis - Lynx 版本 (例如 2.14 → 3.4)
  • Y-axis - API 覆盖率百分比
  • Line - 随时间变化的覆盖率进展

这有助于您了解 API 支持在不同版本中的改进情况。

类别表

Coverage 部分提供了按 API 类别的细分:

类别表展开视图

描述
CategoryAPI 类别名称 (例如 Elements, CSS)
Coverage受支持 API 的百分比和数量
Missing不受支持的 API 数量 (如果有)

高亮模式:

  • Highlight Good (绿色模式) - 强调高覆盖率类别
  • Highlight Gap (红色模式) - 强调低覆盖率类别

点击任何类别行以展开它并查看单个 API。不受支持的 API以红色高亮显示以便于识别。


4. 最近添加的 API

Recently Added 部分列出了最近添加到 Lynx 的 API,按版本分组。

按版本最近添加的 API

每个版本组显示:

  • 版本号 (例如 v3.5, v3.4, v2.18)
  • API 计数 (针对所选平台)
  • API 列表 (该版本中添加的 API)

这对跟踪每个 Lynx 发布中的新功能很有用。


提示

  1. 从选择平台开始 - 首先选择您的目标平台(一个或多个)以查看相关的覆盖率数据。
  2. 使用色盲模式 - 切换侧边栏底部的 Colorblind Mode 开关,启用高对比度的蓝/橙主题,以获得更好的无障碍体验。
  3. 使用搜索查找特定 API - 如果您知道 API 名称,搜索比滚动更快。
  4. 查看抽屉获取详情 - 兼容性表格显示特定版本的信息。
  5. 监控趋势 - 使用趋势图了解随时间变化的覆盖率改进。
  6. 为桌面切换 Clay - 如果您正在构建跨平台桌面应用程序,请启用 Clay 平台。

需要帮助?

如果您对 API 兼容性有疑问或需要帮助:

除非另有说明,本项目采用知识共享署名 4.0 国际许可协议进行许可,代码示例采用 Apache License 2.0 许可协议进行许可。