@ohmi/blur

This project is based on @react-native-community/blur

License

This library is licensed under [The MIT License (MIT)](https://github.com/Kuree> 模板版本：v0.2.2

[!TIP] Github 地址

安装与使用

本库已经适配C-API版本从版本4.4.0-0.1.0开始的版本为C-API版本，C-API版本在性能和速度上都优于ArkTS版本。

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

npm

npm install @ohmi/blur

yarn

yarn add @ohmi/blur

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

import React, { useState} from 'react';
import {
  Image,
  StyleSheet,
  Platform,
  Switch,
  Text,
  View,
  SafeAreaView,
  Dimensions,
} from 'react-native';

import {
  BlurView,
  BlurViewProps,
} from '@react-native-community/blur';

export const Blurs = () => {
  const [blurBlurType, setBlurBlurType] = useState<BlurViewProps['blurType']>('dark');
  const [blurAmount, setBlurAmount] = useState<number>(100);
  useState<BlurViewProps['blurType']>('dark');
  const tintColor = blurBlurType === 'dark' ? 'white' : 'black';

  return (
    <View style={styles.container}>
      <View style={styles.blurContainer}>
        <BlurView
          blurType={blurBlurType}
          blurAmount={blurAmount}
          reducedTransparencyFallbackColor='red'
          style={[styles.blurView]}
        />
        <Text style={[styles.text, { color: tintColor }]}>
          Blur component ({Platform.OS})
        </Text>

        <View style={styles.row}>
          <Text onPress={() => {
            setBlurBlurType('light')
          }}>light</Text>

          <Text onPress={() => {
            setBlurBlurType('dark')
          }}>dark</Text>

          <Text onPress={() => {
            setBlurBlurType('chromeMaterialLight')
          }}>chromeMaterialLight click will crash</Text>
        </View>
        <View style={styles.row}>
          <Text onPress={() => {
            setBlurAmount(20)
          }}>20</Text>

          <Text onPress={() => {
            setBlurAmount(40)
          }}>40</Text>

          <Text onPress={() => {
            setBlurAmount(60)
          }}>60</Text>
          <Text onPress={() => {
            setBlurAmount(80)
          }}>80</Text>

          <Text onPress={() => {
            setBlurAmount(100)
          }}>100</Text>
        </View>
      </View>
    </View>
  );
};

export const BlurDemo = () => {
  const [showBlurs, setShowBlurs] = React.useState(false);
   //'../assets/bgimage.jpeg' 此路径的图片为本地图片，在使用demo时将此图片的路径换为自己本地图片路径
  return (
    <View style={styles.container}>
      <Image
      
        source={require('../assets/bgimage.jpeg')}
        resizeMode="cover"
        style={styles.img}
      />
      {showBlurs ? <Blurs /> : null}

      <SafeAreaView style={styles.blurToggle}>
        <Switch
          onValueChange={(value) => setShowBlurs(value)}
          value={showBlurs}
        />
      </SafeAreaView>
    </View>
  );
};

const styles = StyleSheet.create({
  container: {
    flex: 1,
    backgroundColor: 'transparent',
  },
  blurContainer: {
    flex: 1,
    backgroundColor: 'transparent',
    justifyContent: 'center',
    alignItems: 'stretch',
  },
  row: {
    marginTop: 50,
    flex: 1,
    width: '100%',
    flexDirection: 'row',
    justifyContent: 'space-between',
    alignItems: 'stretch',
  },
  blurView: {
    position: 'absolute',
    left: 0,
    right: 0,
    top: 0,
    bottom: 0,
    width: Dimensions.get('window').width,
  },

  blurView2: {
    position: 'absolute',
    left: 0,
    right: 0,
    top: 0,
    bottom: 0,
  },
  img: {
    position: 'absolute',
    left: 0,
    right: 0,
    top: 0,
    bottom: 0,
    height: Dimensions.get('window').height,
    width: Dimensions.get('window').width,
  },
  text: {
    fontSize: 20,
    fontWeight: 'bold',
    textAlign: 'center',
    margin: 10,
    color: 'white',
  },
  blurToggle: {
    position: 'absolute',
    top: 30,
    right: 10,
    alignItems: 'flex-end',
  },
});

Link

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

首先需要使用 DevEco Studio 打开项目里的 HarmonyOS 工程 harmony

1.在工程根目录的 oh-package.json5 添加 overrides 字段

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

2.引入原生端代码

目前有两种方法：

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

方法一：通过 har 包引入

[!TIP] har 包位于三方库安装路径的 harmony 文件夹下。

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

"dependencies": {
    "@rnoh/react-native-openharmony": "file:../react_native_openharmony",

    "@ohmi/blur": "file:../../node_modules/@ohmi/blur/harmony/blur.har"
  }

点击右上角的 sync 按钮

或者在终端执行：

cd entry
ohpm install

方法二：直接链接源码

[!TIP] 如需使用直接链接源码，请参考直接链接源码说明

3.配置 CMakeLists 和引入 BlurPackage

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

project(rnapp)
cmake_minimum_required(VERSION 3.4.1)
set(RNOH_APP_DIR "${CMAKE_CURRENT_SOURCE_DIR}")
+ set(OH_MODULES "${CMAKE_CURRENT_SOURCE_DIR}/../../../oh_modules")
set(RNOH_CPP_DIR "${CMAKE_CURRENT_SOURCE_DIR}/../../../../../../react-native-harmony/harmony/cpp")

add_subdirectory("${RNOH_CPP_DIR}" ./rn)

# RNOH_BEGIN: add_package_subdirectories
add_subdirectory("../../../../sample_package/src/main/cpp" ./sample-package)
+ add_subdirectory("${OH_MODULES}/@ohmi/blur/src/main/cpp" ./blur)
# RNOH_END: add_package_subdirectories

add_library(rnoh_app SHARED
    "./PackageProvider.cpp"
    "${RNOH_CPP_DIR}/RNOHAppNapiBridge.cpp"
)

target_link_libraries(rnoh_app PUBLIC rnoh)

# RNOH_BEGIN: link_packages
target_link_libraries(rnoh_app PUBLIC rnoh_sample_package)
+ target_link_libraries(rnoh_app PUBLIC rnoh_blur)
# RNOH_END: link_packages

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

#include "RNOH/PackageProvider.h"
#include "SamplePackage.h"
+ #include "BlurPackage.h"

using namespace rnoh;

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

4.在 ArkTs 侧引入 BlurView 组件（使用4.4.0-0.1.0及之后的版本忽略这步配置）

找到 function buildCustomRNComponent()，一般位于 entry/src/main/ets/pages/index.ets 或 entry/src/main/ets/rn/LoadBundle.ets，添加：

+ import {  BlurView, BLUR_TYPE } from "@ohmi/blur"

@Builder
function buildCustomRNComponent(ctx: ComponentBuilderContext) {
 ...
+  if (ctx.componentName === BLUR_TYPE) {
+   BlurView({
+     ctx: ctx.rnohContext,
+     tag: ctx.tag,
+   })
+ }
 ...
}

在entry/src/main/ets/pages/index.ets 或 entry/src/main/ets/rn/LoadBundle.ets 找到常量 arkTsComponentNames 在其数组里添加组件名

[!TIP] 本库使用了混合方案，需要添加组件名。

const arkTsComponentNames: Array<string> = [
  SampleView.NAME,
  GeneratedSampleView.NAME,
  PropsDisplayer.NAME,
+ BLUR_TYPE
  ];

5.运行

点击右上角的 sync 按钮

或者在终端执行：

cd entry
ohpm install

然后编译、运行即可。

约束与限制

兼容性

要使用此库，需要使用正确的 React-Native 和 RNOH 版本。另外，还需要使用配套的 DevEco Studio 和 手机 ROM。

请到三方库相应的 Releases 发布地址查看 Release 配套的版本信息：@ohmi/react-native-community-blur Releases

属性

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

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

| Name | Description | Type | Required | Platform | HarmonyOS Support | | ----------------------------------- | ----------------------------------------------------------------------------------------- | --------- |----------| ------- | ----------------- | | blurType | blur type | enum | yes | iOS,Android | yes | | blurAmount? | 0 - 100 (The maximum blurAmount on Android is 32, so higher values will be clamped to 32) | number | no | iOS,Android | yes | | reducedTransparencyFallbackColor? | Reduce transparency fallback color | Any color | no | iOS | no | | blurRadius? | Matches iOS blurAmount | number | no | Android | no | | downsampleFactor? | Matches iOS blurAmount | number | no | Android | no | | overlayColor? | Default color based on iOS blurType | Any color | no | Android | no |

blurType

[!TIP] 如果要使用自适应模糊效果需要配置深色模式配置文档如果不配置深色模式则自适应模糊效果将没有深色模式，只有浅色模式。

| Name | Description | Platform | HarmonyOS Support | | ------------------------ | ------------------------------------------------------------------------------------------------------ |-----------------------| ----------------- | | xlight | extra light blur type | iOS,Android | yes | | light | light blur type | iOS,Android | yes | | dark | dark blur type | iOS,Android | yes | | extraDark | extra dark blur type (tvOS only) | iOS | yes | | regular | regular blur type (iOS 10+ and tvOS only) | iOS | yes | | prominent | prominent blur type (iOS 10+ and tvOS only) | iOS | yes | | chromeMaterial | An adaptable blur effect that creates the appearance of a material with normal thickness | iOS 13 only | yes | | material | An adaptable blur effect that creates the appearance of a material with normal thickness | iOS 13 only | yes | | thickMaterial | An adaptable blur effect that creates the appearance of a material that is thicker than normal | iOS 13 only | yes | | thinMaterial | An adaptable blur effect that creates the appearance of an ultra-thin material | iOS 13 only | yes | | ultraThinMaterial | An adaptable blur effect that creates the appearance of an ultra-thin material | iOS 13 only | yes | | chromeMaterialDark | A blur effect that creates the appearance of an ultra-thin material and is always dark | iOS 13 only | yes | | materialDark | A blur effect that creates the appearance of a thin material and is always dark | iOS 13 only | yes | | thickMaterialDark | A blur effect that creates the appearance of a material with normal thickness and is always dark | iOS 13 only | yes | | thinMaterialDark | A blur effect that creates the appearance of a material that is thicker than normal and is always dark | iOS 13 only | yes | | ultraThinMaterialDark | A blur effect that creates the appearance of the system chrome and is always dark | iOS 13 only | yes | | chromeMaterialLight | An adaptable blur effect that creates the appearance of the system chrome | iOS 13 only | yes | | materialLight | An adaptable blur effect that creates the appearance of a material with normal thickness | iOS 13 only | yes | | thickMaterialLight | An adaptable blur effect that creates the appearance of a thin material | iOS 13 only | yes | | thinMaterialLight | An adaptable blur effect that creates the appearance of a thin material | iOS 13 only | yes | | ultraThinMaterialLight | An adaptable blur effect that creates the appearance of an ultra-thin material | iOS 13 only | yes |

API

[!TIP] "Platform"列表示该组件在原三方库上支持的平台。

[!TIP] "HarmonyOS Support"列为 yes 表示 HarmonyOS 平台支持该组件；no 则表示不支持；partially 表示部分支持。使用方法跨平台一致，效果对标 iOS 或 Android 的效果。

| Name | Description | Type | Required | Platform | HarmonyOS Support | | -------------- | ------------------------------------------------------------------------------------------ | ---|------ |----------| ----------------- | | BlurView | Preload images to display later. e.g. | component|no | iOS,Android | yes | | VibrancyView | The vibrancy effect lets the content underneath a blurred view show through more vibrantly | component|no | iOS | no |

遗留问题

• [ ] @react-native-community/blur的 VibrancyView组件未实现HarmonyOS化 issue#7
• [ ] @react-native-community/blur的reducedTransparencyFallbackColor属性未实现 HarmonyOS化issue#8

其他

开源协议

本项目基于 The MIT License (MIT) ，请自由地享受和参与开源。v/react-native-blur/blob/master/LICENSE)