模板版本:v0.2.2
react-native-context-menu-view
本项目基于 原库react-native-context-menu-view 开发。
该第三方库的仓库支持直接从 npm 下载,新的包名为:@react-native-ohos/react-native-context-menu-view 版本所属关系如下:
| 三方库名称 | 三方库版本 | 发布信息 | 支持RN版本 | Autolink | 编译API版本 | 社区基线版本 | npm地址 |
|---|---|---|---|---|---|---|---|
| @react-native-ohos/react-native-context-menu-view | ~1.20.0 | Github Releases | 0.82.* | 是 | API12+ | 1.21.0 | Npm Address |
| @react-native-ohos/react-native-context-menu-view | ~1.19.1 | Github Releases | 0.77.* | 否 | API12+ | 1.19.0 | Npm Address |
| @react-native-ohos/react-native-context-menu-view | ~1.16.1 | Github Releases | 0.72.* | 是 | API12+ | 1.16.0 | Npm Address |
| @react-native-oh-tpl/react-native-context-menu-view | <= 1.16.0-0.0.6@deprecated | Github Releases(deprecated) | 0.72.* | 否 | API12+ | 1.16.0 | Npm Address |
1. 安装与使用
进入到工程目录并输入以下命令:
npm
npm install @react-native-ohos/react-native-context-menu-view
yarn
yarn add @react-native-ohos/react-native-context-menu-view
下面的代码展示了这个库的基本使用场景:
使用时 import 的库名不变。
import ContextMenu from "react-native-context-menu-view";
const Example = () => {
return (
<ContextMenu
actions={[{ title: "Title 1" }, { title: "Title 2" }]}
onPress={(e) => {
console.warn(
`Pressed ${e.nativeEvent.name} at index ${e.nativeEvent.index}`
);
}}
>
<View style={styles.yourOwnStyles} />
</ContextMenu>
);
};
2. Link
| 是否支持autolink | RN框架版本 | |
|---|---|---|
| ~1.20.0 | Yes | 0.82 |
| ~1.19.1 | No | 0.77 |
| ~1.16.1 | Yes | 0.72 |
| <= 1.16.0-0.0.6@deprecated | No | 0.72 |
使用AutoLink的工程需要根据该文档配置,Autolink框架指导文档:https://gitcode.com/openharmony-sig/ohos_react_native/blob/master/docs/zh-cn/Autolinking.md
如您使用的版本支持 Autolink,并且工程已接入 Autolink,可跳过ManualLink配置。
ManualLink: 此步骤为手动配置原生依赖项的指导
首先需要使用 DevEco Studio 打开项目里的 HarmonyOS 工程 harmony。
2.1 在工程根目录的 oh-package.json5 添加 overrides 字段
{
...
"overrides": {
"@rnoh/react-native-openharmony" : "./react_native_openharmony"
}
}
2.2 引入原生端代码
目前有两种方法:
- 通过 har 包引入(在 IDE 完善相关功能后该方法会被遗弃,目前首选此方法);
- 直接链接源码。
方法一:通过 har 包引入(推荐)
har 包位于三方库安装路径的 `harmony` 文件夹下。
打开 entry/oh-package.json5,添加以下依赖
"dependencies": {
"@rnoh/react-native-openharmony": "file:../react_native_openharmony",
"@react-native-ohos/react-native-context-menu-view": "file:../../node_modules/@react-native-ohos/react-native-context-menu-view/harmony/context_menu.har"
}
点击右上角的 sync 按钮
或者在终端执行:
cd entry
ohpm install
方法二:直接链接源码
如需使用直接链接源码,请参考[直接链接源码说明](./link-source-code.md)
2.3 配置 CMakeLists 和引入 ContextMenuPackage
若使用的是 <= 1.16.0-0.0.6 版本,请跳过本章
打开 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}/@react-native-ohos/react-native-context-menu-view/src/main/cpp" ./context_menu)
# 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_context_menu)
# RNOH_END: manual_package_linking_2
打开 entry/src/main/cpp/PackageProvider.cpp,添加:
#include "RNOH/PackageProvider.h"
#include "generated/RNOHGeneratedPackage.h"
#include "SamplePackage.h"
+ #include "ContextMenuPackage.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<ContextMenuPackage>(ctx),
};
}
2.4 在 ArkTs 侧引入 ContextMenuPackage
打开 entry/src/main/ets/RNPackagesFactory.ets,添加:
...
+ import {ContextMenuPackage} from '@react-native-ohos/react-native-context-menu-view/ts';
export function createRNPackages(ctx: RNPackageContext): RNPackage[] {
return [
new SamplePackage(ctx),
+ new ContextMenuPackage(ctx)
];
}
2.5 运行
点击右上角的 sync 按钮
或者在终端执行:
cd entry
ohpm install
然后编译、运行即可。
3. 约束与限制
3.1 兼容性
要使用此库,需要使用正确的 React-Native 和 RNOH 版本。另外,还需要使用配套的 DevEco Studio 和 手机 ROM。
在以下版本验证通过:
- RNOH: 0.72.96; SDK: HarmonyOS 6.0.0 Release SDK; IDE: DevEco Studio 6.0.0.858; ROM: 6.0.0.112;
- RNOH: 0.72.33; SDK: HarmonyOS NEXT B1; IDE: DevEco Studio: 5.0.3.900; ROM: Next.0.0.71;
- RNOH: 0.77.18; SDK: HarmonyOS 6.0.0 Release SDK; IDE: DevEco Studio 6.0.0.858; ROM: 6.0.0.112;
- RNOH: 0.82.7; SDK: HarmonyOS 6.0.1 Release SDK; IDE: DevEco Studio 6.0.1 Release; ROM:6.0.0.328 SP26;
4. 属性
"Platform"列表示该属性在原三方库上支持的平台。
"HarmonyOS Support"列为 yes 表示 HarmonyOS 平台支持该属性;no 则表示不支持;partially 表示部分支持。使用方法跨平台一致,效果对标 iOS 或 Android 的效果。
| Name | Description | Type | Required | Platform | HarmonyOS Support |
|---|---|---|---|---|---|
| title | 弹出菜单上方的标题 | string | no | Android/iOS | yes |
| actions | 菜单属性 | array | no | Android(partially)/iOS | partially |
| previewBackgroundColor | 预览区域的背景颜色 | string | no | NA | no |
| dropdownMenuMode | 当设置为 true 时,上下文菜单通过单击(而非长按)触发 | boolean | no | Android/iOS | yes |
| disabled | 禁用菜单交互 | boolean | no | Android/iOS | yes |
| onPress | 当弹出菜单打开且用户选择某个选项时触发 | callback | no | Android/iOS | yes |
| onPreviewPress | 当点击上下文菜单预览时触发 | callback | no | iOS | no |
| onCancel | 当弹出菜单打开且用户取消时触发 | callback | no | Android/iOS | yes |
| fontName1.19.1+ | 用于菜单项的自定义字体名称。字体必须存在于应用的字体资源中 | string | no | Android | yes |
| borderRadius1.19.1+ | 设置预览区域所有角的边框圆角半径。可被单独的角设置覆盖 | number | no | iOS | no |
| borderTopLeftRadius1.19.1+ | 专门设置预览区域左上角的边框圆角半径 | number | no | iOS | no |
| borderTopRightRadius1.19.1+ | 专门设置预览区域右上角的边框圆角半径 | number | no | iOS | no |
| borderBottomRightRadius1.19.1+ | 专门设置预览区域右下角的边框圆角半径 | number | no | iOS | no |
| borderBottomLeftRadius1.19.1+ | 专门设置预览区域左下角的边框圆角半径 | number | no | iOS | no |
| disableShadow1.19.1+ | 当设置为 true 时,移除预览区域的阴影。默认值为 false | boolean | no | iOS | no |
actions
"Platform"列表示该属性在原三方库上支持的平台。
"HarmonyOS Support"列为 yes 表示 HarmonyOS 平台支持该属性;no 则表示不支持;partially 表示部分支持。使用方法跨平台一致,效果对标 iOS 或 Android 的效果。
| Name | Description | Type | Required | Platform | HarmonyOS Support |
|---|---|---|---|---|---|
| title | 操作的标题 | string | no | Android/iOS | yes |
| titleColor1.19.1+ | 标题的颜色 | string | no | All | yes |
| subtitle | 操作的副标题 | string | no | iOS 15+ | yes |
| systemIcon | 引用 SF Symbols中的图标名称 | string | no | iOS | yes |
| icon | 自定义图标 | string | no | Android/iOS | yes |
| iconColor | 将更改提供给 icon 属性的图标颜色, systemIcon 无效(默认值:black) |
string | no | Android/iOS | yes |
| destructive | 操作项将以红色显示 | boolean | no | iOS | yes |
| selected | 操作项旁边会显示一个对勾标记 | boolean | no | iOS | yes |
| disabled | 标记操作项是否被禁用 | boolean | no | Android/iOS | yes |
| inlineChildren | 标记其子项(如有)是否应以内联方式渲染,而不是显示在它们自己的子菜单中 | boolean | no | iOS | partially |
| actions | 提供一级深度的嵌套菜单 | array | no | Android/iOS | partially |
5. 遗留问题
6. 其他
1.previewBackgroundColor属性,经过验证在iOS和Android均无效果。
2.actions属性是个结构体函数,所以包含其他上文列举属性,例如previewBackgroundColor等。所以,属于部分支持
3.该库的具体逻辑实现,在不同平台,均为调用平台对应的底层Menu接口进行相关操作。所以,不同平台上,动效展示等会有所不同。
4.onPress方法的callback参考:{ nativeEvent: { index, indexPath, name } }.
5.当systemIcon和icon同时配置的时候,在Harmony Next平台上,systemIcon的优先级高于icon
7. 开源协议
本项目基于 The MIT License (MIT) ,请自由地享受和参与开源。