已开启
docs: complete ViewShot API documentation #41
docs: complete ViewShot API documentation #41
已开启
sunkaiyang创建于 5 天前
sunkaiyang
sunkaiyang
5 天前

docs: complete ViewShot API documentation

文档(README.md / README_en.md)

  • 规范并补齐 API 接口表

    • 规范表格字段:在 API 列表中统一扩充了「类型」、「参数类型」、「返回值」等规范列。
    • 新增实例截图方法:补充了 ViewShotRef.capture() 命令式调用方法的说明(通过 viewShotRef.current.capture() 触发并返回 Promise<string>)。
    • 精准化参数类型:将 captureRef 的目标视图入参类型明确指定为 CaptureTarget
  • 精准化标注组件属性与 options 配置

    • options 配置
      • format:类型中补充了 raw 格式,明确注明鸿蒙不支持 raw 格式(仅 Android 支持),支持度标注为 Partially
      • result:进一步明确鸿蒙端不支持 zip-base64 压缩格式,支持度标注为 Partially
      • 属性排版与对齐:统一规范了 handleGLSurfaceViewOnAndroid(仅 Android)和 useRenderInContext(仅 iOS)的说明,鸿蒙支持度均标为 No
    • 组件属性表(Props)
      • 补齐了容器属性 onLayout(布局监听回调)与 style(视图样式)的说明。
      • 全面细化了各属性的「参数类型」与「默认值」列。
  • 更新示例代码(Demo)

    • 按钮点击的截图调用逻辑由原来的 captureRef(ref) 调整为推荐的实例方法 ref.current?.capture(),日志输出同步更新为 ViewShotRef.capture
likedislike
合并受阻
sunkaiyangsunkaiyang
5 天前 关联了issue:docs: complete ViewShot API documentation
openharmony_ci
openharmony_ci成员
5 天前 评论:

感谢提交 Pull Requests!
Thanks for submitting a pull request.

likedislike
openharmony_ciopenharmony_ci成员
5 天前 添加了label:dco检查成功
sunkaiyang
sunkaiyang
5 天前 评论:

start build

likedislike
openharmony_ci
openharmony_ci成员
5 天前 评论:

首次触发
门禁构建开始,包含静态检查,预计在60分钟内完成,门禁结果会同步发送到注册邮箱。您可以通过如下链接跟踪门禁进展:http://dcp.openharmony.cn/workbench/cicd/detail/6a9a937b64650f998bc2aa4b/runlist

likedislike
openharmony_ciopenharmony_ci成员
5 天前 添加了label:静态检查失败
openharmony_ci
openharmony_ci成员
5 天前 评论:

代码门禁未通过
您可以通过如下链接查看门禁报告:http://dcp.openharmony.cn/workbench/cicd/detail/6a9a937b64650f998bc2aa4b/runlist

静态检查:

# check type result report
1 codeCheck noPass >>>

likedislike
sunkaiyangsunkaiyang
19 小时前 修改了pull request 的描述
sunkaiyang
sunkaiyang
19 小时前 评论:

start build

likedislike
openharmony_ciopenharmony_ci成员
19 小时前 删除了label:静态检查失败
openharmony_ci
openharmony_ci成员
19 小时前 评论:

上次构建已超过12小时,重新全量验证,重置所有关联PR的验证状态
门禁构建开始,包含静态检查,预计在60分钟内完成,门禁结果会同步发送到注册邮箱。您可以通过如下链接跟踪门禁进展:http://dcp.openharmony.cn/workbench/cicd/detail/6aa0c31364650f998b83bacb/runlist

likedislike
openharmony_ciopenharmony_ci成员
18 小时前 添加了label:静态检查成功
openharmony_ciopenharmony_ci成员
18 小时前 通过测试
openharmony_ci
openharmony_ci成员
18 小时前 评论:

代码门禁通过
您可以通过如下链接查看门禁报告:http://dcp.openharmony.cn/workbench/cicd/detail/6aa0c31364650f998b83bacb/runlist

静态检查:

# check type result report
1 codeCheck pass >>>

likedislike
yangweiping
yangweiping17 小时前进行代码检视3
README.md
已过期
@@ -43,7 +43,7 @@
4343 
4444| | 是否支持autolink | RN框架版本 |
4545|---------------------------|-----------------|------------|
4646| ~4.0.0 | 是 | 0.84 |
yangweiping
yangweiping17 小时前评论:

加上 0.82: 0.84.* / 0.82.*

likedislike
System
系统消息系统
14 小时前 评论:

changed this line on 8118934f view diff detail

sunkaiyang
sunkaiyang
14 小时前 评论:

已经增加

yangweiping
yangweiping17 小时前进行代码检视2
README.md
@@ -183,7 +183,7 @@
183183 
184184 本文档内容基于以下环境验证通过:
185185
186186 1. RNOH: 0.84.1; SDK: HarmonyOS 6.0.0 Release SDK; IDE: DevEco Studio 6.0.0.858; ROM: 6.0.0.112;
yangweiping
yangweiping17 小时前评论:

加上0.82的验证结果

likedislike
sunkaiyang
sunkaiyang
14 小时前 评论:

已经增加

sunkaiyangsunkaiyang
14 小时前 测试状态已重置,测试人: openharmony_ci
sunkaiyangsunkaiyang
14 小时前 强制推送  1 个提交:8118934f-docs: complete ViewShot API documentation
openharmony_ciopenharmony_ci成员
14 小时前 删除了label:静态检查成功
openharmony_ci
openharmony_ci成员
14 小时前 评论:

代码有更新,重置PR验证状态

likedislike
openharmony_ci
openharmony_ci成员
14 小时前 评论:

感谢提交 Pull Requests!
Thanks for submitting a pull request.

likedislike
sunkaiyang
sunkaiyang
14 小时前 评论:

start build

likedislike
openharmony_ci
openharmony_ci成员
14 小时前 评论:

本地或库上代码有更新,全量重新构建,重置所有关联PR的验证状态
门禁构建开始,包含静态检查,预计在60分钟内完成,门禁结果会同步发送到注册邮箱。您可以通过如下链接跟踪门禁进展:http://dcp.openharmony.cn/workbench/cicd/detail/6aa1058564650f998b9c993c/runlist

likedislike
openharmony_ciopenharmony_ci成员
14 小时前 添加了label:静态检查失败
openharmony_ci
openharmony_ci成员
14 小时前 评论:

代码门禁未通过
您可以通过如下链接查看门禁报告:http://dcp.openharmony.cn/workbench/cicd/detail/6aa1058564650f998b9c993c/runlist

静态检查:

# check type result report
1 codeCheck noPass >>>

likedislike