diff --git a/zh-cn/react-native-clippath.md b/zh-cn/react-native-clippathview.md
similarity index 52%
rename from zh-cn/react-native-clippath.md
rename to zh-cn/react-native-clippathview.md
index e963e76e2df18088298d13dae736f7a7ccdbfcc3..fe79bbead19228ac6f915b9ce2cc39b50b799f45 100644
--- a/zh-cn/react-native-clippath.md
+++ b/zh-cn/react-native-clippathview.md
@@ -1,20 +1,25 @@
-> 模板版本:v0.2.0
+> 模板版本:v0.2.2
-
react-native-clippath
+ react-native-clippathview
-
+
+
+
+
+
+
> [!TIP] [Github 地址](https://github.com/react-native-oh-library/react-native-clippath)
## 安装与使用
-请到三方库的 Releases 发布地址查看配套的版本信息:[@react-native-oh-library/react-native-clippath Releases](https://github.com/react-native-oh-library/react-native-clippath/releases),并下载适用版本的 tgz 包。
+请到三方库的 Releases 发布地址查看配套的版本信息:[@react-native-oh-tpl/react-native-clippathview Releases](https://github.com/react-native-oh-library/react-native-clippath/releases),并下载适用版本的 tgz 包。
进入到工程目录并输入以下命令:
@@ -25,13 +30,13 @@
#### **npm**
```bash
-npm install @react-native-oh-tpl/clip-path@file:#
+npm install @react-native-oh-tpl/react-native-clippathview@file:#
```
#### **yarn**
```bash
-yarn add @react-native-oh-tpl/clip-path@file:#
+yarn add @react-native-oh-tpl/react-native-clippathview@file:#
```
@@ -59,16 +64,17 @@ export default function index() {
}
```
-## 兼容性
+## 约束与限制
+
+### 兼容性
要使用此库,需要使用正确的 React-Native 和 RNOH 版本。另外,还需要使用配套的 DevEco Studio 和 手机 ROM。
-请到三方库相应的 Releases 发布地址查看 Release 配套的版本信息:[ Releases](https://github.com/react-native-oh-library/react-native-clippath/releases)
+请到三方库相应的 Releases 发布地址查看 Release 配套的版本信息:[@react-native-oh-tpl/react-native-clippathview Releases](https://github.com/react-native-oh-library/react-native-clippath/releases)
-本文档内容基于以下版本验证通过:
+## 使用 Codegen
-1. RNOH: 0.72.26; SDK: HarmonyOS-NEXT-DP2; IDE: DevEco Studio 5.0.3.29; ROM: 205.0.0.18;
-2. RNOH: 0.72.26; SDK: armonyOS NEXT Developer preview2、5.0.0.22(API Version 12 Canary3); IDE: DevEco Studio: 5.0.3.300;ROM: 3.0.0.22;
+本库已经适配了 `Codegen` ,在使用前需要主动执行生成三方库桥接代码,详细请参考[ Codegen 使用文档](/zh-cn/codegen.md)。
## Link
@@ -92,7 +98,7 @@ export default function index() {
```json
"dependencies": {
"rnoh": "file:../rnoh",
- "rnoh-clip-path": "file:../../node_modules/@react-native-oh-tpl/clip-path/harmony/clip_path.har",
+ "@react-native-oh-library/react-native-clippathview": "file:../../node_modules/@react-native-oh-tpl/react-native-clippathview/harmony/clip_path.har",
}
```
@@ -114,8 +120,8 @@ ohpm install
找到 **function buildCustomComponent()**,一般位于 `entry/src/main/ets/pages/index.ets` 或 `entry/src/main/ets/rn/LoadBundle.ets`,添加:
```diff
- ...
-+ import { ClipPath } from 'rnoh-clip-path';
+...
++ import { ClipPath } from 'rnoh-clip-path-view';
@Builder
function buildCustomComponent(ctx: ComponentBuilderContext) {
@@ -144,7 +150,7 @@ function buildCustomComponent(ctx: ComponentBuilderContext) {
```diff
import type {RNPackageContext, RNPackage} from 'rnoh/ts';
import {SamplePackage} from 'rnoh-sample-package/ts';
-+ import { ClipPathPackage } from 'rnoh-clip-path/ts'
++ import { ClipPathPackage } from 'rnoh-clip-path-view/ts'
export function createRNPackages(ctx: RNPackageContext): RNPackage[] {
return [
@@ -173,45 +179,45 @@ ohpm install
> [!tip] "HarmonyOS Support"列为 yes 表示 HarmonyOS 平台支持该属性;no 则表示不支持;partially 表示部分支持。使用方法跨平台一致,效果对标 iOS 或 Android 的效果。
-| Name | Description | Type | Required | Platform | HarmonyOS Support |
-| -------------------- | -------------------------------------------------------------------------------------------------------------- | ----------------- | -------- | ----------- | ----------------- |
-| svgKey | 唯一 key | string | No | IOS/Android | Yes |
-| d | 形状由一系列命令定义(svg path data) | string | No | IOS/Android | Yes |
-| viewBox | 定义用户空间中的位置和维度 | Array(4) | No | IOS/Android | Yes |
-| align | preserveAspectRatio 属性的 align | string | No | IOS/Android | No |
-| aspect | preserveAspectRatio 属性的 meetOrSlice | meet/slice/none | No | IOS/Android | No |
-| fillRule | 路径内部填充规则 | nonzero/evenodd | No | IOS/Android | No |
-| strokeWidth | 路径描边宽度 | number | No | IOS/Android | Yes |
-| strokeCap | 开放路径两端的形状 | butt/round/square | No | IOS/Android | Yes |
-| strokeJoin | 路径转角处使用的形状 | bevel/miter/round | No | IOS/Android | Yes |
-| strokeMiter | strokeJoin 值是 miter,设置夹角延伸 | number | No | IOS/Android | Yes |
-| strokeStart | IOS CAShapeLayer 描线开始的地方占总路径的百分比。默认值是 0。 | number | No | IOS/Android | No |
-| strokeEnd | IOS CAShapeLayer 表示绘制结束的地方站总路径的百分比。默认值是 1,如果小于等于 strokeStart 则绘制不出任何内容。 | number | No | IOS/Android | No |
-| translateZ | 设置定位层级,相当于 index | number | No | IOS/Android | Yes |
-| transX | 在二维平面上水平方向移动元素 | number | No | IOS/Android | Yes |
-| transY | 在二维平面上垂直方向移动元素 | number | No | IOS/Android | Yes |
-| transPercentageValue | transX、transY 使用百分比 | boolean | No | IOS/Android | Yes |
-| rot | 元素围绕一个定点旋转 | number | No | IOS/Android | Yes |
-| rotOx | 旋转中心点水平位置 | number | No | IOS/Android | Yes |
-| rotOy | 旋转中心点垂直位置 | number | No | IOS/Android | Yes |
-| rotPercentageValue | rotOx、rotOy 使用百分比 | boolean | No | IOS/Android | Yes |
-| sc | 放大或缩小元素 | number | No | IOS/Android | Yes |
-| scX | 水平缩放 | number | No | IOS/Android | Yes |
-| scY | 垂直缩放 | number | No | IOS/Android | Yes |
-| scO | 缩放中心点位置 | number | No | IOS/Android | Yes |
-| scOx | 缩放中心点水平位置 | number | No | IOS/Android | Yes |
-| scOy | 缩放中心点垂直位置 | number | No | IOS/Android | Yes |
-| scPercentageValue | scO、scOx、scOy 使用百分比 | boolean | No | IOS/Android | Yes |
+| Name | Description | Type | Required | Platform | HarmonyOS Support |
+| -------------------- | ------------------------------------------------------------ | ----------------- | -------- | ----------- | ----------------- |
+| svgKey | 唯一 key | string | No | iOS/Android | Yes |
+| d | 形状由一系列命令定义(svg path data) | string | No | iOS/Android | Yes |
+| viewBox | 定义用户空间中的位置和维度 | Array(4) | No | iOS/Android | Yes |
+| align | preserveAspectRatio 属性的 align | string | No | iOS/Android | No |
+| aspect | preserveAspectRatio 属性的 meetOrSlice | meet/slice/none | No | iOS/Android | No |
+| fillRule | 路径内部填充规则 | nonzero/evenodd | No | iOS/Android | No |
+| strokeWidth | 路径描边宽度 | number | No | iOS/Android | Yes |
+| strokeCap | 开放路径两端的形状 | butt/round/square | No | iOS/Android | Yes |
+| strokeJoin | 路径转角处使用的形状 | bevel/miter/round | No | iOS/Android | Yes |
+| strokeMiter | strokeJoin 值是 miter,设置夹角延伸 | number | No | iOS/Android | Yes |
+| strokeStart | IOS CAShapeLayer 描线开始的地方占总路径的百分比。默认值是 0。 | number | No | iOS/Android | No |
+| strokeEnd | IOS CAShapeLayer 表示绘制结束的地方站总路径的百分比。默认值是 1,如果小于等于 strokeStart 则绘制不出任何内容。 | number | No | iOS/Android | No |
+| translateZ | 设置定位层级,相当于 index | number | No | iOS/Android | Yes |
+| transX | 在二维平面上水平方向移动元素 | number | No | iOS/Android | Yes |
+| transY | 在二维平面上垂直方向移动元素 | number | No | iOS/Android | Yes |
+| transPercentageValue | transX、transY 使用百分比 | boolean | No | iOS/Android | Yes |
+| rot | 元素围绕一个定点旋转 | number | No | iOS/Android | Yes |
+| rotOx | 旋转中心点水平位置 | number | No | iOS/Android | Yes |
+| rotOy | 旋转中心点垂直位置 | number | No | iOS/Android | Yes |
+| rotPercentageValue | rotOx、rotOy 使用百分比 | boolean | No | iOS/Android | Yes |
+| sc | 放大或缩小元素 | number | No | iOS/Android | Yes |
+| scX | 水平缩放 | number | No | iOS/Android | Yes |
+| scY | 垂直缩放 | number | No | iOS/Android | Yes |
+| scO | 缩放中心点位置 | number | No | iOS/Android | Yes |
+| scOx | 缩放中心点水平位置 | number | No | iOS/Android | Yes |
+| scOy | 缩放中心点垂直位置 | number | No | iOS/Android | Yes |
+| scPercentageValue | scO、scOx、scOy 使用百分比 | boolean | No | iOS/Android | Yes |
## 遗留问题
-部分属性目前版本暂不支持,具体参考属性表格 `HarmonyOS ` 列。
+- [ ] 部分属性目前版本暂不支持,具体参考属性表格 `HarmonyOS ` 列: [issue#15](https://github.com/react-native-oh-library/react-native-clippath/issues/15)
## 其他
## 开源协议
-本项目基于 [MIT License](https://github.com/react-native-oh-library/react-native-clippath/blob/sig/LICENSE) ,请自由地享受和参与开源。
+本项目基于 [The MIT License (MIT)](https://github.com/Only-IceSoul/react-native-clippath/blob/main/LICENSE) ,请自由地享受和参与开源。
---