0.0.1 • Published 4 years ago

oversea-login v0.0.1

Weekly downloads
5
License
MIT
Repository
-
Last release
4 years ago

efox-login

概述

efox-login是由Efox前端组开发的适用于web、pc接入UDB登录系统的工具类,包含手机验证码登录、用户名+密码登录、手机号注册、找密、第三方登录等方式

接入准备

  • appid申请:申请UDB业务标识
  • 第三方平台应用申请和配置(按需)

安装

npm install @efox/efox-login --save

引入

import EfoxLogin from '@efox/efox-login'

or

const EfoxLogin = require('@efox/efox-login')

配置字段说明

字段说明类型是否必传可选值默认值
appidUDB业务appidstringtrue--
methods登录方式arrayfalse'phone' 'social''phone'
region地区stringtrue各地区编码'CN'
domain业务域名不带前缀stringtrue--
redirect授权回调的地址string第三方登录必传--
socialAuth第三方应用编号和key集合object第三方登录必传--
width第三方登录弹窗宽度numberfalse-800
height第三方登录弹窗高度numberfalse-600
state第三方授权回调带回状态stringfalse--
lang语言stringfalse-'zh-cn'
dir排版方向stringfalse'ltr' 'rtl''ltr'
方法说明回传参数
onLoginSuccess登录成功回调{uid: string, isNew: boolean, method: string}
onLoginFail登录失败回调{code: int, msg: string, method: string}
onRegClick点击注册回调-
onFindPwdClick点击忘记密码回调-
onRegSuccess注册成功回调-
onFindPwdSuccess修改密码成功回调-

实例化示例

const efoxLogin = new EfoxLogin({
  appid: '1170901840',
  methods: ['phone', 'social'],
  region: 'US',
  domain: 'hamo.tv',
  redirect: 'https://test.hamo.tv/redirect',
  socialAuth: {
    facebook: {
      appid: '2008835592494324',
      secret: '86210a0fdf5918aafdaa938d6d0f83bf'
    }
  },
  width: 800,
  height: 600,
  state: '',
  lang: 'en-my',
  onLoginSuccess: msg => {
    console.log(msg)
  },
  onLoginFail: e => {
    console.log(e)
  },
  onRegClick: () => {
    console.log('点击注册')
  },
  onFindPwdClick: () => {
    console.log('点击忘记密码')
  },
  onRegSuccess: () => {
    console.log('注册成功')
  },
  onFindPwdSuccess: () => {
    console.log('修改密码成功')
  },
})

efoxLogin对象下的属性与方法

属性

属性名说明类型
phoneLoginSrc手机登录iframe的srcstring
phoneFindPwdSrc手机注册iframe的srcstring
phoneRegisterSrc忘记密码iframe的srcstring

方法

  • socialLogin
参数名说明类型
channel第三方登录平台名称(全小写)string
facebookBtn.onclick = efoxLogin.socialLogin({
  channel: 'facebook'
})

注意事项

确保实例化代码在web应用能够调起登录的界面和授权回调界面能够被执行

仓库地址

http://git.yypm.com/efox/efox-login