模板版本:v0.4.0

react-native-shared-element

本项目基于 react-native-shared-element 开发。

该第三方库支持直接从 npm 下载,新的包名为:@react-native-ohos/react-native-shared-element 版本所属关系如下:

三方库名称 三方库版本 发布信息 支持RN版本 Autolink 编译API版本 社区基线版本 npm地址
@react-native-ohos/react-native-shared-element ~ 0.10.0 Github Releases 0.82.* API12+ 0.9.0-rc0 Npm Address
@react-native-ohos/react-native-shared-element ~ 0.9.1 Github Releases 0.77.* API12+ 0.9.0-rc0 Npm Address
@react-native-ohos/react-native-shared-element ~ 0.8.10 Github Releases 0.72.* API12+ 0.8.9 Npm Address
@react-native-oh-tpl/react-native-shared-element <= 0.8.9-0.0.6@deprecated Github Releases(deprecated) 0.72.* API12+ 0.8.9 Npm Address

1. 安装与使用

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

npm


npm install @react-native-ohos/react-native-shared-element

yarn


yarn add @react-native-ohos/react-native-shared-element

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

使用时 import 的库名不变。

import * as React from 'react';
import {
  View,
  StyleSheet,
  Animated,
  Dimensions,
  TouchableOpacity,
  Image,
} from 'react-native';
import {
  SharedElement,
  SharedElementTransition,
  nodeFromRef,
} from 'react-native-shared-element';

export default class App extends React.Component {
  state = {
    progress: new Animated.Value(0),
    isScene2Visible: false,
    isInProgress: false,
    scene1Ancestor: null,
    scene1Node: null,
    scene2Ancestor: null,
    scene2Node: null,
  };

  onPressNavigate = () => {
    this.setState({isScene2Visible: true, isInProgress: true});
    Animated.timing(this.state.progress, {
      toValue: 1,
      duration: 1000,
      useNativeDriver: true,
    }).start(() => this.setState({isInProgress: false}));
  };

  onPressBack = () => {
    this.setState({isInProgress: true});
    Animated.timing(this.state.progress, {
      toValue: 0,
      duration: 1000,
      useNativeDriver: true,
    }).start(() =>
      this.setState({isScene2Visible: false, isInProgress: false}),
    );
  };

  onSetScene1Ref = (ref: View | null) => {
    this.setState({scene1Ancestor: nodeFromRef(ref)});
  };

  onSetScene2Ref = (ref: View | null) => {
    this.setState({scene2Ancestor: nodeFromRef(ref)});
  };

  render() {
    const {state} = this;
    const {width} = Dimensions.get('window');
    return (
      <>
        <TouchableOpacity
          style={styles.container}
          activeOpacity={0.5}
          onPress={
            state.isScene2Visible ? this.onPressBack : this.onPressNavigate
          }>
          {/* Scene 1 */}
          <Animated.View
            style={{
              ...StyleSheet.absoluteFillObject,
              transform: [
                {translateX: Animated.multiply(-200, state.progress)},
              ],
            }}>
            <View style={styles.scene} ref={this.onSetScene1Ref}>
              <SharedElement onNode={node => this.setState({scene1Node: node})}>
                <Image
                  style={styles.image1}
                  source={require('本地图片路径')}
                />
              </SharedElement>
            </View>
          </Animated.View>

          {/* Scene 2 */}
          {state.isScene2Visible ? (
            <Animated.View
              style={{
                ...StyleSheet.absoluteFillObject,
                transform: [
                  {
                    translateX: Animated.multiply(
                      -width,
                      Animated.add(state.progress, -1),
                    ),
                  },
                ],
              }}>
              <View style={styles.scene2} ref={this.onSetScene2Ref}>
                <SharedElement
                  onNode={node => this.setState({scene2Node: node})}>
                  <Image
                    style={styles.image2}
                    source={require('本地图片路径')}
                  />
                </SharedElement>
              </View>
            </Animated.View>
          ) : undefined}
        </TouchableOpacity>

        {/* Transition overlay */}
        {state.isInProgress ? (
          <View style={styles.sharedElementOverlay}>
            <SharedElementTransition
              start={{
                node: state.scene1Node,
                ancestor: state.scene1Ancestor,
              }}
              end={{
                node: state.scene2Node,
                ancestor: state.scene2Ancestor,
              }}
              position={state.progress}
              animation="move"
              resize="auto"
              align="auto"
            />
          </View>
        ) : undefined}
      </>
    );
  }
}

const styles = StyleSheet.create({
  container: {
    flex: 1,
    backgroundColor: '#ecf0f1',
  },
  scene: {
    ...StyleSheet.absoluteFillObject,
    backgroundColor: 'white',
    justifyContent: 'center',
    alignItems: 'center',
  },
  scene2: {
    ...StyleSheet.absoluteFillObject,
    backgroundColor: '#00d8ff',
    justifyContent: 'center',
    alignItems: 'center',
  },
  image1: {
    width: 160,
    height: 160,
  },
  image2: {
    width: 300,
    height: 300,
  },
  sharedElementOverlay: {
    ...StyleSheet.absoluteFillObject,
  },
});

使用 Codegen

本库已经适配了 Codegen ,在使用前需要主动执行生成三方库桥接代码,详细请参考 Codegen 文档

是否支持autolink RN框架版本
~0.10.0 Yes 0.82
~0.9.1 No 0.77
~0.8.10 Yes 0.72
<= 0.8.9-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. 引入原生端代码

目前有两种方法:

  1. 通过 har 包引入
  2. 直接链接源码。

方法一:通过 har 包引入

har 包位于三方库安装路径的 `harmony` 文件夹下。

打开 entry/oh-package.json5,添加以下依赖

"dependencies": {
    "@rnoh/react-native-openharmony": "file:../react_native_openharmony",
    "@react-native-ohos/react-native-shared-element": "file:../../node_modules/@react-native-ohos/react-native-shared-element/harmony/shared_element.har"
}

点击右上角的 sync 按钮

或者在终端执行:

cd entry
ohpm install

方法二:直接链接源码

如需使用直接链接源码,请参考[直接链接源码说明](./link-source-code.md)

2.3. 配置 CMakeLists 和引入 SharedElementPackage

若使用的是 <= 0.8.9-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-shared-element/src/main/cpp" ./shared-element)
# 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_shared_element)
# RNOH_END: manual_package_linking_2

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

#include "RNOH/PackageProvider.h"
#include "generated/RNOHGeneratedPackage.h"
#include "SamplePackage.h"
+ #include "SharedElementPackage.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<SharedElementPackage>(ctx),
    };
}

2.4. 在 ArkTs 侧引入 SharedElementPackage

打开 entry/src/main/ets/RNPackagesFactory.ts,添加:

  ...
+ import { SharedElementPackage } from '@react-native-ohos/react-native-shared-element/ts';

export function createRNPackages(ctx: RNPackageContext): RNPackage[] {
  return [
    new SamplePackage(ctx),
+   new SharedElementPackage(ctx),
  ];
}

2.5. 运行

点击右上角的 sync 按钮

或者在终端执行:

cd entry
ohpm install

然后编译、运行即可。

3. 约束与限制

3.1. 兼容性

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

  1. RNOH: 0.72.96; SDK: HarmonyOS 6.0.0 Release SDK; IDE: DevEco Studio 6.0.0.858; ROM: 6.0.0.112;
  2. RNOH: 0.72.33; SDK: HarmonyOS NEXT B1; IDE: DevEco Studio: 5.0.3.900; ROM: Next.0.0.71;
  3. RNOH: 0.77.18; SDK: HarmonyOS 6.0.0 Release SDK; IDE: DevEco Studio 6.0.0.858; ROM: 6.0.0.112;
  4. RNOH: 0.82.22; SDK: HarmonyOS 6.0.0 Release SDK; IDE: DevEco Studio 6.0.0.878; ROM: 6.0.0.130;

4. 属性

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

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

SharedElement

Name Description Type Required Platform HarmonyOS Support
children 设置或取消设置节点句柄的事件处理程序 element yes ALL yes
onNode 设置或取消设置节点句柄的事件处理程序 function yes ALL yes
nodeFromRef 从ref获取共享元素节点 function yes ALL yes
View props... View 支持的其他属性 NA yes ALL yes

SharedElementTransition

Name Description Type Required Platform HarmonyOS Support
start 起始节点和祖先节点 { node: SharedElementNode, ancestor: SharedElementNode } yes ALL yes
end 结束节点和祖先节点 { node: SharedElementNode, ancestor: SharedElementNode } yes ALL yes
position 在起始节点和结束节点之间的插值位置 (0..1) number|Animated.Value|Reanimated.Value yes ALL yes
animation 动画类型,例如移动起始元素或在起始元素和结束元素之间淡入淡出(默认值 = move) SharedElementAnimation yes ALL yes
resize 调整大小行为(默认值 = auto) SharedElementResize yes ALL yes
align 对齐行为(默认值 = auto) SharedElementAlign yes ALL yes
debug 渲染调试覆盖层以诊断测量和动画 boolean no ALL yes
onMeasure 当节点被测量和快照时调用的事件处理程序 function no ALL yes

SharedElementAnimation

Name Description Type Required Platform HarmonyOS Support
move 将起始元素移动到结束位置 string no ALL yes
fade 在起始元素和结束元素之间淡入淡出 string no ALL yes
fade-in 从起始位置淡入结束元素(起始元素不可见) string no ALL yes
fade-out 将起始元素淡出到结束位置(结束元素不可见) string no ALL yes

SharedElementResize

Name Description Type Required Platform HarmonyOS Support
auto 自动选择默认的调整大小行为。对于图像,这将根据图像执行最佳可能的过渡。对于其他类型的视图,这将默认为 resizeMode 的 stretch string no ALL yes
stretch 将元素拉伸到与其他元素相同的形状和大小。如果内容的宽高比不同,您可能会看到拉伸效果。在这种情况下,请考虑使用 clip 或 none 调整选项 string no ALL yes
clip 不调整大小,而是将内容裁剪到其他内容的大小。例如,此选项与<Text>组件结合使用时很有用,您可以显示更多文本 string no ALL yes
none 不调整内容大小。与fade结合使用时,这会产生简单的淡入淡出效果,而不会有任何调整大小或裁剪 string no ALL yes

SharedElementAlign

Name Description Type Required Platform HarmonyOS Support
auto 使用默认的对齐策略,即居中对齐 string no ALL yes
left-center 将共享元素对齐到左中位置 string no ALL yes
left-top 将共享元素对齐到左上位置 string no ALL yes
left-bottom 将共享元素对齐到左下位置 string no ALL yes
right-center 将共享元素对齐到右中位置 string no ALL yes
right-top 将共享元素对齐到右上位置 string no ALL yes
right-bottom 将共享元素对齐到右下位置 string no ALL yes
center-top 将共享元素对齐到中上位置 string no ALL yes
center-center 将共享元素对齐到正中位置 string no ALL yes
center-bottom 将共享元素对齐到中下位置 string no ALL yes

5. 遗留问题

6. 其他

7. 开源协议

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