Showing
1 changed file
with
116 additions
and
0 deletions
README.md
0 → 100644
1 | +## YOHO!前端js的功能封装包,主要用于在活动页面中,对主要功能的封装。 | ||
2 | + | ||
3 | +## 封装实现的功能 | ||
4 | + | ||
5 | +### 1. 用户相关 | ||
6 | + 1. 获取用户登录uid | ||
7 | + 2. 验证登录 | ||
8 | + | ||
9 | +### 3. 运行环境相关 | ||
10 | + 1. 区分当前环境h5、pc、小程序还是app | ||
11 | + 2. 不同环境下页面跳转执行 | ||
12 | + 3. 不同环境下的回退按钮实现 | ||
13 | + 4. 不同环境下的登录功能统一实现 | ||
14 | + 5. 获取当前环境信息 | ||
15 | + | ||
16 | +### 3. 分享相关 | ||
17 | + 1. 微信分享到qq 微信好友 微信朋友圈 微博 | ||
18 | + 2. 微信验签方法提供 | ||
19 | +## 使用说明 | ||
20 | + | ||
21 | +可以直接import也可以define() | ||
22 | + | ||
23 | +如果是在html页面引入window.yo_sdk可以获取到所有的api | ||
24 | + | ||
25 | +## api说明 | ||
26 | + | ||
27 | +#### 登录权限判断: | ||
28 | + | ||
29 | +描述:在加载完sdk的时候会主动搜索当前html上是否有class命名为auth的标签,如果有则点击 | ||
30 | +该标签的时候就会判断当前是否登录如果没有登录则自动判断跳转登录页 | ||
31 | + | ||
32 | +用法:`<div class="auth">aaa</div>` | ||
33 | + | ||
34 | +#### goLogin: | ||
35 | +类型:function | ||
36 | + | ||
37 | +描述:执行登录方法,已经兼容h5 pc 小程序 app 4个端,直接调用就可以登录 | ||
38 | + | ||
39 | +用法:`window.yo_sdk.goLogin()` | ||
40 | +#### env: | ||
41 | +类型:string | ||
42 | + | ||
43 | +描述:获取当前环境,会获取到'h5','pc','miniprogram','app' | ||
44 | + | ||
45 | +用法:`let env = window.yo_sdk.env` | ||
46 | + | ||
47 | +#### uid: | ||
48 | +类型:number | ||
49 | + | ||
50 | +描述:获取当前用户uid,如果没有用户则该值为0 | ||
51 | + | ||
52 | +用法:`let uid = window.yo_sdk.uid` | ||
53 | + | ||
54 | +#### link: | ||
55 | +类型:function | ||
56 | + | ||
57 | +描述:页面跳转 | ||
58 | + | ||
59 | +用法: | ||
60 | +``` | ||
61 | +//跳转到商品详情页data-id='${skn}' | ||
62 | +<div data-type='product' data-id='51951762'onClick="fun(event)">product</div> | ||
63 | + | ||
64 | +//跳转到商铺首页data-id:商铺id,data-name商铺名 | ||
65 | +<div data-type='brand' data-id='468' data-name="FANTASTIC PLANET怪诞星球" onClick="fun(event)">brand</div> | ||
66 | + | ||
67 | +//跳转到其他页面data-url:跳转的页面地址 | ||
68 | +<div data-type='other' data-url='https://feature.yoho.cn/0917/BOY/index.html?openby:yohobuy={"action":"go.h5","params":{"title":"新品节主会场/BOY","url":"https://feature.yoho.cn/0917/BOY/index.html","share":"\/operations\/api\/v5\/webshare\/getShare","shareparam":{"share_id":"5711"},"param":{"share_id":"5711"}}}' onClick="fun(event)">other</div> | ||
69 | +<script src="../build/sdk.js"></script> | ||
70 | +<script> | ||
71 | + function fun(event){ | ||
72 | + /** | ||
73 | + * aaaaaaaa | ||
74 | + */ | ||
75 | + window.yo_sdk.link(event); | ||
76 | + } | ||
77 | +</script> | ||
78 | + ``` | ||
79 | +#### goBack: | ||
80 | +类型:function | ||
81 | + | ||
82 | +描述:回退方法,支持多端回退包括h5和小程序web-view嵌套回退 | ||
83 | + | ||
84 | +用法: `<button onclick="window.yo_sdk.goBack"></button>` | ||
85 | + | ||
86 | +#### wxSignature: | ||
87 | +类型 function | ||
88 | + | ||
89 | +描述:微信验签方法提供 | ||
90 | + | ||
91 | +用法: | ||
92 | +``` | ||
93 | + function callback(){/*** 回调执行 ***/} | ||
94 | + window.yo_sdk.wxSignature(callback); | ||
95 | + | ||
96 | +``` | ||
97 | +#### wxShare | ||
98 | +类型:function | ||
99 | + | ||
100 | +描述:微信分享方法 | ||
101 | + | ||
102 | +用法:必须先执行验签方法再执行分享方法,也可以吧分享方法作为验签方法的callback | ||
103 | +``` | ||
104 | +let shareData = { | ||
105 | + title: '国潮崛起年,中西碰撞博出位!', | ||
106 | + imgUrl: 'https://img01.yohoboys.com/o_1cnilugbs15ajak1gfo1d2h1p348.png?imageView2/1/w/200/h/200', | ||
107 | + desc: '这里有一份中西潮流榜单,请收好!', | ||
108 | + link: location.href, | ||
109 | + success: function () { | ||
110 | + alert('1123') | ||
111 | + } | ||
112 | + }; | ||
113 | + await window.yo_sdk.wxSignature(); | ||
114 | + await window.yo_sdk.wxShare(shareData) | ||
115 | + | ||
116 | +``` |
-
Please register or login to post a comment