基于 @react-native-community/progress-view 的 OpenHarmony 适配版,进度条组件
| 文件 | 最后提交记录 | 最后更新时间 |
|---|---|---|
| 3 年前 | ||
| 1 年前 | ||
| 5 年前 | ||
| 8 天前 | ||
| 8 天前 | ||
| 2 个月前 | ||
| 1 年前 | ||
| 8 天前 | ||
| 8 天前 | ||
| 1 年前 | ||
| 7 年前 | ||
| 8 天前 | ||
| 1 年前 | ||
| 8 天前 | ||
| 8 天前 | ||
| 1 个月前 | ||
| 8 天前 | ||
| 5 年前 |
文档模板:v0.4.2
@react-native-community/progress-view
本项目基于 @react-native-community/progress-view 开发。
该第三方库的仓库已迁移至 Gitcode,并支持直接从 npm 下载,新的包名为:@react-native-ohos/progress-view。各版本对应关系如下:
| 三方库名称 | 三方库版本(npm 地址) | 发布信息 | 支持 RN 版本 | Autolink | 编译 API 版本 | 社区基线版本 | 源码地址 |
|---|---|---|---|---|---|---|---|
| @react-native-ohos/progress-view | ~1.6.0(开发中) | Gitcode 发布 | 0.82* / 0.84* | 是 | API12+ | 1.5.0 | master |
| @react-native-ohos/progress-view | ~1.5.0 | Gitcode 发布 | 0.77* | 否 | API12+ | 1.4.2 | br_rnoh0.77 |
| @react-native-ohos/progress-view | ~1.4.3 | Gitcode 发布 | 0.72* | 是 | API12+ | 1.4.2 | br_rnoh0.72 |
| @react-native-oh-tpl/progress-view | <= 1.4.2-0.0.8(已弃用) | Github 发布(已弃用) | 0.72* | 否 | API12+ | 1.4.2 | sig |
简介
ProgressView 是 React Native 中用于展示进度条的组件。
下载安装
进入工程目录并执行以下命令:
npm
npm install @react-native-ohos/progress-view
yarn
yarn add @react-native-ohos/progress-view
链接
| 是否支持 autolink | RN 框架版本 | |
|---|---|---|
| ~1.6.0 | 是 | 0.82 / 0.84 |
使用 AutoLink 的工程需按照该文档进行配置,Autolink 框架指导文档:https://gitcode.com/CPF-RN/ohos_react_native/blob/master/docs/zh-cn/Autolinking.md
如果您使用的版本支持 Autolink,并且工程已接入 Autolink,则可跳过 ManualLink 配置。
ManualLink:本步骤用于指导手动配置原生依赖项
首先需要使用 DevEco Studio 打开项目中的 HarmonyOS 工程 harmony。
1. 通过 overrides 覆盖 RN SDK
为了让工程依赖同一版本的 RN SDK,需要在工程根目录的 oh-package.json5 中添加 overrides 字段,并指向工程需要使用的 RN SDK 版本。该字段的取值可以是一个具体的版本号,也可以是一个模糊版本号,还可以是本地已存在的 HAR 包或源码目录。
关于该字段的作用,请参见官方说明
{
"overrides": {
"@rnoh/react-native-openharmony": "^0.84.1" // ohpm 在线版本
// "@rnoh/react-native-openharmony" : "./react_native_openharmony.har" // 指向本地 har 包的路径
// "@rnoh/react-native-openharmony" : "./react_native_openharmony" // 指向源码路径
}
}
2. 引入原生端代码
目前有两种方式:
- 通过
har包引入; - 直接链接源码。
方式一:通过 har 包引入(推荐)
`har` 包位于第三方库安装路径下的 `harmony` 文件夹中。
打开 entry/oh-package.json5,添加以下依赖
"dependencies": {
"@rnoh/react-native-openharmony": "file:../react_native_openharmony",
"@react-native-ohos/progress-view": "file:../../node_modules/@react-native-ohos/progress-view/harmony/progress_view.har"
}
点击右上角的 sync 按钮
或在终端执行:
cd entry
ohpm install
方法二:直接链接源码
如需使用直接链接源码,请参考[直接链接源码说明](https://gitcode.com/CPF-RN/usage-docs/blob/master/zh-cn/link-source-code.md)
3. 配置 CMakeLists 并引入 ProgressViewPackage
打开 entry/src/main/cpp/CMakeLists.txt,添加:
project(rnapp)
cmake_minimum_required(VERSION 3.4.1)
set(RNOH_APP_DIR "${CMAKE_CURRENT_SOURCE_DIR}")
+ set(OH_MODULES "${CMAKE_CURRENT_SOURCE_DIR}/../../../oh_modules")
set(RNOH_CPP_DIR "${CMAKE_CURRENT_SOURCE_DIR}/../../../../../../react-native-harmony/harmony/cpp")
add_subdirectory("${RNOH_CPP_DIR}" ./rn)
# RNOH_BEGIN: manual_package_linking_1
add_subdirectory("../../../../sample_package/src/main/cpp" ./sample-package)
+ add_subdirectory("${OH_MODULES}/@react-native-ohos/progress-view/src/main/cpp" ./progress-view)
# RNOH_BEGIN: manual_package_linking_1
add_library(rnoh_app SHARED
"./PackageProvider.cpp"
"${RNOH_CPP_DIR}/RNOHAppNapiBridge.cpp"
)
target_link_libraries(rnoh_app PUBLIC rnoh)
# RNOH_BEGIN: manual_package_linking_2
target_link_libraries(rnoh_app PUBLIC rnoh_sample_package)
+ target_link_libraries(rnoh_app PUBLIC rnoh_progress_view)
# RNOH_BEGIN: manual_package_linking_2
打开 entry/src/main/cpp/PackageProvider.cpp,添加:
#include "RNOH/PackageProvider.h"
#include "generated/RNOHGeneratedPackage.h"
#include "SamplePackage.h"
+ #include "ProgressViewPackage.h"
using namespace rnoh;
std::vector<std::shared_ptr<Package>> PackageProvider::getPackages(Package::Context ctx) {
return {
std::make_shared<SamplePackage>(ctx),
+ std::make_shared<ProgressViewPackage>(ctx)
};
}
找到 function buildCustomComponent(),它通常位于 entry/src/main/ets/pages/index.ets 或 entry/src/main/ets/rn/LoadBundle.ets,请添加:
...
import { SampleView, SAMPLE_VIEW_TYPE, PropsDisplayer } from "rnoh-sample-package"
+ import { RNCProgressView, PROGRESS_VIEW_TYPE } from "@react-native-ohos/progress-view"
@Builder
export function buildCustomRNComponent(ctx: ComponentBuilderContext) {
...
+ if (ctx.componentName === PROGRESS_VIEW_TYPE) {
+ RNCProgressView({
+ ctx: ctx.rnComponentContext,
+ tag: ctx.tag
+ })
+ }
...
}
...
本库采用混合方案,需要添加组件名。
在 entry/src/main/ets/pages/index.ets 或 entry/src/main/ets/rn/LoadBundle.ets 中,找到常量 arkTsComponentNames,并在其数组中添加组件名。
const arkTsComponentNames: Array<string> = [
SampleView.NAME,
GeneratedSampleView.NAME,
PropsDisplayer.NAME,
+ PROGRESS_VIEW_TYPE
];
4. 在 ArkTs 侧引入 ProgressViewPackage
打开 entry/src/main/ets/RNPackagesFactory.ts,添加:
...
+ import { ProgressViewPackage } from "@react-native-ohos/progress-view/ts";
export function createRNPackages(ctx: RNPackageContext): RNPackage[] {
return [
new SamplePackage(ctx),
+ new ProgressViewPackage(ctx),
];
}
运行
点击右上角的 sync 按钮
或者在终端执行:
cd entry
ohpm install
然后编译并运行即可。
约束与限制
兼容性
本文档内容基于以下版本验证通过:
- RNOH: 0.82.22; SDK: HarmonyOS 6.0.0 Release SDK; IDE: DevEco Studio 6.0.0.878; ROM: 6.0.0.130;
- RNOH: 0.84.1; SDK: HarmonyOS 6.0.0 Release SDK; IDE: DevEco Studio 6.0.0.878; ROM: 6.0.0.130;
使用示例
下面的代码展示了该库的基本使用场景:
使用时 import 的库名保持不变。
import { View, StyleSheet } from 'react-native';
import { ProgressView } from "@react-native-community/progress-view";
export default function ProgressViewDemo() {
return (
<View style={styles.container}>
<ProgressView
style={styles.linear}
progress={0.7}
progressTintColor="orange"
trackTintColor="blue"
accessibilityLabel="当前进度 70%"
/>
<ProgressView
style={styles.ring}
isIndeterminate={true}
progressTintColor="#007AFF"
trackTintColor="#DCDCDC"
accessibilityLabel="加载中"
/>
</View>
);
}
const styles = StyleSheet.create({
container: {
padding: 16,
},
linear: {
height: 20,
},
ring: {
height: 40,
marginTop: 24,
},
});
接口说明
“平台”列表示该属性在原第三方库中支持的平台。
“HarmonyOS 平台支持”列取值为“是”表示 HarmonyOS 平台支持该属性;“否”表示不支持;“部分支持”表示仅部分支持。使用方法跨平台一致,效果对标 iOS 或 Android 的效果。
组件
| 名称 | 参数类型 | 必填 | 平台 | OpenHarmony 平台支持 | 描述 |
|---|---|---|---|---|---|
| ProgressView | ProgressViewProps | 是 | 全部 | 是 | ProgressView 组件 |
属性
ProgressViewProps
| 名称 | 参数类型 | 默认值 | 必填 | 平台 | HarmonyOS 平台支持 | 描述 |
|---|---|---|---|---|---|---|
| progress | number | 0 | 否 | 全部 | 是 | 进度值(介于 0 和 1 之间)。 |
| progressTintColor | ColorValue | '#007AFF' | 否 | 全部 | 是 | 进度条本身的颜色。 |
| trackTintColor | ColorValue | '#DCDCDC' | 否 | 全部 | 是 | 进度条轨道的颜色。 |
| progressImage | ImageSourcePropType | - | 否 | 全部 | 否 | 用作进度条显示的可拉伸图像。 |
| trackImage | ImageSourcePropType | - | 否 | 全部 | 否 | 显示在进度条后方的可拉伸图像。仅网络图像在 Windows 上有效。 |
| progressViewStyle | enum('default', 'bar') | 'default' | 否 | 全部 | 否 | 进度条样式。仅网络图像在 Windows 上有效。 |
| isIndeterminate | boolean | - | 否 | Windows | 是 | 将进度条转换为不确定进度条。(当 isIndeterminate 为 true 时,HarmonyOS 平台显示圆形样式的进度条。) |
| accessibilityLabel | string | - | 否 | iOS、macOS、Windows | 是 | 设置无障碍屏幕阅读器标签。 |
遗留问题
- 原库部分接口在 HarmonyOS 中缺少对应的属性和接口,未处理相关逻辑;相关问题:issue#1
其他
无
目录结构
/rntpc_progress-view # 项目根目录
├── harmony # 鸿蒙适配代码
│ └─ progress_view # 鸿蒙适配核心代码
│ └─ index.ets # 鸿蒙适配代码入口
│ └─ ts.ets # ArkTS 侧导出入口
│ └─ src/main/ets
│ └─ ProgressView.ets # ProgressView 组件
│ └─ ProgressViewPackage.ets # Package 注册
│ └─ src/main/cpp
│ └─ ProgressViewPackage.h # C++ Package
├── js # RN 代码
│ └─ index.js # 入口文件
│ └─ index.d.ts # 类型定义
│ └─ ProgressView.harmony.js # HarmonyOS 端组件实现
│ └─ ProgressView.{ios,android,macos,windows}.js # 各平台实现
│ └─ RNCProgressViewNativeComponent.js # NativeComponent 定义
├── README.md # 中文安装使用方法
├── README_en.md # 英文安装使用方法
贡献代码
使用过程中发现任何问题都可以提交 Issue,当然,也非常欢迎提交 PR。
开源协议
本项目采用 The MIT License (MIT) ,欢迎自由使用并参与开源。