From e782c7cab64cf745552944a79d1dffe8771799cc Mon Sep 17 00:00:00 2001 From: tangshutong Date: Fri, 12 Dec 2025 10:16:17 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E6=B7=BB=E5=8A=A0=E8=BF=81=E7=A7=BB?= =?UTF-8?q?=E5=A3=B0=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: tangshutong --- README.md | 20 +-- doc/en.md | 441 ++++++++++++++++++++++++++++++++++++++++++++++++++ doc/zh-cn.md | 442 +++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 893 insertions(+), 10 deletions(-) create mode 100644 doc/en.md create mode 100644 doc/zh-cn.md diff --git a/README.md b/README.md index 8054951..a07ba6d 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ -# @react-native-oh-tpl/react-native-blurhash +# 迁移声明 -本项目基于 [react-native-blurhash](https://github.com/TiHxdvt/react-native-blurhash) +- 本仓库已迁移至 GitCode：[OpenHarmony-SIG/rntpc_react-native-blurhash](https://gitcode.com/openharmony-sig/rntpc_react-native-blurhash)。 +- 包名已更改为 `@react-native-ohos/react-native-blurhash`，支持直接从 npm 下载。 +- 更多详情请查阅新仓库的 README 文件。 +- 本仓库旧版本的文档已归档：[链接](/doc/zh-cn.md) -## 文档地址 / Documentation URL +# Migration Announcement -[中文 / Chinese](https://gitee.com/react-native-oh-library/usage-docs/blob/master/zh-cn/react-native-blurhash.md) - -[英文 / English](https://gitee.com/react-native-oh-library/usage-docs/blob/master/zh-en/react-native-blurhash.md) - -## 请悉知 / Acknowledgements - -本项目基于 [The MIT License (MIT)](https://github.com/mrousavy/react-native-blurhash/blob/master/LICENSE) ，请自由地享受和参与开源。 +- This repository has been migrated to GitCode：[OpenHarmony-SIG/rntpc_react-native-blurhash](https://gitcode.com/openharmony-sig/rntpc_react-native-blurhash) +- The package name has been changed to `@react-native-ohos/react-native-blurhash` and is now available for direct download from npm. +- For more details, please refer to the README in the new repository. +- Archived documentation for versions in this repository can be found here: [Link](/doc/en.md) diff --git a/doc/en.md b/doc/en.md new file mode 100644 index 0000000..cbf7273 --- /dev/null +++ b/doc/en.md @@ -0,0 +1,441 @@ +> Template version: v0.2.2 + +

+

react-native-blurhash

+

+

+ + Supported platforms + + + License + + +

+ + + +> [!TIP] [GitHub address](https://github.com/react-native-oh-library/react-native-blurhash) + +## Installation and Usage + +Find the matching version information in the release address of a third-party library and download an applicable .tgz package: [@react-native-oh-tpl/react-native-blurhash Releases](https://github.com/react-native-oh-library/react-native-blurhash/releases). + +Go to the project directory and execute the following instruction: + + + + + +#### **npm** + +```bash +npm install @react-native-oh-tpl/react-native-blurhash +``` + +#### **yarn** + +```bash +yarn add @react-native-oh-tpl/react-native-blurhash +``` + + + +The following code shows the basic use scenario of the repository: + +> [!WARNING] The name of the imported repository remains unchanged. + +```jsx +import React, { useCallback, useMemo, useState } from 'react'; +import { Blurhash } from 'react-native-blurhash'; +import { + ActivityIndicator, + Alert, + SafeAreaView, + StatusBar, + StyleSheet, + Switch, + Text, + TextInput, + TouchableOpacity, + View +} from 'react-native'; + +const COLORS = { + background: '#F5FCFF', + statusBar: 'rgba(100, 0, 100, 0.6)', + textInput: 'rgba(200, 0, 100, 0.5)', + button: 'rgba(200, 0, 100, 0.4)', + switchEnabled: 'rgba(200, 0, 100, 0.5)', + switchDisabled: 'rgba(200, 0, 100, 0.2)', + switchThumb: 'white', + shadow: 'black', +}; +const SWITCH_THUMB_COLORS = { + false: COLORS.switchDisabled, + true: COLORS.switchEnabled, +}; + +const BlurhashDemo: React.FC = (): JSX.Element => { + + //#region State & Props + const [blurhash, setBlurhash] = useState('LHK1gsM,rzD+4-xn,vWT~q=_ixS]'); + const [decodeAsync, setDecodeAsync] = useState(true); + const [encodingImageUri, setEncodingImageUri] = useState( + 'http://gips2.baidu.com/it/u=3150002139,2124277596&fm=3028&app=3028&f=JPEG&fmt=auto?w=2048&h=2048' + ); + const [isEncoding, setIsEncoding] = useState(false); + const [isValiding, setIsVailding] = useState(false); + //#endregion + + //#region Memos + const buttonOpacity = useMemo( + () => (encodingImageUri.length < 5 || isEncoding ? 0.5 : 1), + [encodingImageUri.length, isEncoding], + ); + const encodeButtonStyle = useMemo( + () => [styles.encodeButton, { opacity: buttonOpacity }], + [buttonOpacity], + ); + //#endregion + + //#region Callbacks + const onLoadStart = useCallback(() => { + console.log('onLoadStart called!'); + }, []); + const onLoadEnd = useCallback(() => { + console.log('onLoadEnd called!'); + }, []); + const onLoadError = useCallback((message?: string) => { + console.log(`onLoadError called! Message: ${message}`); + }, []); + const startEncoding = useCallback(async () => { + try { + if (encodingImageUri.length < 5) return; + setIsEncoding(true); + const _blurhash = await Blurhash.encode(encodingImageUri, 4, 3); + setBlurhash(_blurhash); + setIsEncoding(false); + } catch (e: any) { + setIsEncoding(false); + console.warn('Failed to encode!', e); + Alert.alert('Encoding error', e.message); + } + }, [encodingImageUri]); + const isVaild = () => { + console.log(blurhash); + const data = Blurhash.isBlurhashValid(blurhash) + Alert.alert("blurhash is valid? : " + data.isValid) + console.log(data); + } + const CCache = useCallback(() => { + Blurhash.clearCosineCache() + }, []) + //#endregion + + return ( + <> + + + + + + + + + {/* To test if `decodeAsync` really doesn't block the UI thread, you can press this Touchable and see it reacting. */} + + Decode Async: + + + + + {isEncoding ? ( + + ) : ( + Encode + )} + + + + ); +} + +const styles = StyleSheet.create({ + container: { + flex: 1, + justifyContent: 'center', + alignItems: 'center', + backgroundColor: COLORS.background, + }, + blurhashContainer: { + shadowRadius: 3, + shadowColor: COLORS.shadow, + shadowOffset: { + height: 2, + width: 0, + }, + shadowOpacity: 0.4, + overflow: 'visible', + }, + blurhashRadiusMask: { + elevation: 5, + // borderRadius has to be applied to the parent + borderRadius: 5, + overflow: 'hidden', + }, + blurhashImage: { + width: 300, + height: 200, + // Custom styling for width, height, scaling etc here + }, + textInput: { + marginTop: 20, + borderRadius: 5, + borderWidth: 1, + borderColor: COLORS.textInput, + width: '70%', + height: 35, + paddingHorizontal: 20, + textAlign: 'center', + }, + row: { + marginTop: 30, + flexDirection: 'row', + alignItems: 'center', + }, + text: { + fontSize: 16, + marginRight: 15, + }, + encodeButton: { + height: 37, + width: 120, + marginTop: 30, + backgroundColor: COLORS.button, + borderRadius: 10, + paddingVertical: 10, + paddingHorizontal: 35, + justifyContent: 'center', + }, +}); + +export default BlurhashDemo +``` + +## Link + +Currently, HarmonyOS does not support AutoLink. Therefore, you need to manually configure the linking. + +Open the `harmony` directory of the HarmonyOS project in DevEco Studio. + +### 1. Adding the overrides Field to oh-package.json5 File in the Root Directory of the Project + +```json +{ + ... + "overrides": { + "@rnoh/react-native-openharmony" : "./react_native_openharmony" + } +} +``` + +### 2.Introducing Native Code + +Currently, two methods are available: + + + +Method 1 (recommended): Use the HAR file. + +> [!TIP] The HAR file is stored in the `harmony` directory in the installation path of the third-party library. + +Open `entry/oh-package.json5` file and add the following dependencies: + +```json +"dependencies": { + "@rnoh/react-native-openharmony": "file:../react_native_openharmony", + "@react-native-oh-tpl/react-native-blurhash": "file:../../node_modules/@react-native-oh-tpl/react-native-blurhash/harmony/blurhash.har" + } +``` + +Click the `sync` button in the upper right corner. + +Alternatively, run the following instruction on the terminal: + +```bash +cd entry +ohpm install +``` + +Method 2: Directly link to the source code. + +> [!TIP] For details, see [Directly Linking Source Code](/en/link-source-code.md). + +### 3. Configuring CMakeLists and Introducing BlurhashPackage + +Open `entry/src/main/cpp/CMakeLists.txt` and add the following code: + +```diff +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}/../../../oh_modules/@rnoh/react-native-openharmony/src/main/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-oh-tpl/react-native-blurhash/src/main/cpp" ./blurhash) +# 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_blurhash) +# RNOH_END: manual_package_linking_2 + +``` + +Open `entry/src/main/cpp/PackageProvider.cpp` and add the following code: + +```diff +#include "RNOH/PackageProvider.h" +#include "generated/RNOHGeneratedPackage.h" +#include "SamplePackage.h" ++ #include "BlurhashPackage.h" + +using namespace rnoh; + +std::vector> PackageProvider::getPackages(Package::Context ctx) { + return { + std::make_shared(ctx), + std::make_shared(ctx), ++ std::make_shared(ctx) + }; +} +``` + +### 4. Introducing BlurhashPackage to ArkTS + + Open the `entry/src/main/ets/RNPackagesFactory.ts` file and add the following code: + +```diff ++ import {BlurhashPackage} from '@react-native-oh-tpl/react-native-blurhash/ts'; + +export function createRNPackages(ctx: RNPackageContext): RNPackage[] { + return [ + new SamplePackage(ctx), ++ new BlurhashPackage(ctx), + ]; +} + +``` + +### 5.Running + +Click the `sync` button in the upper right corner. + +Alternatively, run the following instruction on the terminal: + +```bash +cd entry +ohpm install +``` + +Then build and run the code. + +## Constraints + +### Compatibility + +To use this repository, you need to use the correct React-Native and RNOH versions. In addition, you need to use DevEco Studio and the ROM on your phone. + +Check the release version information in the release address of the third-party library: [@react-native-oh-tpl/react-native-blurhash Releases](https://github.com/react-native-oh-library/react-native-blurhash/releases) + +## Properties + +> [!TIP] The **Platform** column indicates the platform where the properties are supported in the original third-party library. + +> [!TIP] If the value of **HarmonyOS Support** is **yes**, it means that the HarmonyOS platform supports this property; **no** means the opposite; **partially** means some capabilities of this property are supported. The usage method is the same on different platforms and the effect is the same as that of iOS or Android. + +| Name | Description | Type | Required | Platform | HarmonyOS Support | +| ------------------------------------------ | ------------------------------------------------------------ | --------- | -------- | -------- | ----------------- | +| `blurhash` | The blurhash string to use. Example: `LGFFaXYk^6#M@-5c,1J5@[or[Q6.` | string | yes | All | yes | +| `decodeWidth?` | The width (resolution) to decode to. Higher values decrease performance, use `16` for large lists, otherwise you can increase it to `32`. | number | no | All | yes | +| `decodeHeight?` | The height (resolution) to decode to. Higher values decrease performance, use `16` for large lists, otherwise you can increase it to `32`. | number | no | All | yes | +| `decodePunch?` | Adjusts the contrast of the output image. Tweak it if you want a different look for your placeholders. | number | no | All | yes | +| `decodeAsync?` | Asynchronously decode the Blurhash on a background Thread instead of the UI-Thread. | boolean | no | All | yes | +| `resizeMode?` | Sets the resize mode of the image. (no, `'repeat'` is not supported.) | enum | no | All | yes | +| `onLoadStart?: () => void` | A callback to call when the Blurhash started to decode the given `blurhash` string. | function | no | All | yes | +| `onLoadEnd?: () => void` | A callback to call when the Blurhash successfully decoded the given `blurhash` string and rendered the image to the `` view. | function | no | All | yes | +| `onLoadError?: (message?: string) => void` | A callback to call when the Blurhash failed to load. Use the `message` parameter to get the error message. | function | no | All | yes | +| All `View` props | All properties from the React Native `View`. Use `style.width` and `style.height` for display-sizes. Also, `style.borderRadius` is natively supported on iOS. | ViewProps | no | All | yes | + + +## API + +> [!TIP] The **Platform** column indicates the platform where the properties are supported in the original third-party library. + +> [!TIP] If the value of **HarmonyOS Support** is **yes**, it means that the HarmonyOS platform supports this property; **no** means the opposite; **partially** means some capabilities of this property are supported. The usage method is the same on different platforms and the effect is the same as that of iOS or Android. + +| Name | Description | Type | Required | Platform | HarmonyOS Support | +| ------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -------- | -------- | ----------------- | +| encode() | Encodes the given image URI to a blurhash string | (imageUri: string, componentsX: number, componentsY: number)=> Promise\; | no | All | yes | +| clearCosineCache() | Clears the cosine cache and frees up memory. | ()=> void | no | All | yes | +| getAverageColor) | Gets the average color in a given blurhash string. | (blurhash: string)=> RGB \|undefined; | no | All | yes | +| isBlurhashValid() | Verifies if the given blurhash is valid by checking it's type, length and size flag. | (blurhash: string)=> ReturnType\; | no | All | yes | + +## Known Issues + +## Others + +## License + +This project is licensed under [The MIT License (MIT)](https://github.com/mrousavy/react-native-blurhash/blob/master/LICENSE). \ No newline at end of file diff --git a/doc/zh-cn.md b/doc/zh-cn.md new file mode 100644 index 0000000..80ac1ef --- /dev/null +++ b/doc/zh-cn.md @@ -0,0 +1,442 @@ +> 模板版本：v0.2.2 + +

+

react-native-blurhash

+

+

+ + Supported platforms + + + License + + +

+ + + +> [!TIP] [Github 地址](https://github.com/react-native-oh-library/react-native-blurhash) + +## 安装与使用 + +请到三方库的 Releases 发布地址查看配套的版本信息：[@react-native-oh-tpl/react-native-blurhash Releases](https://github.com/react-native-oh-library/react-native-blurhash/releases)。对于未发布到npm的旧版本，请参考[安装指南](/zh-cn/tgz-usage.md)安装tgz包。 + +进入到工程目录并输入以下命令： + + + + + +#### **npm** + +```bash +npm install @react-native-oh-tpl/react-native-blurhash +``` + +#### **yarn** + +```bash +yarn add @react-native-oh-tpl/react-native-blurhash +``` + + + +下面的代码展示了这个库的基本使用场景： + +> [!WARNING] 使用时 import 的库名不变。 + +```jsx +import React, { useCallback, useMemo, useState } from 'react'; +import { Blurhash } from 'react-native-blurhash'; +import { + ActivityIndicator, + Alert, + SafeAreaView, + StatusBar, + StyleSheet, + Switch, + Text, + TextInput, + TouchableOpacity, + View +} from 'react-native'; + +const COLORS = { + background: '#F5FCFF', + statusBar: 'rgba(100, 0, 100, 0.6)', + textInput: 'rgba(200, 0, 100, 0.5)', + button: 'rgba(200, 0, 100, 0.4)', + switchEnabled: 'rgba(200, 0, 100, 0.5)', + switchDisabled: 'rgba(200, 0, 100, 0.2)', + switchThumb: 'white', + shadow: 'black', +}; +const SWITCH_THUMB_COLORS = { + false: COLORS.switchDisabled, + true: COLORS.switchEnabled, +}; + +const BlurhashDemo: React.FC = (): JSX.Element => { + + //#region State & Props + const [blurhash, setBlurhash] = useState('LHK1gsM,rzD+4-xn,vWT~q=_ixS]'); + const [decodeAsync, setDecodeAsync] = useState(true); + const [encodingImageUri, setEncodingImageUri] = useState( + 'http://gips2.baidu.com/it/u=3150002139,2124277596&fm=3028&app=3028&f=JPEG&fmt=auto?w=2048&h=2048' + ); + const [isEncoding, setIsEncoding] = useState(false); + const [isValiding, setIsVailding] = useState(false); + //#endregion + + //#region Memos + const buttonOpacity = useMemo( + () => (encodingImageUri.length < 5 || isEncoding ? 0.5 : 1), + [encodingImageUri.length, isEncoding], + ); + const encodeButtonStyle = useMemo( + () => [styles.encodeButton, { opacity: buttonOpacity }], + [buttonOpacity], + ); + //#endregion + + //#region Callbacks + const onLoadStart = useCallback(() => { + console.log('onLoadStart called!'); + }, []); + const onLoadEnd = useCallback(() => { + console.log('onLoadEnd called!'); + }, []); + const onLoadError = useCallback((message?: string) => { + console.log(`onLoadError called! Message: ${message}`); + }, []); + const startEncoding = useCallback(async () => { + try { + if (encodingImageUri.length < 5) return; + setIsEncoding(true); + const _blurhash = await Blurhash.encode(encodingImageUri, 4, 3); + setBlurhash(_blurhash); + setIsEncoding(false); + } catch (e: any) { + setIsEncoding(false); + console.warn('Failed to encode!', e); + Alert.alert('Encoding error', e.message); + } + }, [encodingImageUri]); + const isVaild = () => { + console.log(blurhash); + const data = Blurhash.isBlurhashValid(blurhash) + Alert.alert("blurhash is valid? : " + data.isValid) + console.log(data); + } + const CCache = useCallback(() => { + Blurhash.clearCosineCache() + }, []) + //#endregion + + return ( + <> + + + + + + + + + {/* To test if `decodeAsync` really doesn't block the UI thread, you can press this Touchable and see it reacting. */} + + Decode Async: + + + + + {isEncoding ? ( + + ) : ( + Encode + )} + + + + ); +} + +const styles = StyleSheet.create({ + container: { + flex: 1, + justifyContent: 'center', + alignItems: 'center', + backgroundColor: COLORS.background, + }, + blurhashContainer: { + shadowRadius: 3, + shadowColor: COLORS.shadow, + shadowOffset: { + height: 2, + width: 0, + }, + shadowOpacity: 0.4, + overflow: 'visible', + }, + blurhashRadiusMask: { + elevation: 5, + // borderRadius has to be applied to the parent + borderRadius: 5, + overflow: 'hidden', + }, + blurhashImage: { + width: 300, + height: 200, + // Custom styling for width, height, scaling etc here + }, + textInput: { + marginTop: 20, + borderRadius: 5, + borderWidth: 1, + borderColor: COLORS.textInput, + width: '70%', + height: 35, + paddingHorizontal: 20, + textAlign: 'center', + }, + row: { + marginTop: 30, + flexDirection: 'row', + alignItems: 'center', + }, + text: { + fontSize: 16, + marginRight: 15, + }, + encodeButton: { + height: 37, + width: 120, + marginTop: 30, + backgroundColor: COLORS.button, + borderRadius: 10, + paddingVertical: 10, + paddingHorizontal: 35, + justifyContent: 'center', + }, +}); + +export default BlurhashDemo +``` + +## Link + +目前 HarmonyOS 暂不支持 AutoLink，所以 Link 步骤需要手动配置。 + +首先需要使用 DevEco Studio 打开项目里的 HarmonyOS 工程 `harmony` + +### 1.在工程根目录的 `oh-package.json5` 添加 overrides 字段 + +```json +{ + ... + "overrides": { + "@rnoh/react-native-openharmony" : "./react_native_openharmony" + } +} +``` + +### 2.引入原生端代码 + +目前有两种方法： + +1. 通过 har 包引入（在 IDE 完善相关功能后该方法会被遗弃，目前首选此方法）； +2. 直接链接源码。 + +方法一：通过 har 包引入（推荐） + +> [!TIP] har 包位于三方库安装路径的 `harmony` 文件夹下。 + +打开 `entry/oh-package.json5`，添加以下依赖 + +```json +"dependencies": { + "@rnoh/react-native-openharmony": "file:../react_native_openharmony", + "@react-native-oh-tpl/react-native-blurhash": "file:../../node_modules/@react-native-oh-tpl/react-native-blurhash/harmony/blurhash.har" + } +``` + +点击右上角的 `sync` 按钮 + +或者在终端执行： + +```bash +cd entry +ohpm install +``` + +方法二：直接链接源码 + +> [!TIP] 如需使用直接链接源码，请参考[直接链接源码说明](/zh-cn/link-source-code.md) + +### 3.配置 CMakeLists 和引入 BlurhashPackage + +打开 `entry/src/main/cpp/CMakeLists.txt`，添加： + +```diff +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}/../../../oh_modules/@rnoh/react-native-openharmony/src/main/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-oh-tpl/react-native-blurhash/src/main/cpp" ./blurhash) +# 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_blurhash) +# RNOH_END: manual_package_linking_2 + +``` + +打开 `entry/src/main/cpp/PackageProvider.cpp`，添加： + +```diff +#include "RNOH/PackageProvider.h" +#include "generated/RNOHGeneratedPackage.h" +#include "SamplePackage.h" ++ #include "BlurhashPackage.h" + +using namespace rnoh; + +std::vector> PackageProvider::getPackages(Package::Context ctx) { + return { + std::make_shared(ctx), + std::make_shared(ctx), ++ std::make_shared(ctx) + }; +} +``` + +### 4.在 ArkTs 侧引入 BlurhashPackage + +打开 `entry/src/main/ets/RNPackagesFactory.ts`，添加： + +```diff ++ import {BlurhashPackage} from '@react-native-oh-tpl/react-native-blurhash/ts'; + +export function createRNPackages(ctx: RNPackageContext): RNPackage[] { + return [ + new SamplePackage(ctx), ++ new BlurhashPackage(ctx), + ]; +} + +``` + +### 5.运行 + +点击右上角的 `sync` 按钮 + +或者在终端执行： + +```bash +cd entry +ohpm install +``` + +然后编译、运行即可。 + +## 约束与限制 + +### 兼容性 + +要使用此库，需要使用正确的 React-Native 和 RNOH 版本。另外，还需要使用配套的 DevEco Studio 和 手机 ROM。 + +请到三方库相应的 Releases 发布地址查看 Release 配套的版本信息：[@react-native-oh-tpl/react-native-blurhash Releases](https://github.com/react-native-oh-library/react-native-blurhash/releases) + +## 属性 + +> [!TIP] "Platform"列表示该属性在原三方库上支持的平台。 + +> [!TIP] "HarmonyOS Support"列为 yes 表示 HarmonyOS 平台支持该属性；no 则表示不支持；partially 表示部分支持。使用方法跨平台一致，效果对标 iOS 或 Android 的效果。 + +| Name | Description | Type | Required | Platform | HarmonyOS Support | +| ------------------------------------------ | ------------------------------------------------------------ | --------- | -------- | -------- | ----------------- | +| `blurhash` | The blurhash string to use. Example: `LGFFaXYk^6#M@-5c,1J5@[or[Q6.` | string | yes | All | yes | +| `decodeWidth?` | The width (resolution) to decode to. Higher values decrease performance, use `16` for large lists, otherwise you can increase it to `32`. | number | no | All | yes | +| `decodeHeight?` | The height (resolution) to decode to. Higher values decrease performance, use `16` for large lists, otherwise you can increase it to `32`. | number | no | All | yes | +| `decodePunch?` | Adjusts the contrast of the output image. Tweak it if you want a different look for your placeholders. | number | no | All | yes | +| `decodeAsync?` | Asynchronously decode the Blurhash on a background Thread instead of the UI-Thread. | boolean | no | All | yes | +| `resizeMode?` | Sets the resize mode of the image. (no, `'repeat'` is not supported.) | enum | no | All | yes | +| `onLoadStart?: () => void` | A callback to call when the Blurhash started to decode the given `blurhash` string. | function | no | All | yes | +| `onLoadEnd?: () => void` | A callback to call when the Blurhash successfully decoded the given `blurhash` string and rendered the image to the `` view. | function | no | All | yes | +| `onLoadError?: (message?: string) => void` | A callback to call when the Blurhash failed to load. Use the `message` parameter to get the error message. | function | no | All | yes | +| All `View` props | All properties from the React Native `View`. Use `style.width` and `style.height` for display-sizes. Also, `style.borderRadius` is natively supported on iOS. | ViewProps | no | All | yes | + + +## API + +> [!TIP] "Platform"列表示该属性在原三方库上支持的平台。 + +> [!TIP] "HarmonyOS Support"列为 yes 表示 HarmonyOS 平台支持该属性；no 则表示不支持；partially 表示部分支持。使用方法跨平台一致，效果对标 iOS 或 Android 的效果。 + +| Name | Description | Type | Required | Platform | HarmonyOS Support | +| ------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -------- | -------- | ----------------- | +| encode() | Encodes the given image URI to a blurhash string | (imageUri: string, componentsX: number, componentsY: number)=> Promise\; | no | All | yes | +| clearCosineCache() | Clears the cosine cache and frees up memory. | ()=> void | no | All | yes | +| getAverageColor() | Gets the average color in a given blurhash string. | (blurhash: string)=> RGB \|undefined; | no | All | yes | +| isBlurhashValid() | Verifies if the given blurhash is valid by checking it's type, length and size flag. | (blurhash: string)=> ReturnType\; | no | All | yes | + +## 遗留问题 + +## 其他 + +## 开源协议 + +本项目基于 [The MIT License (MIT)](https://github.com/mrousavy/react-native-blurhash/blob/master/LICENSE) ，请自由地享受和参与开源。 \ No newline at end of file