@custouch-open/js-sdk

本文档是@custouch-open/js-sdk的快速使用指南，演示使用的环境版本为Node@20和yarn@1.22.22

前期准备

• 申请 appKey
• 配置.yarnrc

"@custouch-open:registry" "https://npm.cnb.cool/custouch/npm/-/packages/"
"registry" "https://registry.npmmirror.com"
复制

安装 npm 包

yarn add @custouch-open/js-sdk
复制

使用

初始化

import { init, CheckAccess } from '@custouch-open/js-sdk'
// 确保只初始化一次
init({ appKey: '{appKey}', jsApiList: [...] }).then(({ wxKit }) => {
    // 确保在初始化完成后调用接口方法
    CheckAccess().then(res=>{
        ...
    })
})
复制

调用 wx 的其它接口

import { wxKit } from '@custouch-open/js-sdk'
// FAQ: 可以通过`await wxKit.sdkCompleted`来确保wxKit.sdk已经初始化完成
// 调用微信的开始录音接口，当然需要提前声明到jsApiList中
wxKit.sdk.startRecord()
复制

文档结构

api

该目录下暴露了所有可供使用的接口，以下不同模块的解释，更具体的解释可以参考相关接口的文档

• api/action - 事件上报
• api/cms - 内容管理
• api/form - 表单
• api/member - 会员中心
• api/site - 微站相关

其他组件

相关文件的具体使用方法可以参考对应的 readme 文档

CMS 的富文本展示组件(Vue3)

yarn add @custouch-open/rich-text-vue3
复制

系统 PDF 预览组件(Vue3 or Others)

yarn add @custouch-open/resource-pdf
复制

系统视频播放组件(Vue3 or Others)

yarn add @custouch-open/resource-video
复制