UNPKG

1.46 kBTypeScriptView Raw
1import { ComponentType } from 'react'
2import { StandardProps, CommonEventFunction } from './common'
3
4interface DraggableSheetProps extends StandardProps {
5 /**
6 * 初始时占父容器的比例
7 * @supported weapp
8 * @default 0.5
9 */
10 initialChildSize?: number
11 /**
12 * 最小时占父容器的比例
13 * @supported weapp
14 * @default 0.25
15 */
16 minChildSize?: number
17 /**
18 * 最大时占父容器的比例
19 * @supported weapp
20 * @default 1.0
21 */
22 maxChildSize?: number
23 /**
24 * 拖拽后是否自动对齐关键点
25 * @supported weapp
26 * @default false
27 */
28 snap?: boolean
29 /**
30 * 拖拽后对齐的关键点,无需包含最小和最大值
31 * @supported weapp
32 * @default []
33 */
34 snapSizes?: any[]
35}
36
37/**
38 * 半屏可拖拽组件
39 * 该组件需配合 DraggableSheetContext 接口使用。 目前仅在 Skyline 渲染引擎下支持。
40 * 页面内拖拽是一种常见的交互效果,开发者可通过手势系统灵活实现。draggable-sheet 组件封装了常见的交互逻辑,实现起来更加简单。
41 * 该组件需结合 scroll-view 使用。scroll-view 组件声明 associative-container 属性后,可与 draggable-sheet 关联起来。
42 * @classification skyline
43 * @supported weapp
44 * @see https://developers.weixin.qq.com/miniprogram/dev/component/draggable-sheet.html
45 */
46declare const DraggableSheet: ComponentType<DraggableSheetProps>
47export { DraggableSheet, DraggableSheetProps }