Skip to content

Latest commit

 

History

History
216 lines (142 loc) · 8.9 KB

react-native-apple-authentication.md

File metadata and controls

216 lines (142 loc) · 8.9 KB

模板版本：v0.2.2

react-native-apple-authentication

Supported platforms License

[!TIP] Github 地址

安装与使用

请到三方库的 Releases 发布地址查看配套的版本信息：@react-native-oh-library/react-native-apple-authentication Releases 。对于未发布到npm的旧版本，请参考安装指南安装tgz包。

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

npm

npm install @react-native-oh-tpl/react-native-apple-authentication

yarn

yarn add @react-native-oh-tpl/react-native-apple-authentication

配置用于 Web 的“通过 Apple 登录”

首先需要进行客户端id配置：Initial Development Environment Setup

然后需要进行服务设置：Services setup

Apple官方配置说明：Configure Sign in with Apple for the web

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

[!WARNING] 使用时 import 的库名不变。

import React from 'react';
import { appleAuthHarmony, AppleButton } from '@invertase/react-native-apple-authentication';

const AppleAuthenticationDemo: React.FC = (): JSX.Element => {
    return (
        <>
            <AppleButton
                onPress={async () => {
                    appleAuthHarmony.configure({
                        // 以下配置请参考原库AppleId登录文档:
                        // https://github.com/invertase/react-native-apple-authentication/blob/main/docs/INITIAL_SETUP.md
                        // https://github.com/invertase/react-native-apple-authentication/blob/main/docs/ANDROID_EXTRA.md
                        clientId: 'com.example.client', 
                        redirectUri: 'https://example.com'
                    })
                    const singInRes = await appleAuthHarmony.signIn()
                    console.log(singInRes)
                }}
            />
        </>
    )
}

export default AppleAuthenticationDemo;

使用 Codegen

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

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",
    "@react-native-oh-tpl/react-native-apple-authentication": "file:../../node_modules/@react-native-oh-tpl/react-native-apple-authentication/harmony/react-native-apple-authentication.har"
  }

点击右上角的 sync 按钮

或者在终端执行：

cd entry
ohpm install

方法二：直接链接源码

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

3.在 ArkTs 侧引入 RNAppleAuthPackage

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

  ...
+ import { RNAppleAuthPackage } from '@react-native-oh-tpl/react-native-apple-authentication';

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

4.运行

点击右上角的 sync 按钮

或者在终端执行：

cd entry
ohpm install

然后编译、运行即可。

约束与限制

兼容性

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

请到三方库相应的 Releases 发布地址查看 Release 配套的版本信息：@react-native-oh-library/react-native-apple-authentication Releases。

属性

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

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

AppleButton：Apple身份验证按钮组件。

Name Description Type Required Platform HarmonyOS Support
style 按钮样式 StyleProp< ViewStyle > no all yes
textStyle 按钮内文字样式 StyleProp< TextStyle > no all yes
cornerRadius 按钮边框圆角弧度 number no all yes
buttonStyle 按钮样式(预设枚举) AppleButtonStyle no all yes
buttonType 按钮类型(预设枚举) AppleButtonType no all yes
onPress 按钮点击事件 () => void yes all yes
leftView 按钮内左侧图标 ReactNode no all yes
buttonText 按钮内文字内容 string no all yes

API

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

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

appleAuthHarmony：Apple身份验证对象，包含2个方法。

Name Description Type Required Platform HarmonyOS Support
configure 配置 Apple 身份验证的信息，此接口必须在 signIn 之前调用 (Config) => void no all yes
signIn 弹出 webview 以进行 Apple 身份验证 () => Promise< SigninResponse > no all no

其他

遗留问题

  • 由于 Apple 开发者账户验证问题，HarmonyOS暂无法实现的接口：issue#1

开源协议

本项目基于 Apache License 2.0 ，请自由地享受和参与开源。