UNPKG

2.84 kBTypeScriptView Raw
1import { ComponentType } from 'react'
2import { StandardProps } from './common'
3interface LottieProps extends StandardProps {
4 /** 是否自动播放。
5 * @supported alipay
6 * @default false
7 */
8 autoplay?: boolean
9 /** Lottie 资源地址。包含近端(包内地址)和远端(网络)的 JSON 文件地址。
10 * 与 djangoId 二选一。
11 * @supported alipay
12 */
13 path?: string
14 /** 播放速度。正数为正向播放,负数负向播放。
15 * @supported alipay
16 * @default 1.0
17 */
18 speed?: number
19 /** 循环次数。
20 *
21 * 如果是负数表示无限次。
22 * 如果是 0 表示不循环,播放一次。
23 * 如果是 1 表示循环一次,播放两次。
24 * @supported alipay
25 * @default 0
26 */
27 repeatCount?: number
28 /** 是否自动回播。
29 * @supported alipay
30 * @default false
31 */
32 autoReverse?: boolean
33 /** 资源地址。"/" 表明是小程序根目录。
34 * @supported alipay
35 */
36 assetsPath?: string
37 /** 兜底图或者降级图地址。
38 *
39 * 1. 支持本地资源,案例:'/image/lottie/lottie2_default.png'。
40 * 支持 http 的 cdn 地址、近端地址。
41 * 小程序场景不支持 djangoId。
42 * @supported alipay
43 */
44 placeholder?: string
45 /** 在线资源的 md5 校验。
46 * djangoId=https://b.zip。
47 * 可以使用 b.zip 加密 获取 md5 值
48 * md5="77c6c86fc89ba94cc0a9271b77ae77d2"
49 * @supported alipay
50 */
51 md5?: string
52 /** 降级。降级是指如遇低端设备,Lottie 会降级展示为 placeholder。
53 * 当 optimize 为 true ,并且传入了 placeholder 时,在低端设备上只会展示 placeholder,不展示 Lottie。
54 * 低端设备如下所示:
55 *
56 * iOS :小于等于 iPhone6P
57 * Android:内存容量小于 3G
58 * @supported alipay
59 * @default false
60 */
61 optimize?: boolean
62 /** 当数据下载+视图创建完成时触发。
63 * @supported alipay
64 */
65 onDataReady?: CommonEventFunction
66 /** 数据加载失败时触发。
67 * @supported alipay
68 */
69 onDataFailed?: CommonEventFunction
70 /** 动画开始时触发。
71 * @supported alipay
72 */
73 onAnimationStart?: CommonEventFunction
74 /** 动画结束时触发。
75 * @supported alipay
76 */
77 onAnimationEnd?: CommonEventFunction
78 /** 动画一次重播结束。
79 * @supported alipay
80 */
81 onAnimationRepeat?: CommonEventFunction
82 /** 动画取消。业务调用 Cancel 时回调。
83 * @supported alipay
84 */
85 onAnimationCancel?: CommonEventFunction
86 /** 参数化时,数据准备完成,等待业务传入参数化值。
87 * @supported alipay
88 */
89 onDataLoadReady?: CommonEventFunction
90}
91/** Lottie
92 * @classification media
93 * @supported alipay
94 * @see https://opendocs.alipay.com/mini/component/lottie
95 */
96declare const Lottie: ComponentType<LottieProps>
97export { Lottie, LottieProps }