| | |
|---|
| | | --- |
|---|
| | | |
|---|
| | | <span class="coverages-badge" style="margin-right: 10px"><img src="https://img.shields.io/badge/coverages%3A%20lines-96%25-blue" /></span><span class="coverages-badge" style="margin-right: 10px"><img src="https://img.shields.io/badge/coverages%3A%20functions-81%25-blue" /></span><span class="coverages-badge" style="margin-right: 10px"><img src="https://img.shields.io/badge/coverages%3A%20statements-94%25-blue" /></span><span class="coverages-badge" style="margin-right: 10px"><img src="https://img.shields.io/badge/coverages%3A%20branches-81%25-blue" /></span> |
|---|
| | | |
|---|
| | | ## 引入 |
|---|
| | | |
|---|
| | | 全局引入，在 miniprogram 根目录下的`app.json`中配置，局部引入，在需要引入的页面或组件的`index.json`中配置。 |
|---|
| | |
|---|
| | | |
|---|
| | | ## 代码演示 |
|---|
| | | |
|---|
| | | <a href="https://developers.weixin.qq.com/s/HH8v1imF7iSf" title="在开发者工具中预览效果" target="_blank" rel="noopener noreferrer"> 在开发者工具中预览效果 </a> |
|---|
| | | |
|---|
| | | <blockquote style="background-color: #d9e1ff; font-size: 15px; line-height: 26px;margin: 16px 0 0;padding: 16px; border-radius: 6px; color: #0052d9" > |
|---|
| | | <p>Tips: 请确保开发者工具为打开状态。导入开发者工具后，依次执行：npm i > 构建npm包 > 勾选 "将JS编译成ES5"</p> |
|---|
| | | </blockquote> |
|---|
| | | |
|---|
| | | ### 顶部下拉刷新 |
|---|
| | | |
|---|
| | | 由于组件内无法监听页面滚动，需要由页面获取组件实例，并将页面滚动事件传递到组件。 |
|---|
| | | |
|---|
| | | {{ base }} |
|---|
| | | |
|---|
| | | |
|---|
| | | |
|---|
| | | > 在使用 pull-down-refresh 组件的页面，建议开启 `disableScroll: true` |
|---|
| | | |
|---|
| | | ## API |
|---|
| | | |
|---|
| | | ### PullDownRefresh Props |
|---|
| | | |
|---|
| | | 名称 | 类型 | 默认值 | 说明 | 必传 |
|---|
| | | 名称 | 类型 | 默认值 | 描述 | 必传 |
|---|
| | | -- | -- | -- | -- | -- |
|---|
| | | style | Object | - | 样式 | N |
|---|
| | | custom-style | Object | - | 样式，一般用于开启虚拟化组件节点场景 | N |
|---|
| | | disabled | Boolean | false | 是否禁用下拉刷新 | N |
|---|
| | | enable-back-to-top | Boolean | true | `1.1.5`。iOS点击顶部状态栏、安卓双击标题栏时，滚动条返回顶部，只支持竖向。自 2.27.3 版本开始，若非显式设置为 false，则在显示尺寸大于屏幕 90% 时自动开启 | N |
|---|
| | | enable-passive | Boolean | false | `1.1.5`。开启 passive 特性，能优化一定的滚动性能 | N |
|---|
| | | external-classes | Array | - | 加载loading样式。`['t-class', 't-class-loading','t-class-text', 't-class-indicator']` | N |
|---|
| | | header | Slot | - | `1.2.10`。[通用类型定义](https://github.com/Tencent/tdesign-miniprogram/blob/develop/src/common/common.ts) | N |
|---|
| | | loading-bar-height | String / Number | 50 | 加载中下拉高度，如果值为数字则单位是：'px' | N |
|---|
| | | loading-props | Object | - | 加载loading样式。TS 类型：`LoadingProps`，[Loading API Documents](./loading?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/pull-down-refresh/type.ts) | N |
|---|
| | | loading-texts | Array | [] | 提示语，组件内部默认值为 ['下拉刷新', '松手刷新', '正在刷新', '刷新完成']。TS 类型：`string[]` | N |
|---|
| | |
|---|
| | | max-bar-height | String / Number | 80 | 最大下拉高度，如果值为数字则单位是：'px' | N |
|---|
| | | refresh-timeout | Number | 3000 | 刷新超时时间 | N |
|---|
| | | scroll-into-view | String | - | `1.1.5`。值应为某子元素id（id不能以数字开头）。设置哪个方向可滚动，则在哪个方向滚动到该元素 | N |
|---|
| | | show-scrollbar | Boolean | true | 滚动条显隐控制 (同时开启 enhanced 属性后生效) | N |
|---|
| | | upper-threshold | String / Number | 50 | `1.1.5`。距顶部/左边多远时，触发 scrolltoupper 事件 | N |
|---|
| | | value | Boolean | false | 组件状态，值为 `true` 表示下拉状态，值为 `false` 表示收起状态 | N |
|---|
| | | default-value | Boolean | undefined | 组件状态，值为 `true` 表示下拉状态，值为 `false` 表示收起状态。非受控属性 | N |
|---|
| | |
|---|
| | | 名称 | 参数 | 描述 |
|---|
| | | -- | -- | -- |
|---|
| | | change | `(value: boolean)` | 下拉或收起时触发，用户手势往下滑动触发下拉状态，手势松开触发收起状态 |
|---|
| | | dragend | `(scrollTop: number, scrollLeft: number)` | `1.2.10`。滑动结束事件 |
|---|
| | | dragging | `(scrollTop: number, scrollLeft: number)` | `1.2.10`。滑动事件 |
|---|
| | | dragstart | `(scrollTop: number, scrollLeft: number)` | `1.2.10`。滑动开始事件 |
|---|
| | | refresh | \- | 结束下拉时触发 |
|---|
| | | scrolltolower | \- | 滚动到页面底部时触发 |
|---|
| | | timeout | \- | 刷新超时触发 |
|---|
| | | |
|---|
| | | ### PullDownRefresh 外部样式类 |
|---|
| | | |
|---|
| | | 类名 | 描述 |
|---|
| | | -- | -- |
|---|
| | | t-class | 根节点样式类 |
|---|
| | | t-class-indicator | 指示样式类 |
|---|
| | | t-class-loading | 加载样式类 |
|---|
| | | t-class-text | 文本样式类 |
|---|
| | | |
|---|
| | | ### CSS 变量 |
|---|
| | | |
|---|
| | | 组件提供了下列 CSS 变量，可用于自定义样式。 |
|---|
| | | 名称 | 默认值 | 描述 |
|---|
| | | -- | -- | -- |
|---|
| | | --td-pull-down-refresh-color | @font-gray-3 | - |
|---|
