# auth-userinfo 用户信息授权
# 介绍
用户信息授权
# 使用指南
# 一般用法
<tms-auth-userinfo/>
# api
- 提供默认的用户信息授权样式
- 兼容微信getUserProfile、getUserInfo接口
| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
| useDesc | String | 提供更好的出行服务 | 否 | 声明获取用户个人信息后的用途 |
| customUI | Boolean | false | 否 | 是否使用自定义UI 使用自定义UI时,auth-userinfo作为slot容器 |
| showUserInfoModal | Boolean | false | 否 | 展示/隐藏授权UI 用于customUI=false时,控制默认授权弹窗的可见性 |
| bind:getUserInfo | eventhandle | 否 | 获取用户信息结束(成功或失败) | |
| bind:auth-changed | eventhandle | 否 | @deprecated,用户信息授权状态发生变化 |
# bind:getUserInfo 事件数据结构
| 属性 | 类型 | 说明 |
|---|---|---|
| success | Boolean | 是否成功获取用户信息 |
| userInfo | Object | 用户信息,success=false时返回默认用户信息 |
| userInfo.nickName | String | 昵称 |
| userInfo.avatarUrl | String | 头像 |
| userInfo.gender | Number | 性别,0-未知,1-男性,2-女性 |
| userInfo.country | String | 国家 |
| userInfo.province | String | 省份 |
| userInfo.city | String | 城市 |
| userInfo.language | String | 显示 country,province,city 所用的语言 |
| error | Object | 错误信息,success=true时error为空 |
# bind:auth-changed 事件数据结构
@deprecated,推荐使用bind:getUserInfo。
| 属性 | 类型 | 说明 |
|---|---|---|
| cancel | Boolean | 用户允许/拒绝授权获取用户信息 |
| userInfo | Object | 用户信息,cancel=true时返回默认用户信息 |
| userInfo.nickName | String | 昵称 |
| userInfo.avatarUrl | String | 头像 |
| userInfo.gender | Number | 性别,0-未知,1-男性,2-女性 |
| userInfo.country | String | 国家 |
| userInfo.province | String | 省份 |
| userInfo.city | String | 城市 |
| userInfo.language | String | 显示 country,province,city 所用的语言 |
| error | Object | 错误信息,cancel=false时error为空 |
