rntpc_react-native-linear-gradient:基于 react-native-linear-gradient 的 OpenHarmony 适配版,线性渐变色组件

基于 react-native-linear-gradient 的 OpenHarmony 适配版,线性渐变色组件

分支5Tags7
文件最后提交记录最后更新时间
16 天前
25 天前
25 天前
3 年前
6 年前
1 年前
1 个月前
1 个月前
1 年前
9 年前
1 个月前
1 年前
25 天前
24 天前
1 个月前
7 年前
1 年前
25 天前
26 天前

文档模板:v0.4.2

react-native-linear-gradient

本项目基于 react-native-linear-gradient 开发。

该第三方库的仓库已迁移至 Gitcode,且支持直接从 npm 下载,新的包名为:@react-native-ohos/react-native-linear-gradient 版本所属关系如下:

三方库名称 三方库版本(npm地址) 发布信息 支持RN版本 Autolink 编译API版本 社区基线版本 源码地址
@react-native-ohos/react-native-linear-gradient ~ 3.2.1(开发中) Gitcode Releases 0.84.* API12+ 3.0.0 master
@react-native-ohos/react-native-linear-gradient ~ 3.2.1(开发中) Gitcode Releases 0.82.* API12+ 3.0.0 br_rnoh0.82
@react-native-ohos/react-native-linear-gradient ~ 3.1.2(开发中) Gitcode Releases 0.77.* API12+ 3.0.0 br_rnoh0.77
@react-native-ohos/react-native-linear-gradient ~ 3.0.3(开发中) Gitcode Releases 0.72.* API12+ 3.0.0 br_rnoh0.72
@react-native-oh-tpl/react-native-linear-gradient <= 3.0.0-0.5.0@deprecated Github Releases(deprecated) 0.72.* API12+ 3.0.0 sig

简介

react-native-linear-gradient 是一个用于 React Native 的渐变组件库。
它提供了 LinearGradient 组件,可以在应用中创建平滑的颜色渐变效果,支持线性渐变的颜色、位置、角度等配置。

下载安装

进入到工程目录并输入以下命令:

npm

npm install @react-native-ohos/react-native-linear-gradient

纱线

yarn add @react-native-ohos/react-native-linear-gradient

链接

是否支持autolink RN框架版本
~ 3.2.1 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. 覆盖 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": {
    "@react-native-ohos/react-native-linear-gradient": "file:../../node_modules/@react-native-ohos/react-native-linear-gradient/harmony/linear_gradient.har"
  }

点击右上角的 sync 按钮

或者在命令行终端执行:

cd entry
ohpm install

方法二:直接链接源码

如需使用直接链接源码,请参考[直接链接源码说明](https://gitcode.com/CPF-RN/usage-docs/blob/master/zh-cn/link-source-code.md)

3. 配置 CMakeLists 和引入 LinearGradientPackage

打开 entry/src/main/cpp/CMakeLists.txt,添加:

+ set(OH_MODULES "${CMAKE_CURRENT_SOURCE_DIR}/../../../oh_modules")

# RNOH_BEGIN: manual_package_linking_1
+ add_subdirectory("${OH_MODULES}/@react-native-ohos/react-native-linear-gradient/src/main/cpp" ./linear-gradient)
# RNOH_END: manual_package_linking_1

# RNOH_BEGIN: manual_package_linking_2
+ target_link_libraries(rnoh_app PUBLIC rnoh_linear_gradient)
# RNOH_END: manual_package_linking_2

打开 entry/src/main/cpp/PackageProvider.cpp,添加:

#include "RNOH/PackageProvider.h"
#include "generated/RNOHGeneratedPackage.h"
+ #include "LinearGradientPackage.h"

using namespace rnoh;

std::vector<std::shared_ptr<Package>> PackageProvider::getPackages(Package::Context ctx) {
    return {
      std::make_shared<RNOHGeneratedPackage>(ctx),
+     std::make_shared<LinearGradientPackage>(ctx)
    };
}

运行

点击右上角的 sync 按钮

或者在命令行终端执行:

cd entry
ohpm install

然后编译、运行即可。

约束与限制

兼容性

本文档内容基于以下版本验证通过:

  1. RNOH: 0.84.1; SDK: HarmonyOS 6.0.1 Release SDK; IDE: DevEco Studio 6.0.1 Release; ROM:6.0.0.120;

使用示例

下面的代码展示了这个库的基本使用场景:

使用时 import 的库名不变。

import React, { ReactNode } from "react";
import {
  SafeAreaView,
  ScrollView,
  StatusBar,
  StyleSheet,
  Text,
  View,
} from "react-native";
import LinearGradient from "react-native-linear-gradient";

// Within your render function
function LinearGradientDemo() {
  return (
    <View style={styles.container}>
      <LinearGradient
        colors={["#4c669f", "#3b5998", "#192f6a"]}
        style={styles.linearGradient}
      >
        <Text style={styles.buttonText}>Sign in with Facebook</Text>
      </LinearGradient>
    </View>
  );
}
export default LinearGradientDemo;
// Later on in your styles..
var styles = StyleSheet.create({
  container: {
    backgroundColor: "#fff",
    flex: 1,
    paddingTop: 24,
  },
  linearGradient: {
    flex: 1,
    paddingLeft: 15,
    paddingRight: 15,
    borderRadius: 5,
  },
  buttonText: {
    fontSize: 18,
    fontFamily: "Gill Sans",
    textAlign: "center",
    margin: 10,
    color: "#ffffff",
    backgroundColor: "transparent",
  },
});

接口说明

“Platform”列表示该属性在原三方库上支持的平台。

“OpenHarmony Support”列为 yes 表示 OpenHarmony平台支持该属性;no 则表示不支持;partially 表示部分支持。使用方法跨平台一致,效果对标 iOS 或 Android 的效果。

属性

Name Description Type Required Platform HarmonyOS Support
colors 颜色数组 (string|number)[] Yes All yes
locations 颜色位置数组(长度为 0 或与 colors 相同) number[] NO All yes
useAngle 是否使用角度(默认为 false) boolean NO All yes
angle 角度(当 useAngle=true 时有效) number NO All yes
angleCenter 角度中心坐标 { x: number,y: number} NO All yes
start 起点坐标(默认值:{x: 0.5, y: 0.0}) { x: number,y: number} NO All yes
end 终点坐标(默认值:{x: 0.5, y: 1}) { x: number,y: number} NO All yes

遗留问题

其他

目录结构

/rntpc_react-native-linear-gradient  # 项目根目录
├── harmony              # 鸿蒙适配代码
│    └─ linear_gradient.har   # har包
│    └─ linear_gradient       # 鸿蒙适配核心代码
│          └─ index.ets       # 鸿蒙适配代码入口    
│          └─ src/main/cpp    # C++层代码
├── src                  # RN代码
├── README.md           # 中文安装使用方法
├── README_en.md        # 英文安装使用方法                

贡献代码

使用过程中发现任何问题都可以提交 Issue,当然,也非常欢迎提交 PR

开源协议

本项目基于 The MIT License (MIT),请自由地享受和参与开源。

项目介绍

基于 react-native-linear-gradient 的 OpenHarmony 适配版,线性渐变色组件

定制我的领域