rn_multidevice_layout_scenepkg v1.0.0

rn_multidevice_layout_scenepkg

介绍

这是一个旨在解决 React Native多设备适配问题的三方库，专为不同设备类型（包括折叠屏、平板、手机等）提供了便捷的支持。该库包含的接口和开箱即用的组件，使开发者能够轻松应对各种设备的布局适配需求。

工程目录

.
├─example
├─harmony
│  ├─fold.har                                 // 折叠屏turbo接口har包
│  └─fold
│     └─src
│        └─main
│           └─ets
│              ├─FoldModule.ets               // turbo接口ArkTS实现
│              ├─FoldModulePackage.ets        // FoldModulesFactory
│              ├─FoldModuleSpec.ts            // turbo接口
│              └─core
│                 └─FoldConfig.ts   
├─src
│  ├─index.ts                                 // RN模块导出
│  ├─component
│  │  └─FoldSplitContainer.tsx                // 折叠屏高阶组件
│  ├─config
│  │  └─breakpoints.ts                        // 断点配置类
│  ├─hooks
│  │  └─useBreakpointValue.ts                 //断点hook
│  └─turbo
│     └─NativeFoldModule.ts                   // RN turbo接口

安装与使用

请拉取rn_multidevice_layout_scenepkg代码仓并执行npm pack获取tgz包。

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

说明： #处替换为tgz包的路径

npm

npm install rn_multidevice_layout_scenepkg@file:#

yarn

yarn add rn_multidevice_layout_scenepkg@file:#

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

const TestSample = () => {
  const [foldCreaseRegion, setFoldCreaseRegion] = useState<number[]>([]);
  const [foldStatus, setFoldStatus] = useState('');
  const [breakpoints, setBreakpointsState] = useState({});
  const [isDeviceFoldable, setIsDeviceFoldable] = useState(false);

  useEffect(() => {
    const checkFoldable = () => {
      // 判断当前设备是否可折叠
      const foldable = Fold.isFoldable();
      setIsDeviceFoldable(foldable);
      if (foldable) {
        // 获取折痕区域
        setFoldCreaseRegion(Fold.getFoldCreaseRegion());
        
        // 获取当前折叠屏状态
        setFoldStatus(Fold.getFoldStatus());
      }
    };

    checkFoldable();

    // 监听折叠屏状态变化
    Fold.addFoldListener((foldStatus) => {
      console.log('折叠屏状态发生变化', foldStatus);
    });

    return () => {
      // 销毁监听折叠屏状态变化
      Fold.removeFoldListener();
    };
  }, []);

  const handleGetBreakpoints = () => {
    setBreakpointsState(getBreakpoints());
  };

  const handleSetBreakpoints = () => {
    // 设置断点区间
    setBreakpoints({
      base: 320,
      md: 768,
      lg: 1024,
    });
  };

  const handleGetFoldStatus = () => {
    if (isDeviceFoldable) {
      // 获取当前折叠屏状态
      setFoldStatus(Fold.getFoldStatus());
    }
  };

  const color = useBreakpointValue({
    // 根据不同断点设置不同的颜色
    base: 'red',
    xs: 'blue',
    sm: 'green',
    md: 'yellow',
    lg: 'purple',
    xl: 'orange',
  });
  
  // FoldSplitContainer 主要区域
  const primaryRender = () => (
    <View style={{ flex: 1 }}>
      <Text style={{ color }}>Responsive Color Text</Text>
      <Text>Is Device Foldable: {isDeviceFoldable ? 'Yes' : 'No'}</Text>

      {isDeviceFoldable && (
        <>
          <Text>Fold Crease Region: {JSON.stringify(foldCreaseRegion)}</Text>
          <Button title="Get Fold Status" onPress={handleGetFoldStatus} />
          {foldStatus && <Text>Fold Status: {foldStatus}</Text>}
        </>
      )}

      <Button title="Get Breakpoints" onPress={handleGetBreakpoints} />
      {Object.keys(breakpoints).length > 0 && (
        <Text>Breakpoints: {JSON.stringify(breakpoints)}</Text>
      )}

      <Button title="Set Custom Breakpoints" onPress={handleSetBreakpoints} />
    </View>
  );

  // FoldSplitContainer 次要区域
  const secondRender = () => (
    <View style={{ flex: 1, backgroundColor: 'blue' }}>
      <Text style={{ fontSize: 20 }}>secondRender</Text>
    </View>
  );

  // FoldSplitContainer 扩展区域
  const extraRender = () => (
    <View style={{ flex: 1, backgroundColor: 'red' }}>
      <Text style={{ fontSize: 20 }}>extraRender</Text>
    </View>
  );

  // 折叠屏展开态配置
  const expandedLayoutOptions: ExpandedRegionLayoutOptions = {
    isExtraRegionPerpendicular: false,
    extraRegionPosition: ExtraRegionPosition.BOTTOM,
  };

  // 折叠屏悬停态配置
  const hoverModeRegionLayoutOptions: HoverModeRegionLayoutOptions = {
    showExtraRegion: true,
  };

  return (
    <View style={styles.container}>
      // 折叠屏高阶组件
      <FoldSplitContainer
        primary={primaryRender()}
        secondary={secondRender()}
        extra={extraRender()}
        expandedLayoutOptions={expandedLayoutOptions}
        hoverModeLayoutOptions={hoverModeRegionLayoutOptions}
      />
    </View>
  );
};

const styles = StyleSheet.create({
  container: {
    flex: 1,
  },
});

export default TestSample;

Link

本库依赖以下三方库，请查看对应文档：

@react-native-oh-tpl/react-native-orientation

目前OpenHarmony暂不支持AutoLink，所以Link步骤需要手动配置。

首先需要使用DevEco Studio打开项目里的OpenHarmony工程，在工程根目录的oh-package.json5添加overrides字段：

{
  ...
  "overrides": {
    "@rnoh/react-native-openharmony" : "./react_native_openharmony"
  }
}

引入原生端代码

目前有两种方法：

1. 通过har包引入（在IDE完善相关功能后该方法会被遗弃，目前首选此方法）。

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

   a. 打开entry/oh-package.json5，添加以下依赖：

   "dependencies": {
       "@rnoh/react-native-openharmony": "file:../react_native_openharmony",
       "fold": "file:../../node_modules/rn_multidevice_layout_scenepkg/harmony/fold.har",
     }

   b. 配置CMakeLists和引入RNOHGeneratedPackage：

   打开entry/src/main/cpp/CMakeLists.txt，添加：

   project(rnapp)
   cmake_minimum_required(VERSION 3.4.1)
   set(CMAKE_SKIP_BUILD_RPATH TRUE)
   set(OH_MODULE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/../../../oh_modules")
   set(RNOH_APP_DIR "${CMAKE_CURRENT_SOURCE_DIR}")
   
   set(RNOH_CPP_DIR "${OH_MODULE_DIR}/@rnoh/react-native-openharmony/src/main/cpp")
   set(RNOH_GENERATED_DIR "${CMAKE_CURRENT_SOURCE_DIR}/generated")
   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")
   add_compile_definitions(WITH_HITRACE_SYSTRACE)
   set(WITH_HITRACE_SYSTRACE 1) # for other CMakeLists.txt files to use
   + file(GLOB GENERATED_CPP_FILES "./generated/*.cpp")
   
   add_subdirectory("${RNOH_CPP_DIR}" ./rn)
   
   add_library(rnoh_app SHARED
   +    ${GENERATED_CPP_FILES}
       "./PackageProvider.cpp"
       "${RNOH_CPP_DIR}/RNOHAppNapiBridge.cpp"
   )
   
   target_link_libraries(rnoh_app PUBLIC rnoh)

   c. 打开entry/src/main/cpp/PackageProvider.cpp，添加：

   #include "RNOH/PackageProvider.h"
   + #include "generated/RNOHGeneratedPackage.h"
   
   using namespace rnoh;
   
   std::vector<std::shared_ptr<Package>> PackageProvider::getPackages(Package::Context ctx) {
       return {
   +        std::make_shared<RNOHGeneratedPackage>(ctx)
       };
   }

   d. 在ArkTs侧引入FoldModulePackage：

   打开entry/src/main/ets/RNPackagesFactory.ts，添加：

     ...
   + import { FoldModulePackage } from 'fold/ts';
   
   export function createRNPackages(ctx: RNPackageContext): RNPackage[] {
     return [
   +   new FoldModulePackage(ctx),
     ];
   }

   e. 运行：

   点击右上角的sync按钮

   或者在终端执行：

   cd entry
   ohpm install

   然后编译、运行即可。

2. 直接链接源码。

如需使用直接链接源码，请参考[直接链接源码说明](https://gitee.com/react-native-oh-library/usage-docs/blob/master/zh-cn/link-source-code.md)。

API

说明： "Platform"列表示支持的平台，All表示支持所有平台。

断点

折叠屏适配

折叠屏接口

FoldSplitContainer组件

ExpandedRegionLayoutOptions

HoverModeRegionLayoutOptions

FoldedRegionLayoutOptions

onHoverStatusChangeHandler

HoverModeStatus

ExtraRegionPosition

PresetSplitRatio