1.0.5 • Published 5 years ago
yz-cps-sdk v1.0.5
一、介绍
yz-cps-sdk
是有赞 cps 提供给 PC 端的商品选择组件。
二、下载
可以使用 npm 或者 yarn 下载:
npm install yz-cps-sdk --save-dev
yarn add yz-cps-sdk -D
三、使用
需要先从有赞云平台申请应用,获得 appId
,然后生成 token
,这样接口才能鉴权通过,还需要从有赞客平台获得 promoter_code
。
import YzCpsSdk from 'yz-cps-sdk';
const yzSdk = new YzCpsSdk({
container: document.getElementById('sdk'),
token: 'c8fecee7dc7f42c072f2a301570f78af',
promoter_code: '5414188818',
onSelected: (arr) => {
console.log(arr);
},
});
setTimeout(() => {
yzSdk.hide();
}, 3000);
四、API
IOptions
interface IOptions { container?: HTMLElement; classListArray?: string[]; show?: boolean; token: string; promoter_code: string; isPre?: boolean; unique?: string; onSelected: (alias: string[]) => void; }
参数 解释 类型 默认值 是否必填 container iframe 容器 HTMLElement document.body 否 classListArray iframe 的自定义类 string[] [] 否 show 是否默认展现 boolean true 否 token 通过 appId 生成的 token string 是 promoter_code 通过有赞客平台获得 string 是 isPre 是否预发环境 boolean false 否 onSelected 点击选好了回调 (alias: string[]) => void 是 unique 保证多个实例的回调回不影响 string 否 实例方法
- show(): void; 展示 iframe
- hide(): void; 隐藏 iframe
- destory(): void; 销毁 iframe
- setToken(token: string): void; 设置 token
- clearSelected(): void; 清空选择