Skip to content

Latest commit

 

History

History
211 lines (165 loc) · 13.6 KB

File metadata and controls

211 lines (165 loc) · 13.6 KB

iOS

JVerifyUIConfig 配置元素说明

注意:参数为图片的值都为 iOS 图片资源名字。

授权界面UI配置基类。以下是属性说明:

  • 授权页面设置
参数名称 参数类型 参数说明
authPageBackgroundImage String 授权界面背景图片
autoLayout BOOL 是否使用autoLayout,默认 YES,
shouldAutorotate BOOL 是否支持自动旋转 默认 YES
dismissAnimationFlag BOOL 关闭授权页是否有动画。默认 YES,有动画。参数仅作用于以下两种情况:1、一键登录接口设置登录完成后,自动关闭授权页 2、用户点击授权页关闭按钮,关闭授权页
authPageBackgroudVideo Dictionary 授权界面背景视频 需填以下两字段: 1、"videoPath":String类型,视频路径支持在线url或者本地视频路径, 2、"videoPlaceHolderImagePath":String类型,视频未准备好播放时的占位图片名称}
modalTransitionStyle String 授权页弹出方式 可填参数:"CoverVertical"、"FlipHorizontal"、"CrossDissolve"、"PartialCurl" , 弹窗模式下不支持 "PartialCurl"
  • 导航栏
参数名称 参数类型 参数说明
navCustom BOOL 是否隐藏导航栏(适配全屏图片)
navColor int 导航栏颜色
navText String,int,int 导航栏标题[文字,文字颜色,文字大小]
navReturnImg String 导航返回图标
prefersStatusBarHidden BOOL *竖屏情况下,是否隐藏状态栏。默认 NO.在项目的Info.plist文件里设置UIViewControllerBasedStatusBarAppearance 为 YES.注意:弹窗模式下无效,是否隐藏由外部控制器控制
navTransparent BOOL 导航栏是否透明,默认不透明。此参数和navBarBackGroundImage冲突,应避免同时使用
navReturnHidden BOOL 导航栏默认返回按钮隐藏,默认不隐藏
navDividingLineHidden BOOL 导航栏分割线是否隐藏,默认隐藏
navBarBackGroundImage String 导航栏背景图片.此参数和 navTransparent 冲突,应避免同时使用
  • LOGO
参数名称 参数类型 参数说明
logoImg String LOGO 图片
logoWidth float LOGO 图片宽度
logoHeight float LOGO 图片高度
logoOffsetY float LOGO 图片偏移量
logoHidden BOOL LOGO 图片隐藏
logoConstraints 数组[float,float,float,float] 竖屏方向上,logo相对于整个授权页根视图,布局约束。例如:[centerX,centerY,width,heigt] 意味着 (logo相对屏幕中心的x轴偏移量,logo相对屏幕中心的y轴偏移量,logo宽度,logo高度)
logoHorizontalConstraints 数组 横屏方向上,logo相对于整个授权页根视图,布局约束。例如:[centerX,centerY,width,heigt] 意味着 (logo相对屏幕中心的x轴偏移量,logo相对屏幕中心的y轴偏移量,logo宽度,logo高度)
  • 登录按钮
参数名称 参数类型 参数说明
logBtnText String 登录按钮文本
logBtnOffsetY float 登录按钮Y偏移量
logBtnTextColor int 登录按钮文本颜色
logBtnImgs String,String,String 登录按钮背景图片添加到数组(顺序如下) @[激活状态的图片,失效状态的图片,高亮状态的图片]
logBtnConstraints 数组[float,float,float,float] 竖屏方向上,登录按钮相对于整个授权页根视图,布局约束。例如:[centerX,centerY,width,heigt] 意味着 (登录按钮相对屏幕中心的x轴偏移量,登录按钮相对屏幕中心的y轴偏移量,登录按钮宽度,登录按钮高度)
logBtnHorizontalConstraints 数组[float,float,float,float] 横屏方向上,登录按钮相对于整个授权页根视图,布局约束。例如:[centerX,centerY,width,heigt] 意味着 (登录按钮相对屏幕中心的x轴偏移量,登录按钮相对屏幕中心的y轴偏移量,登录按钮宽度,登录按钮高度)
  • 手机号码
参数名称 参数类型 参数说明
numberColor int 手机号码字体颜色
numberSize float 手机号码字体大小
numFieldOffsetY float 号码栏 Y 偏移量
numberConstraints 数组[float,float,float,float] 竖屏方向上,手机号码栏相对于整个授权页根视图,布局约束。例如:[centerX,centerY,width,heigt] 意味着 (手机号码栏相对屏幕中心的x轴偏移量,手机号码栏相对屏幕中心的y轴偏移量,手机号码栏宽度,手机号码栏高度)
numberHorizontalConstraints 数组[float,float,float,float] 横屏方向上,手机号码栏相对于整个授权页根视图,布局约束。例如:[centerX,centerY,width,heigt] 意味着 (手机号码栏相对屏幕中心的x轴偏移量,手机号码栏相对屏幕中心的y轴偏移量,手机号码栏宽度,手机号码栏高度)
  • checkBox
参数名称 参数类型 参数说明
uncheckedImg String checkBox 未选中时图片
checkedImg String checkBox 选中时图片
checkViewHidden BOOL checkBox 是否隐藏,默认不隐藏
privacyState BOOL 隐私条款 check 框默认状态 默认:NO
privacyCheckToastMessage String checkBox 未选中时点击登录按钮弹出提示框的提示语:当此参数存在时,checkBox 未选中,登录按钮可点击,且点击后会弹窗提醒用户勾选,提示语为该参数的设置值;该值未设置时,checkBox 未选中,登录按钮不可点击。
checkViewConstraints 数组[float,float,float,float] 竖屏方向上,checkBox相对于整个授权页根视图,布局约束。例如:[centerX,centerY,width,heigt] 意味着 (checkBox相对屏幕中心的x轴偏移量,checkBox相对屏幕中心的y轴偏移量,checkBox宽度,checkBox高度)
checkViewHorizontalConstraints 数组[float,float,float,float] 横屏方向上checkBox相对于整个授权页根视图,布局约束。例如:[centerX,centerY,width,heigt] 意味着 (checkBox相对屏幕中心的x轴偏移量,checkBox相对屏幕中心的y轴偏移量,checkBox宽度,checkBox高度)
isAlertPrivacyVC BOOL 隐私协议弹窗,是否允许在未勾选CheckBox情况下弹窗提示,需要配合privacyCheckToastMessage使用,isAlertPrivacyVC需要先设置true)
  • 隐私协议栏
参数名称 参数类型 参数说明
appPrivacyOne String,String 隐私条款一:数组(务必按顺序)@[条款名称,条款链接]
appPrivacyTwo String,String 隐私条款二:数组(务必按顺序)@[条款名称,条款链接]
appPrivacyColor int,int 隐私条款名称颜色 @[基础文字颜色,条款颜色]
privacyTextFontSize float 隐私条款字体大小,默认 12
privacyOffsetY float 隐私条款Y偏移量(注:此属性为与屏幕底部的距离)
privacyComponents String,String 隐私条款拼接文本数组
privacyShowBookSymbol BOOL 隐私条款是否显示书名号,默认不显示
privacyLineSpacing float 隐私条款行距,默认跟随系统
privacyConstraints 数组[float,float,float,float] 竖屏方向上,隐私协议栏相对于整个授权页根视图,布局约束。例如:[centerX,centerY,width,heigt] 意味着 (隐私协议栏相对屏幕中心的x轴偏移量,隐私协议栏相对屏幕中心的y轴偏移量,隐私协议栏宽度,隐私协议栏高度)
privacyHorizontalConstraints 数组[float,float,float,float] 横屏方向上,隐私协议栏相对于整个授权页根视图,布局约束。例如:[centerX,centerY,width,heigt] 意味着 (隐私协议栏相对屏幕中心的x轴偏移量,隐私协议栏相对屏幕中心的y轴偏移量,隐私协议栏宽度,隐私协议栏高度)
appPrivacys 数组[string,[string,string,string,[string,int,int]] ... ,string] 隐私条款组合:可以存在多个自定义隐私条款。使用该字段的话,appPrivacyOne、appPrivacyTwo、privacyComponents、firstPrivacyAgreementNavText、secondPrivacyAgreementNavText字段则不生效。 [string,array1,array2...arrayN,string],头尾部的string,一个是头部文字一个是尾部文字,可不传,不传的话使用默认的文字。中间字段的array可以有多个,是多个隐私协议的数组组合。每一个array的格式为["与上一条款拼接文本","条款名称","条款链接"]
privacyTextAlignment string 隐私条款文本对齐方式,目前仅支持 left、center
  • 隐私协议页面
参数名称 参数类型 参数说明
agreementNavBackgroundColor int 协议页导航栏背景颜色
agreementNavText String,int,int 运营商协议的协议页面导航栏标题[文字,文字颜色,文字大小]
firstPrivacyAgreementNavText String,int,int 自定义协议1的协议页面导航栏标题[文字,文字颜色,文字大小]
secondPrivacyAgreementNavText String,int,int 自定义协议2的协议页面导航栏标题[文字,文字颜色,文字大小]
agreementNavReturnImage String 协议页导航栏返回按钮图片
  • slogan
参数名称 参数类型 参数说明
sloganOffsetY float slogan 偏移量 Y
sloganTextColor int slogan 文字颜色
sloganConstraints 数组[float,float,float,float] 竖屏方向上,slogan相对于整个授权页根视图,布局约束。例如:[centerX,centerY,width,heigt] 意味着 (slogan相对屏幕中心的x轴偏移量,slogan相对屏幕中心的y轴偏移量,slogan宽度,slogan高度)
sloganHorizontalConstraints 数组[float,float,float,float] 横屏方向上,slogan相对于整个授权页根视图,布局约束。例如:[centerX,centerY,width,heigt] 意味着 (slogan相对屏幕中心的x轴偏移量,slogan相对屏幕中心的y轴偏移量,slogan宽度,slogan高度)
  • 弹窗
参数名称 参数类型 参数说明
showWindow BOOL 是否弹窗,默认 no
windowBackgroundImage String 弹框内部背景图片
windowBackgroundAlpha float 弹窗外侧 透明度 0~1.0
windowCornerRadius float 弹窗圆角数值
windowConstraints 数组[float,float,float,float] 竖屏方向,弹窗布局对象(窗口宽度,窗口高度,窗口相对屏幕中心的x轴偏移量,窗口相对屏幕中心的y轴偏移量)
windowCloseBtnHorizontalConstraints 数组[float,float,float,float] 水平方向,弹窗布局对象(窗口宽度,窗口高度,窗口相对屏幕中心的x轴偏移量,窗口相对屏幕中心的y轴偏移量)
  • 协议二次弹窗(未勾选协议默认提示弹窗)
参数名称 参数类型 参数说明
agreementAlertViewBackgroundColor int 16进制颜色数值,协议二次弹窗背景颜色
agreementAlertViewBackgroundImage String 协议二次弹窗背景图片
agreementAlertViewTitleText String 协议二次弹窗标题文本
agreementAlertViewTitleTexFont float 协议二次弹窗标题文本字体大小
agreementAlertViewTitleTextColor int 16进制颜色数值,协议二次弹窗标题文本颜色
agreementAlertViewContentTextAlignment int 协议二次弹窗内容文本对齐方式 0 居左,1 居中,2居右
agreementAlertViewContentTextFontSize float 协议二次弹窗内容文本字体大小
agreementAlertViewLogBtnImgs Array 协议二次弹窗登录按钮背景图片添加到数组
agreementAlertViewLogBtnText String 协议二次弹窗登录按钮文本
agreementAlertViewLogBtnTextFontSize float 协议二次弹窗登录按钮文本字体大小
agreementAlertViewLogBtnTextColor int 16进制颜色数值,协议二次弹窗登录按钮文本颜色

JVerification

  • SDK授权页面添加自定义控件

    • JVerifyUIConfig 方法中 传参 addCustomViews
    参数名称 参数类型 参数说明
    addCustomViews view 数组 在授权页面添加自定义控件
    • view 共有属性
    属性 参数类型 说明
    type String 可填 label 或 button 或 imageView
    width float 控件宽度
    height float 控件长度
    top float 距离授权页父视图顶部的距离
    left float 距离授权页父视图左边的距离
    right float 距离授权页父视图右边的距离
    bottom float 距离授权页父视图底部的距离
    backgroundColor int 16进制颜色数值,自定义控件的背景色
    cornerRadius float 自定义控件的圆角值
    • type = label 的属性
    属性 参数类型 说明
    text String 文字内容
    textColor int 文字颜色
    textFont int 文字大小
    textAlignment int 0 居左,1 居中,2居右
    numberOfLines int 行数
    • type = button 的属性
    属性 参数类型 说明
    title String 文字内容
    textColor int 文字颜色
    id String 标志当前 button 的唯一 id
    textFont int 文字大小
    isFinish bool 是否在授权页面通过自定义控件button的点击关闭授权页面
    normalImagePath String 设置button图片路径
    backgroundImagePath String button正常情况下背景图片路径
    selectImagePath String button选中情况下背景图片路径
    • type = imageView 的属性
    属性 参数类型 说明
    imagePath String 背景图片路径

关于图片资源

iOS 请将图片放到 uniapp的static目录下 中。

比如需要设置一键登录授权页背景图片,在 static目录文件中 添加 bg.png 图片后,调用

jv.setCustomUIWithConfigiOS({
		authPageBackgroundImage:"static/bg.png"
	})