UNPKG

2.19 kBTypeScriptView Raw
1import { ComponentType } from 'react'
2import { StandardProps, CommonEventFunction } from './common'
3interface OfficialAccountProps extends StandardProps {
4 /** 组件加载成功时触发
5 * @supported weapp
6 */
7 onLoad?: CommonEventFunction<OfficialAccountProps.Detail>
8 /** 组件加载失败时触发
9 * @supported weapp
10 */
11 onError?: CommonEventFunction<OfficialAccountProps.Detail>
12}
13declare namespace OfficialAccountProps {
14 /** detail 对象 */
15 interface Detail {
16 /** 状态码 */
17 status: number
18 /** 错误信息 */
19 errMsg: string
20 }
21 /** status 有效值 */
22 interface Status {
23 /** 网络错误 */
24 '-2'
25 /** 数据解析错误 */
26 '-1'
27 /** 加载成功 */
28 0
29 /** 小程序关注公众号功能被封禁 */
30 1
31 /** 关联公众号被封禁 */
32 2
33 /** 关联关系解除或未选中关联公众号 */
34 3
35 /** 未开启关注公众号功能 */
36 4
37 /** 场景值错误 */
38 5
39 /** 重复创建 */
40 6
41 }
42}
43/** 公众号关注组件。当用户扫小程序码打开小程序时,开发者可在小程序内配置公众号关注组件,方便用户快捷关注公众号,可嵌套在原生组件内。
44 *
45 * Tips
46 * 使用组件前,需前往小程序后台,在“设置”->“关注公众号”中设置要展示的公众号。注:设置的公众号需与小程序主体一致。
47 *
48 * 在一个小程序的生命周期内,只有从以下场景进入小程序,才具有展示引导关注公众号组件的能力:
49 *
50 * 当小程序从扫小程序码场景(场景值1047,场景值1124)打开时
51 * 当小程序从聊天顶部场景(场景值1089)中的「最近使用」内打开时,若小程序之前未被销毁,则该组件保持上一次打开小程序时的状态
52 * 当从其他小程序返回小程序(场景值1038)时,若小程序之前未被销毁,则该组件保持上一次打开小程序时的状态
53 * @classification open
54 * @supported weapp
55 * @see https://developers.weixin.qq.com/miniprogram/dev/component/official-account.html
56 */
57declare const OfficialAccount: ComponentType<OfficialAccountProps>
58export { OfficialAccount, OfficialAccountProps }