UNPKG

1.61 kBTypeScriptView Raw
1import { ComponentType } from 'react'
2import { StandardProps, CommonEventFunction } from './common'
3interface ListBuilderProps extends StandardProps {
4 /**
5 * 布局方式
6 * @supported weapp
7 * @default "aligned"
8 *
9 * 可选值:
10 * - static: 定高模式,所有列表项等高,需要传入 child-height
11 * - dynamic: 不定高模式
12 */
13 type: 'static' | 'dynamic'
14 /**
15 * 需要用于渲染的列表
16 * @supported weapp
17 * @default []
18 */
19 list: any[]
20 /**
21 * 完整列表的长度,如果不传则取 list 的长度作为其值
22 * @supported weapp
23 */
24 childCount?: number
25 /**
26 * 列表项的高度,当 type 为 static 时必须传入
27 * @supported weapp
28 */
29 childHeight?: number
30 /**
31 * 长度为 4 的数组,按 top、right、bottom、left 顺序指定内边距
32 * @supported weapp
33 * @default [0, 0, 0, 0]
34 */
35 padding?: [number, number, number, number]
36 /**
37 * 列表项创建时触发,event.detail = {index},index 即被创建的列表项序号
38 * @supported weapp
39 */
40 onItemBuild?: CommonEventFunction
41 /**
42 * 列表项回收时触发,event.detail = {index},index 即被回收的列表项序号
43 * @supported weapp
44 */
45 onItemDispose?: CommonEventFunction
46}
47
48/**
49 * 列表构造器,仅支持作为 `<scroll-view type="custom">` 模式的直接子节点,仅 Skyline 支持。
50 * @classification skyline
51 * @supported weapp
52 * @see https://developers.weixin.qq.com/miniprogram/dev/component/list-builder.html
53 */
54declare const ListBuilder: ComponentType<ListBuilderProps>
55export { ListBuilder, ListBuilderProps }