onPullDownRefresh


Turn on drop-down refresh. The drop-down refresh triggers the "pulldownrefresh" event.

Supported

Install

``bash
$ npm install @uni/pull-down-refresh --save
`
or
`bash
$ npm install @uni/apis --save
`


Usage

`javascript
import { onPullDownRefresh } from '@uni/pullDownRefresh';

onPullDownRefresh();
`


You can also import from the big package:

`js
import { pullDownRefresh } from '@uni/apis';

pullDownRefresh.onPullDownRefresh();
`

You can add event listener:
`js
pullDownRefresh.onPullDownRefresh({eventCallback: cb});
`


Methods

$3

#### Arguments

| Property | Type | Description | required | Default |
| --- | --- | --- | --- | --- |
| options | object  | | ✔️ | - |
| options.pullRefresh | boolean  | The switch of manual pulldownRefresh | ✘ | true |
| options.triggerDistance | number  | The pull-down distance required when the pull-down refresh is triggered | ✘ | 90 |
| options.eventCallback | Function  | The callback function when the event is triggered | ✘ | - |
| options.success | Function  | The callback function for a successful API call | ✘ | - |
| options.fail | Function  | The callback function for a failed API call | ✘ | - |
| options.complete | Function  | The callback function used when the API call completed (always executed whether the call succeeds or fails) | ✘ | - |

startPullDownRefresh


![npm](https://www.npmjs.com/package/@uni/pull-down-refresh)

Starts swipe-down-to-refresh.

Supported

Note: DingTalk miniprogram does not support startPullDownRefresh

Install

`bash
$ npm install @uni/pull-down-refresh --save
`
or
`bash
$ npm install @uni/apis --save
`


Usage

`javascript
import { startPullDownRefresh } from '@uni/pullDownRefresh';

startPullDownRefresh();
`


You can also import from the big package:

`js
import { pullDownRefresh } from '@uni/apis';

pullDownRefresh.startPullDownRefresh();
`

Methods

$3

#### Arguments

| Property | Type | Description | required | Default |
| --- | --- | --- | --- | --- |
| options | object  | | ✔️ | - |
| options.success | Function  | The callback function for a successful API call | ✘ | - |
| options.fail | Function  | The callback function for a failed API call | ✘ | - |
| options.complete | Function  | The callback function used when the API call completed (always executed whether the call succeeds or fails) | ✘ | - |

stopPullDownRefresh


![npm](https://www.npmjs.com/package/@uni/pull-down-refresh)

Disables swipe-down-to-refresh for the current page.

Supported

Install

`bash
$ npm install @uni/pullDownRefresh --save
`
or
`bash
$ npm install @uni/apis --save
`


Usage

`javascript
import {stopPullDownRefresh} from '@uni/pullDownRefresh';

stopPullDownRefresh();
`

You can also import from the big package:

`js
import { pullDownRefresh } from '@uni/apis';

pullDownRefresh.stopPullDownRefresh();
`

Methods

$3

#### Arguments


| Property | Type | Description | required | Default | Supported |
| --- | --- | --- | --- | --- | --- |
| options | object  | | ✔️ | - | - |
| options.success | Function  | The callback function for a successful API call | ✘ | - | |
| options.fail | Function  | The callback function for a failed API call | ✘ | - | |
| options.complete | Function`  | The callback function used when the API call completed (always executed whether the call succeeds or fails) | ✘ | - | |