@ohmi/progress-bar-android v1.0.4-0.1.2
模板版本:v0.2.2
!TIP(https://github.com/react-native-oh-library/progress-bar-android)
安装与使用
请到三方库的 Releases 发布地址查看配套的版本信息:@react-native-oh-tpl/progress-bar-android Releases 。对于未发布到 npm 的旧版本,请参考安装指南安装 tgz 包。
进入到工程目录并输入以下命令:
yarn
yarn add @ohmi/progress-bar-android
npm
npm install @ohmi/progress-bar-android
下面的代码展示了这个库的基本使用场景:
!WARNING 使用时 import 的库名不变。
import { ProgressBar } from "@react-native-community/progress-bar-android";
export default function ProgressBarExample() {
return (
<>
<ProgressBar
styleAttr="Horizontal"
indeterminate={true}
animating={true}
/>
<ProgressBar indeterminate={true} />
</>
);
}
Link
目前 HarmonyOS 暂不支持 AutoLink,所以 Link 步骤需要手动配置。
首先需要使用 DevEco Studio 打开项目里的 HarmonyOS 工程 harmony
1.在工程根目录的 oh-package.json5
添加 overrides 字段
{
...
+ "dependencies": {
+ "@ohos/materialprogressbar": "file:../node_modules/@ohmi/progress-bar-android/harmony/progress_bar_android/materialprogressbar/materialprogressbar.har"
},
+ "overrides": {
+ "@rnoh/react-native-openharmony" : "./react_native_openharmony"
+ "@ohos/materialprogressbar": "file:../node_modules/@ohmi/progress-bar-android/harmony/progress_bar_android/materialprogressbar/materialprogressbar.har"
+ }
}
2.引入原生端代码
目前有两种方法:
- 通过 har 包引入(在 IDE 完善相关功能后该方法会被遗弃,目前首选此方法);
- 直接链接源码。
方法一:通过 har 包引入(推荐)
!TIP har 包位于三方库安装路径的
harmony
文件夹下。
打开 entry/oh-package.json5
,添加以下依赖
"dependencies": {
"@rnoh/react-native-openharmony": "file:../react_native_openharmony",
"@ohmi/progress-bar-android": "file:../../node_modules/@ohmi/progress-bar-android/harmony/progress_bar_android.har"
}
点击右上角的 sync
按钮
或者在终端执行:
cd entry
ohpm install
方法二:直接链接源码
3.配置 CMakeLists 和引入 ProgressBarAndroidPackage
打开 entry/src/main/cpp/CMakeLists.txt
,添加:
project(rnapp)
cmake_minimum_required(VERSION 3.4.1)
set(CMAKE_SKIP_BUILD_RPATH TRUE)
set(RNOH_APP_DIR "${CMAKE_CURRENT_SOURCE_DIR}")
set(NODE_MODULES "${CMAKE_CURRENT_SOURCE_DIR}/../../../../../node_modules")
+ set(OH_MODULES "${CMAKE_CURRENT_SOURCE_DIR}/../../../oh_modules")
set(RNOH_CPP_DIR "${CMAKE_CURRENT_SOURCE_DIR}/../../../../../../react-native-harmony/harmony/cpp")
set(LOG_VERBOSITY_LEVEL 1)
set(CMAKE_ASM_FLAGS "-Wno-error=unused-command-line-argument -Qunused-arguments")
set(CMAKE_CXX_FLAGS "-fstack-protector-strong -Wl,-z,relro,-z,now,-z,noexecstack -s -fPIE -pie")
set(WITH_HITRACE_SYSTRACE 1) # for other CMakeLists.txt files to use
add_compile_definitions(WITH_HITRACE_SYSTRACE)
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}/@ohmi/progress-bar-android/src/main/cpp" ./progress-bar-android)
# RNOH_END: manual_package_linking_1
file(GLOB GENERATED_CPP_FILES "./generated/*.cpp")
add_library(rnoh_app SHARED
${GENERATED_CPP_FILES}
"./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_bar_android)
# RNOH_END: manual_package_linking_2
打开 entry/src/main/cpp/PackageProvider.cpp
,添加:
#include "RNOH/PackageProvider.h"
#include "generated/RNOHGeneratedPackage.h"
#include "SamplePackage.h"
+ #include "ProgressBarAndroidPackage.h"
using namespace rnoh;
std::vector<std::shared_ptr<Package>> PackageProvider::getPackages(Package::Context ctx) {
return {
std::make_shared<RNOHGeneratedPackage>(ctx),
std::make_shared<SamplePackage>(ctx),
+ std::make_shared<ProgressBarAndroidPackage>(ctx)
};
}
4.在 ArkTs 侧引入 ProgressBarAndroid 组件
找到 function buildCustomRNComponent()
,一般位于 entry/src/main/ets/pages/index.ets
或 entry/src/main/ets/rn/LoadBundle.ets
,添加:
...
+ import { ProgressBarAndroid, PROGRESS_BAR_TYPE } from "@ohmi/progress-bar-android"
@Builder
export function buildCustomRNComponent(ctx: ComponentBuilderContext) {
...
+ if (ctx.componentName === PROGRESS_BAR_TYPE){
+ ProgressBarAndroid({
+ ctx: ctx.rnComponentContext,
+ tag: ctx.tag
+ })
+ }
...
}
...
!TIP 本库使用了混合方案,需要添加组件名。
在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_BAR_TYPE
];
5.运行
点击右上角的 sync
按钮
或者在终端执行:
cd entry
ohpm install
然后编译、运行即可。
约束与限制
兼容性
要使用此库,需要使用正确的 React-Native 和 RNOH 版本。另外,还需要使用配套的 DevEco Studio 和 手机 ROM。
请到三方库相应的 Releases 发布地址查看 Release 配套的版本信息:@react-native-oh-tpl/progress-bar-android Releases
属性
!TIP "Platform"列表示该属性在原三方库上支持的平台。
!TIP "HarmonyOS Support"列为 yes 表示 HarmonyOS 平台支持该属性;no 则表示不支持;partially 表示部分支持。使用方法跨平台一致,效果对标 iOS 或 Android 的效果。
Name | Description | Type | Required | Platform | HarmonyOS Support |
---|---|---|---|---|---|
animating | Whether to show the ProgressBar (true, the default) or hide it (false). | bool | No | Android | yes |
color | Color of the progress bar. | color | No | Android | yes |
indeterminate | If the progress bar will show indeterminate progress. Note that this can only be false if styleAttr is Horizontal, and requires a progress value. | indeterminateType | No | Android | yes |
progress | The progress value (between 0 and 1). | number | No | Android | yes |
styleAttr | Style of the ProgressBar. | One of:Horizontal Normal (default) Small Large Inverse SmallInverse LargeInverse | No | Android | yes |
遗留问题
- styleAttr 为 Horizontal 时无法铺满全屏 issues#4。
其他
开源协议
本项目基于 The MIT License (MIT) ,请自由地享受和参与开源。
6 months ago
7 months ago