UNPKG

2.64 kBTypeScriptView Raw
1import { ComponentType } from 'react'
2import { StandardProps } from './common'
3interface LikeProps extends StandardProps {
4 /** 是否已被点赞
5 * @supported swan
6 * @default false
7 */
8 isLiked?: boolean
9 /** 按钮模式。icon:表示仅有图标;mixture:表示图标文字结合
10 * @supported swan
11 * @default "icon"
12 */
13 mode?: string
14 /** 图标类型。hand:表示手形;heart:表示心形
15 * @supported swan
16 * @default "hand"
17 */
18 iconType?: string
19 /** 点赞按钮上的文案。默认为赞,仅在 mode 属性值为'mixture'时有效
20 * @supported swan
21 * @default "赞"
22 */
23 likeText?: string
24 /** 点赞数量
25 * @supported swan
26 * @default 0
27 */
28 likeNum?: number
29 /** 被点赞的对象类型。0:表示对文章内容进行点赞;1:表示对评论内容进行点赞
30 * @supported swan
31 * @default 0
32 */
33 likeType?: number
34 /** 点赞动效形式。0:无动效;1:轻动效;2:强动效
35 * @supported swan
36 * @default 1
37 */
38 animationType?: number
39 /** 点赞后是否弹出 toast 提示
40 * @supported swan
41 * @default false
42 */
43 isShowToast?: boolean
44 /** toast 文案,默认为已点赞、已取消
45 * @supported swan
46 * @default ['已点赞', '已取消']
47 */
48 toastText?: string[]
49 /** 点赞服务需要的必要参数
50 * @supported swan
51 */
52 likeParam: LikeProps.ILikeParam
53 /** 使用 npm 方式引入点赞组件时,点击按钮时在用户未登录状态下会触发此事件;使用动态库方式引入点赞组件时,点击按钮时在用户未登录状态下不会触发此事件
54 * @supported swan
55 */
56 onError?: CommonEventFunction
57 /** 点击点赞按钮,在点赞服务成功后将状态返回给使用组件者
58 * @supported swan
59 */
60 onSuccess?: CommonEventFunction
61 /** 点击点赞按钮,在点赞服务失败后将状态返回给使用组件者
62 * @supported swan
63 */
64 onFail?: CommonEventFunction
65}
66declare namespace LikeProps {
67 interface ILikeParam {
68 /** 用户身份唯一标识 */
69 openid: string
70 /** 被点赞的文章的 id,与 path 参数一一对应
71 * @example "20200101"
72 */
73 snid: string
74 /** 被点赞的评论 id */
75 spid?: string
76 /** 文章标题 */
77 title: string
78 /** 智能小程序内页链接,最长不能超过 194 字符
79 * @example "/pages/index/index"
80 */
81 path: string
82 }
83}
84/** 点赞
85 * @classification open
86 * @supported swan
87 * @see https://smartprogram.baidu.com/docs/develop/extended/component-content/like/
88 */
89declare const Like: ComponentType<LikeProps>
90export { Like, LikeProps }