0.7.1 • Published 13 days ago

@gcores/react-native-yidun-quicklogin v0.7.1

Weekly downloads
-
License
Apache 2.0
Repository
-
Last release
13 days ago

号码认证

直连三大运营商,一步校验手机号与当前 SIM 卡号一致性。优化注册/登录/支付等场景验证流程

平台支持(兼容性)

AndroidiOS
适用版本区间:4.4 以上适用版本区间:9 - 14

环境准备

CocoaPods 安装教程

资源引入/集成

npm install @yidun/quickpass-plugin-rn

项目开发配置

旧版本需要在 react-native 工程对应的 android/app/build.gradle 文件的 android 域中添加

repositories {
    flatDir {
        dirs project(':yidun_quickpass-plugin-rn').file('libs')
    }
}

release 包需要添加混淆规则

-dontwarn com.cmic.sso.sdk.**
-keep class com.cmic.sso.**{*;}
-dontwarn com.sdk.**
-keep class com.sdk.** { *;}
-keep class cn.com.chinatelecom.account.**{*;}
-keep public class * extends android.view.View
-keep class com.netease.nis.quicklogin.entity.**{*;}
-keep class com.netease.nis.quicklogin.listener.**{*;}
-keep class com.netease.nis.quicklogin.QuickLogin{
    public <methods>;
    public <fields>;
}
-keep class com.netease.nis.quicklogin.helper.UnifyUiConfig{*;}
-keep class com.netease.nis.quicklogin.helper.UnifyUiConfig$Builder{
     public <methods>;
     public <fields>;
 }
-keep class com.netease.nis.quicklogin.utils.LoginUiHelper$CustomViewListener{
     public <methods>;
     public <fields>;
}
-keep class com.netease.nis.basesdk.**{
    public *;
    protected *;
}

调用示例

export default class App extends Component {
  componentDidMount() {
    NativeModules.QuickLoginPlugin.initQuickLogin('此处填写您申请的业务id');
  }

  handlePressLogin() {
    NativeModules.QuickLoginPlugin.prefetchNumber((success, resultDic) => {
      if (!success) return;

      const token = resultDic.token

      let uiJsonConfig;
      if (Platform.OS==='android') {
        uiJsonConfig = androidConfigJson;
        NativeModules.QuickLoginPlugin.setUiConfig(uiJsonConfig);
        NativeModules.QuickLoginPlugin.login((success, resultDic)=>{
            if (!success) return
            NativeModules.QuickLoginPlugin.closeAuthController();

            fetch('您的后端认证接口', {
                method: 'POST',
                body: JSON.stringify({
                    token,
                    accessToken: resultDic.accessToken
                })
            })
        })
      } else {
        uiJsonConfig = iosConfigJson;
        NativeModules.QuickLoginPlugin.setUiConfig(uiJsonConfig, (success) => {
            if (success) {
                console.log("设置UI成功")
                NativeModules.QuickLoginPlugin.login((success, resultDic)=>{
                    if (!success) return
                    NativeModules.QuickLoginPlugin.closeAuthController();

                    fetch('您的后端认证接口', {
                        method: 'POST',
                        body: JSON.stringify({
                            token,
                            accessToken: resultDic.accessToken
                        })
                    })
                });
            }
        });
      }
    })
  }

  render() {
    return (
      <View>
        <TouchableOpacity onPress={this.handlePressLogin}>
          <View>
            <Text>登录</Text>
          </View>
        </TouchableOpacity>
      </View>
    )
  }
}

更多使用场景请参考 demo

SDK 方法说明

1. 创建对象

代码说明:

import {NativeModules} from 'react-native';
var quichLoginPlugin = NativeModules.QuickLoginPlugin;

2. 初始化

代码说明:

quichLoginPlugin.initQuickLogin('此处填写您申请的业务id');

参数说明:

  • 入参说明:

    参数类型是否必填默认值描述
    businessIdString易盾分配的业务 id

3. 预取号

代码说明:

quichLoginPlugin.prefetchNumber((success, data) => {
  if (success) {
    // TODO: 预取号成功处理,可以进行授权页面配置和调起授权页
  } else {
    // TODO: 预取号失败处理
  }
})

参数说明:

  • 回调参数说明:

    回调参数类型描述
    successBoolean预取号成功
    data.tokenString如果预取号成功则返回易盾 token,否则无此字段
    data.descString如果预取号失败,返回错误详情, 否则无此字段

4. 是否具备一键登录能力

代码说明:

quichLoginPlugin.checkVerifyEnable((success) => {
  if (success) {
    // TODO: 具备一键登录能力
  } else {
    // TODO: 不具备一键登录能力
  }
})

参数说明:

  • 回调参数说明:

    回调参数类型描述
    successBoolean是否具备一键登录能力

5. 自定义授权页面

代码说明:

NativeModules.QuickLoginPlugin.setUiConfig(config, (success) => {
    if (success) {
        // TODO:设置UI成功,可以进行取号接口调用
    } else {
    }
});

参数说明:

  • 基础参数:

    参数类型是否必填默认值描述
    configObject自定义配置项
    successBoolean设置授权页面 UI 成功

config 可配置项说明: android 版

开发者不得通过任何技术手段,将授权页面的隐私栏、手机掩码号、供应商品牌内容隐藏、覆盖 网易易盾与运营商会对应用授权页面进行审查,若发现上述违规行为,网易易盾有权将您的一键登录功能下线

安卓规范示意图 自定义展示图

状态栏
配置项说明
statusBarColor:String设置状态栏背景颜色,十六进制 RGB 值,如 "#ff0000"
isStatusBarDarkColor:boolean设置状态栏字体图标颜色是否为暗色(黑色)
导航栏
配置项说明
navBackIcon:String导航栏图标,图标放在 android drawable 下,这里配置图标名字
navBackIconWidth:int设置导航栏返回图标的宽度,单位 dp
navBackIconHeight:int设置导航栏返回图标的高度,单位 dp
navBackIconGravity:int设置导航栏返回图标位置,居左 3,居右 5,默认居左
isHideBackIcon:boolean设置是否隐藏导航栏返回按钮
navBackgroundColor:String设置导航栏背景颜色,十六进制 RGB 值,如 "#ff0000"
navHeight:int设置导航栏高度,单位 dp
navTitle:String设置导航栏标题
navTitleColor:String设置导航栏标题颜色,十六进制 RGB 值,如 "#ff0000"值
navTitleSize:int设置导航栏标题大小,单位 sp
isNavTitleBold:boolean设置导航栏标题是否为粗体
isHideNav:boolean设置是否隐藏导航栏
应用 Logo
配置项说明
logoImg:String应用 logo 图标,图标放在 android drawable 下,这里配置图标名字
logoWidth:int设置应用 logo 宽度,单位 dp
logoHeight:int设置应用 logo 高度,单位 dp
logoTopYOffset:int设置 logo 顶部 Y 轴偏移,单位 dp
logoBottomYOffset:int设置 logo 距离屏幕底部偏移,单位 dp
logoXOffset:int设置 logo 水平方向的偏移,单位 dp
isHideLogo:boolean设置是否隐藏 logo
手机掩码
配置项说明
maskNumberColor:String设置手机掩码颜色,十六进制 RGB 值,如 "#ff0000"
maskNumberSize:int设置手机掩码字体大小,单位 px
maskNumberXOffset:int设置手机掩码水平方向的偏移,单位 dp
maskNumberDpSize:int设置手机掩码字体大小,单位 dp
maskNumberTopYOffset:int设置手机掩码顶部 Y 轴偏移,单位 dp
maskNumberBottomYOffset:int设置手机掩码距离屏幕底部偏移,单位 dp
认证品牌
配置项说明
sloganSize:int设置认证品牌字体大小,单位 px
sloganDpSize:int设置认证品牌字体大小,单位 dp
sloganColor:String设置认证品牌颜色,十六进制 RGB 值,如 "#ff0000"
sloganTopYOffset:int设置认证品牌顶部 Y 轴偏移,单位 dp
sloganBottomYOffset:int设置认证品牌距离屏幕底部偏移,单位 dp
sloganXOffset:int设置认证品牌水平方向的偏移,单位 dp
登录按钮
配置项说明
loginBtnText:String设置登录按钮文本
loginBtnTextSize:int设置登录按钮文本字体大小,单位 px
loginBtnTextDpSize:int设置登录按钮文本字体大小,单位 dp
loginBtnTextColor:String设置登录按钮文本颜色,十六进制 RGB 值,如 "#ff0000"
loginBtnWidth:int设置登录按钮宽度,单位 dp
loginBtnHeight:int设置登录按钮高度,单位 dp
loginBtnBackgroundRes:String设置登录按钮背景图标,图标放在 android drawable 下,这里配置图标名字
loginBtnTopYOffset:int设置登录按钮顶部 Y 轴偏移,单位 dp
loginBtnBottomYOffset:int设置登录按钮距离屏幕底部偏移,单位 dp
loginBtnXOffset:int设置登录按钮水平方向的偏移,单位 dp
隐私协议
配置项说明
privacyTextColor:String设置隐私栏文本颜色,不包括协议 ,如若隐私栏协议文案为:登录即同意《中国移动认证条款》且授权 QuickLogin 登录, 则该 API 对除协议‘《中国移动认证条款》’区域外的其余文本生效
privacyProtocolColor:String设置隐私栏协议颜色 。例如:登录即同意《中国移动认证条款》且授权 QuickLogin 登录 , 则该 API 仅对‘《中国移动认证条款》’文案生效
privacySize:int设置隐私栏区域字体大小,单位 px
privacyDpSize:int设置隐私栏区域字体大小,单位 dp
privacyTopYOffset:int设置隐私栏顶部 Y 轴偏移,单位 dp
privacyBottomYOffset:int设置隐私栏距离屏幕底部偏移,单位 dp
privacyTextMarginLeft:int设置隐私栏复选框和文字内边距,单位 dp
privacyMarginLeft:int设置隐私栏水平方向的偏移,单位 dp
privacyMarginRight:int设置隐私栏右侧边距,单位 dp
privacyState:boolean设置隐私栏协议复选框勾选状态,true 勾选,false 不勾选
isHidePrivacyCheckBox:boolean设置是否隐藏隐私栏勾选框
isPrivacyTextGravityCenter:boolean设置隐私栏文案换行后是否居中对齐,如果为 true 则居中对齐,否则左对齐
checkBoxGravity:int设置隐私栏勾选框与文本协议对齐方式,可选择顶部(48),居中(17),底部(80)等
checkBoxWith:int设置隐私栏复选框宽度,单位 dp
checkBoxHeight:int设置隐私栏复选框高度,单位 dp
checkedImageName:string设置隐私栏复选框选中时的图片资源,图标放在 android drawable 下,这里配置图标名字
unCheckedImageName:String设置隐私栏复选框未选中时的图片资源,图标放在 android drawable 下,这里配置图标名字
privacyTextStart:String设置隐私栏声明部分起始文案 。如:隐私栏声明为"登录即同意《隐私政策》和《中国移动认证条款》且授权易盾授予本机号码",则可传入"登录即同意"
isHidePrivacySmh:boolean是否隐藏运营商协议书名号
protocolText:String设置隐私栏协议文本
protocolLink:String设置隐私栏协议链接
protocol2Text:String设置隐私栏协议 2 文本
protocol2Link:String设置隐私栏协议 2 链接
protocol3Text:String设置隐私栏协议 3 文本
protocol3Link:String设置隐私栏协议 3 链接
privacyTextEnd:String设置隐私栏声明部分尾部文案。如:隐私栏声明为"登录即同意《隐私政策》和《中国移动认证条款》且授权易盾授予本机号码",则可传入"且授权易盾授予本机号码"
协议详情 Web 页面导航栏
配置项说明
protocolNavTitle:String设置协议 Web 页面导航栏标题,如果需要根据不同运营商设置不同标题
protocolNavBackIcon:String设置协议 Web 页面导航栏返回图标,图标放在 android drawable 下,这里配置图标名字
protocolNavColor:String设置协议 Web 页面导航栏颜色
protocolNavHeight:int设置协议 Web 页面导航栏高度
protocolNavTitleSize:int设置协议 Web 页面导航栏标题大小,单位 px
protocolNavTitleDpSize:int设置协议 Web 页面导航栏标题大小,单位 dp
protocolNavBackIconWidth:int设置协议 Web 页面导航栏返回按钮宽度,单位 dp
protocolNavBackIconHeight:int设置协议 Web 页面导航栏返回按钮高度,单位 dp
其他
配置项说明
backgroundImage:String设置登录页面背景,图片放在 android drawable 下,这里配置图片名字
backgroundGif:String设置登录页面背景为 Gif,Gif 资源需要放置到 android drawable 目录下,传入资源名称即可
backgroundVideo:String设置登录页面背景为视频,视频放在 android res/raw 文件夹下,这里配置视频文件名字。必须同时配置 backgroundVideo
backgroundVideoImage:String设置视频背景时的预览图,图片放在 android drawable 下,这里配置图标名字,配合 backgroundVideo 使用
enterAnimation:String设置授权页进场动画,enterAnimation 进场动画 xml 无后缀文件名。放置在 android anim 目录下
exitAnimation:String设置授权页退出动画,exitAnimation 进场动画 xml 无后缀文件名。放置在 android anim 目录下
isLandscape:boolean是否横屏
isDialogMode:boolean是否弹窗模式
dialogWidth:int授权页弹窗宽度,单位 dp
dialogHeight:int授权页弹窗高度,单位 dp
dialogX:int授权页弹窗 X 轴偏移量,以屏幕中心为原点
dialogY:int授权页弹窗 Y 轴偏移量,以屏幕中心为原点
isBottomDialog:boolean授权页弹窗是否贴于屏幕底部true:显示在屏幕底部,dialogY 失效 false:不显示在屏幕底部,以 dialogY 参数为准
isProtocolDialogMode:boolean协议详情页是否开启弹窗模式
isPrivacyDialogAuto:boolean协议未勾选弹窗点击是否自动登录
isShowPrivacyDialog:boolean是否显示协议未勾选默认弹窗
privacyDialogText:String协议未勾选弹窗自定义 message
privacyDialogSize:float协议未勾选弹窗文本字体大小
自定义 view
配置项说明
widgets:JsonArray自定义 view 数组
 ∟ viewId:String控件 id
 ∟ type:String控件类型,可选值为 TextView、Button、ImageView
 ∟ top:int控件距离顶部的偏移,单位 dp
 ∟ left:int控件距离左侧的偏移,单位 dp
 ∟ right:int控件距离右侧的偏移,单位 dp
 ∟ bottom:int控件距离底部的偏移,和 top 互斥,单位 dp
 ∟ width:int控件宽度,单位 dp
 ∟ height:int控件高度,单位 dp
 ∟ text:String控件文本,单位 dp
 ∟ font:int控件文本大小,单位 sp
 ∟ textColor:String控件文本颜色,十六进制颜色码
 ∟ clickable:boolean控件是否可点击,单位 sp
 ∟ backgroundColor:String控件背景颜色,十六进制颜色码
 ∟ backgroundImgPath:String控件背景图片,图片放在 android drawable 下,这里配置图片名字
 ∟ positionType:int添加控件的位置类型,1 表示位于导航栏下方的 body 部分

config 可配置项说明: iOS 版

设计规范概览 开发者不得通过任何技术手段,将授权页面的隐私栏、手机掩码号、供应商品牌内容隐藏、覆盖 网易易盾与运营商会对应用授权页面进行审查,若发现上述违规行为,网易易盾有权将您的一键登录功能下线 iOS设计规范 自定义展示图

基础配置
属性说明
currentVC当前 VC,注意:要用一键登录这个值必传
rootViewController设置应用的根控制器,用作隐私协议的弹出,如果不传,则使用默认值
presentDirectionType设置授权页的弹出方式NTESPresentDirectionPush 表示从右边弹出 NTESPresentDirectionPresent 表示从底部弹出
backgroundColor设置授权页面背景颜色
authWindowPop设置窗口类型NTESAuthWindowPopFullScreen 表示全屏模式 NTESAuthWindowPopCenter 表示窗口在屏幕的中间 NTESAuthWindowPopBottom 表示窗口在屏幕的底部(不支持横屏)
faceOrientation设置授权页面方向UIInterfaceOrientationUnknown 表示设备方向未知UIInterfaceOrientationPortrait 表示设置保持直立UIInterfaceOrientationPortraitUpsideDown 表示设备上下颠倒 UIInterfaceOrientationLandscapeLeft 表示设备向左旋转 UIInterfaceOrientationLandscapeRight 表示设备向右旋转
bgImage设置授权转背景图片,例如 :model.bgImage = UIImage imageNamed:
contentMode设置背景图片显示模式
modalPresentationStyle设置 present 控制器的展示方式。如果弹窗模式下。modalPresentationStyle 为 UIModalPresentationOverFullScreen
转场动画
属性说明
modalTransitionStyle设置授权转场动画 UIModalTransitionStyleCoverVertical 表示下推UIModalTransitionStyleFlipHorizontal 表示翻转UIModalTransitionStyleCrossDissolve 表示淡出
自定义控件
属性说明
customViewBlock设置授权界面自定义控件 View 的 block例如 :model.customViewBlock = ^(UIView * _Nullable customView) { /// customView 就是授权页的 view,添加控件到 customView 即可}
背景设置视频
属性说明
localVideoFileName设置视频本地名称 例如 xx.mp4*
isRepeatPlay设置是否重复播放视频,YES 表示重复播放,NO 表示不重复播放
videoURL设置网络视频的地址
videoViewBlock设置自定义视频控件,例如:model.videoViewBlock = ^(UIView * _Nullable videoView) { // videoView 放置视频的控件,videoView addSubview:视频}
背景设置 Gif
属性说明
animationRepeatCount设置动画重复的次数 -1 无限重复
animationImages设置图片数组,例如:@UIImage imageNamed:@"pic_yjdl"
animationDuration设置动画的时长
状态栏
属性说明
statusBarStyle设置状态栏样式 iOS13 之前 UIStatusBarStyleDefault 表示文字黑色,UIStatusBarStyleLightContent 表示文字白色 iOS13 之后 UIStatusBarStyleDefault 表示自动选择黑色或白色,UIStatusBarStyleDarkContent 表示文字黑色,UIStatusBarStyleLightContent 表示文字白色
导航栏
属性说明
navBarHidden导航栏是否隐藏
navBgColor设置导航栏背景颜色
navText设置导航栏标题
navTextFont设置导航栏标题字体大小
navTextColor设置导航栏标题字体颜色
navTextHidden设置导航栏标题是否隐藏,默认不隐藏
navReturnImg设置导航返回图标,例如:UIImage imageNamed:@"back-1"
navReturnImgLeftMargin设置导航返回图标距离屏幕左边的距离,默认 0
navReturnImgBottomMargin设置导航返回图标距离屏幕底部的距离,默认 0
navReturnImgWidth设置导航返回图标的宽度,默认 44
navReturnImgHeight设置导航返回图标的高度 , 默认 44
navControl设置导航栏右侧自定义控件 传非 UIBarButtonItem 对象
customNavBlock设置导航栏上自定义控件, 可在导航栏上自由的添加自己想要的控件例如: model.customNavBlock = ^(UIView * _Nullable customNavView) {/// 添加控件到 customNavView 上};
应用 Logo
属性说明
logoIconName设置 logo 图片, 例如 : model.logoImg = UIImage imageNamed:@"logo1"
logoWidth设置 logo 图片宽度
logoHeight设置 logo 图片高度
logoOffsetTopY设置 logo 图片沿 Y 轴偏移量, logoOffsetTopY 为距离屏幕顶部的距离 ,默认为 20
logoOffsetX设置 logo 图片沿 X 轴偏移量,logoOffsetX = 0 居中显示
logoHidden设置 logo 图片是否隐藏,默认不隐藏
手机掩码
属性说明
numberColor设置手机号码字体颜色
numberFont设置手机号码字体大小, 默认 18
numberOffsetTopY设置手机号码沿 Y 轴偏移量, numberOffsetTopY 为距离屏幕顶部的距离 ,默认为 100
numberOffsetX设置 logo 图片沿 X 轴偏移量,logoOffsetX = 0 居中显示
numberHeight设置手机号码框的高度 默认 27
numberBackgroundColor设置手机号码的背景颜色
numberCornerRadius设置手机号码的控件的圆角
numberLeftContent设置手机号码的左边描述内容,默认为空
numberRightContent设置手机号码的右边描述内容,默认为空色
认证品牌
属性说明
brandColor设置认证服务品牌文字颜色
brandBackgroundColor设置认证服务品牌背景颜色
brandFont设置认证服务品牌文字字体 默认 12
brandWidth设置认证服务品牌的宽度, 默认 200
brandHeight设置认证服务品牌的高度, 默认 16
brandOffsetX设置认证服务品牌 X 偏移量 ,brandOffsetX = 0 居中显示
brandOffsetTopY设置认证服务品牌 Y 偏移量, brandOffsetTopY 为距离屏幕顶部的距离 ,默认为 150
brandHidden设置是否隐藏认证服务品牌,默认显示
登录按钮
属性说明
logBtnText设置登录按钮文本
logBtnTextFont设置登录按钮字体大小
logBtnTextColor设置登录按钮文本颜色
logBtnOffsetTopY设置登录按钮 Y 偏移量 ,logBtnOffsetTopY 为距离屏幕顶部的距离 ,默认为 200
logBtnRadius设置登录按钮圆角,默认 8
logBtnUsableBGColor设置登录按钮背景颜色
logBtnEnableImg设置登录按钮可用状态下的背景图片
logBtnHighlightedImg登录按钮高亮状态下的背景图片
logBtnOriginLeft登录按钮的左边距 ,横屏默认 40 ,竖屏默认 260
logBtnOriginRight设置登录按钮的左边距,横屏默认 40 ,竖屏默认 260
logBtnHeight设置登录按钮的高度,默认 44
startPoint设置设置渐变颜色方向,左上点为(0,0), 右下点为(1,1)
endPoint设置设置渐变颜色方向,左上点为(0,0), 右下点为(1,1)
locations设置颜色变化点,取值范围 0.0~1.0
colors设置渐变色数组,需要转换为 CGColor 颜色
隐私协议

若勾选框需要展示,请务必设置勾选框的选中态图片与未选中态图片 协议未勾选时,登录按钮是否可点击可以自定义设置,弹窗提示的样式也可以自定义

属性说明
prograssHUDBlock设置协议未勾选时,自定义弹窗样式
loadingViewBlock设置自定义 Loading View, 点击登录按钮时,可自定义加载进度样式
uncheckedImg设置复选框未选中时图片
checkedImg设置复选框选中时图片
checkboxWH设置复选框大小(只能正方形) ,默认 12
privacyState设置复选框默认状态 默认:NO
checkBoxAlignment设置隐私条款 check 框位置 NSCheckBoxAlignmentTop 表示相对协议顶对齐NSCheckBoxAlignmentCenter 表示相对协议中对齐 NSCheckBoxAlignmentBottom 表示相对协议下对齐 默认顶对齐
checkedSelected设置复选框勾选状态,YES:勾选,NO:取消勾选状态
checkBoxMargin设置复选框距离隐私条款的边距 默认 8
appPrivacyOriginLeftMargin设置隐私条款距离屏幕左边的距离 默认 60
appPrivacyOriginRightMargin设置隐私条款距离屏幕右边的距离 默认 40
appPrivacyOriginBottomMargin设置隐私条款距离屏幕的距离 默认 40
privacyNavReturnImg设置用户协议界面,导航栏返回图标,默认用导航栏返回图标
appPrivacyText设置隐私的内容模板:全句可自定义但必须保留"《默认》"字段表明 SDK 默认协议,否则设置不生效。必设置项(参考 SDK 的 demo)appPrivacyText 设置内容:登录并同意《默认》和易盾协议 1、网易协议 2 登录并支持一键登录,展示:登录并同意中国移动条款协议和易盾协议 1、网易协议 2 登录并支持一键登录
appFPrivacyText设置开发者隐私条款协议名称(第一个协议)
appFPrivacyURL设置开发者隐私条款协议 url(第一个协议)
appSPrivacyText设置开发者隐私条款协议名称(第二个协议)
appSPrivacyURL设置开发者隐私条款协议 url(第二个协议)
shouldHiddenPrivacyMarks设置是否隐藏"《默认》" 两边的《》,默认不隐藏
privacyColor设置隐私条款名称颜色
privacyFont设置隐私条款字体的大小
protocolColor设置协议条款协议名称颜色
appPrivacyLineSpacing设置隐私协议的行间距, 默认是 1
appPrivacyWordSpacing设置隐私协议的字间距, 默认是 0
progressColor设置用户协议界面,进度条颜色
弹窗模式
属性说明
popBackgroundColor设置窗口模式的背景颜色
authWindowWidth设置弹窗的宽度,竖屏状态下默认是 300,横屏状态下默认是 335
authWindowHeight设置弹窗高度,竖屏状态下默认是 335, 横屏状态下默认是 300 ⚠️ 底部半屏弹窗模式的高度可通过修改 authWindowHeight,调整高度 默认 335pt
closePopImg设置弹窗模式下关闭按钮的图片,⚠️(必传)
closePopImgWidth设置弹窗模式下关闭按钮图片的宽度 默认 20*
closePopImgHeight设置弹窗模式下关闭按钮图片的高度 默认 20
closePopImgOriginY设置关闭按钮距离顶部的距离,默认距离顶部 10,距离 = 10 + closePopImgOriginY
closePopImgOriginX设置关闭按钮距离父视图右边的距离,默认距离为 10,距离 = 10 + closePopImgOriginX
authWindowCenterOriginY设置居中弹窗沿 Y 轴移动的距离。例如 :authWindowCenterOriginY = 10 表示中间点沿 Y 轴向下偏移 10 个像素
authWindowCenterOriginX设置居中弹窗沿 X 轴移动的距离。例如 :authWindowCenterOriginX = 10 表示中间点沿 X 轴向右偏移 10 个像素
popCenterCornerRadius设置居中弹窗模式下,弹窗的圆角,默认圆角为 16
popBottomCornerRadius设置底部弹窗模式下,弹窗的圆角,默认圆角为 16,注:只可修改顶部左右二边的值
isOpenSwipeGesture设置底部弹窗模式下,是否开启轻扫手势,向下轻扫关闭弹窗。默认关闭
点击事件的回调
属性说明
backActionBlock设置返回按钮点击事件回调,例如:model.backActionBlock = ^{NSLog(@"点击了返回按钮");}
closeActionBlock设置弹窗模式下关闭事件的回调,例如:model.closeActionBlock = ^{NSLog(@"点击了关闭按钮")}
loginActionBlock设置登录按钮点击事件回调,例如:model.loginActionBlock = ^{NSLog(@"点击了登录按钮")}
checkActionBlock设置复选框点击事件回调,isChecked 等于 YES 选中复选框; isChecked 等于 NO 取消复选框。例如:model.checkActionBlock = ^(BOOL isChecked) {}
privacyActionBlock设置协议点击事件回调 privacyType 等于 0 表示点击默认协议 privacyType 等于 1 表示点击第 1 个协议 privacyType 等于 2 表示点击第 2 个协议 例如:model.privacyActionBlock = ^(int privacyType) {}
pageCustomBlock设置协议点击事件回调,不会跳转到默认的协议页面。开发者可以在回调里,自行跳转到自定义的协议页面

6. 调起授权页面

代码说明:

quichLoginPlugin.login((success, data) => {
  if (success) {
    // TODO: 授权成功处理,可以进行关闭授权页、服务端验证等
    NativeModules.QuickLoginPlugin.closeAuthController();
  } else {
    // TODO: 授权失败处理
  }
})

参数说明:

  • 回调参数说明:

    回调参数类型描述
    successBoolean授权是否成功
    data.accessTokenString如果取号成功返回运营商授权码,否则无此字段
    data.descString如果取号失败,返回的错误详情, 否则返回"取号成功

7. 事件监听

代码说明:

const emitter = new NativeEventEmitter(NativeModules.QuickLoginPlugin)
emitter.addListener('RNQuickLogin', (value) => {
  // TODO: 处理监听事件
})

value 是一个 Map ,里面包含各种 key 和对应的值

  • iOS value 值说明:

    回调参数类型描述
    value.actionStringauthViewDidLoad 表示正在加载授权页authViewWillAppear 表示授权页已经出现 authViewWillDisappear 表示授权页将要消失 authViewDidDisappear 表示授权页已经消失authViewDealloc 表示授权页销毁 appDPrivacy 表示点击了默认协议appFPrivacy 表示点击了议第一个协议点击 appSPrivacy 表示点击了第二个协议 loginAction 表示点击了登录按钮,data.checked = true 表示在点击登录按钮时复选框选已选中反之 checkedAction 表示点击了复选框,data.checked = true 表示复选框已选中反之
  • Android value 值说明:

    回调参数类型描述
    value.viewIdString自定义 view 点击,返回自定义 view 的 id
    value.lifecycleStringonCreate - 页面创建,onStart - 页面已开始活动,onResume - 页面展示,onPause - 页面非活动状态,onStop - 页面已停止,onDestroy - 页面销毁
    value.clickViewTypeStringprivacy - 隐私协议点击事件,checkbox - 复选框点击事件(含 isCheckboxChecked: 0/1),loginButton - 登录按钮点击事件(含 isCheckboxChecked: 0/1),leftBackButton - 左上角返回按钮点击事件
    value.isCheckboxCheckedString协议复选框的值,仅在复选框事件和登录按钮点击事件中存在

8. 关闭授权页面

代码说明:

quichLoginPlugin.closeAuthController()

9. 本机校验

在初始化之后执行,本机校验和一键登录可共用初始化,本机校验界面需自行实现

代码说明:

quichLoginPlugin.verifyPhoneNumber(String phoneNumber,(success, data) => {
  if (success) {
    // TODO: 本机校验成功处理
  } else {
    // TODO: 本机校验失败处理
  }
})

参数说明:

  • 入参说明:

    参数类型是否必填默认值描述
    phoneNumberString待校验手机号
  • 回调参数说明:

    回调参数类型描述
    successBoolean授权是否成功
    data.accessTokenString如果本机校验返回运营商授权码,否则无此字段
    data.descString如果本机校验失败,返回的错误详情, 否则返回"本机校验成功
0.7.1

13 days ago

0.7.0

13 days ago

0.6.5

2 months ago

0.6.4

2 months ago

0.6.3

10 months ago

0.6.2

1 year ago

0.6.1

1 year ago

0.5.8

2 years ago

0.5.7

2 years ago

0.6.0

1 year ago

0.5.6

2 years ago

0.5.5

2 years ago

0.3.9

2 years ago

0.5.4

2 years ago

0.3.6

2 years ago

0.5.3

2 years ago

0.3.5

2 years ago

0.3.8

2 years ago

0.3.7

2 years ago

0.5.0

2 years ago

0.4.1

2 years ago

0.4.0

2 years ago

0.5.2

2 years ago

0.5.1

2 years ago

0.3.4

2 years ago

0.3.3

2 years ago

0.3.2

2 years ago

0.3.1

2 years ago

0.3.0

2 years ago

0.2.0

2 years ago

0.1.7

2 years ago

0.1.6

2 years ago

0.1.5

2 years ago

0.1.4

2 years ago

0.1.3

2 years ago

0.1.2

2 years ago

0.1.1

2 years ago

0.1.0

2 years ago