提交 7a59aa64 编写于 作者: Anne_LXM's avatar Anne_LXM

更新on、off之类api

上级 fe30ac8a
### uni.hideKeyboard() ### uni.hideKeyboard()
隐藏软键盘 隐藏软键盘
隐藏已经显示的软键盘,如果软键盘没有显示则不做任何操作。 隐藏已经显示的软键盘,如果软键盘没有显示则不做任何操作。
**平台差异说明** **平台差异说明**
|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序| |App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序|
|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:| |:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|
|√|√|√|√|x|√|√|√|√| |√|√|√|√|x|√|√|√|√|
### uni.onKeyboardHeightChange(CALLBACK) @onkeyboardheightchange ### uni.onKeyboardHeightChange(CALLBACK) @onkeyboardheightchange
监听键盘高度变化 监听键盘高度变化
**平台差异说明** **平台差异说明**
|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序| |App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序|
|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:| |:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|
|HBuilderX 2.2.3+|x|基础库2.7+|x|x|x|√|√|√| |HBuilderX 2.2.3+|x|基础库2.7+|x|x|x|√|√|√|
**CALLBACK 返回参数** **参数**
|参数|类型|说明| function listener
|:-|:-|:-|
|height|Number|键盘高度| 键盘高度变化事件的监听函数
**示例代码** **参数**
```js Object res
uni.onKeyboardHeightChange(res => {
console.log(res.height) |参数|类型|说明|
}) |:-|:-|:-|
``` |height|Number|键盘高度|
### uni.offKeyboardHeightChange(CALLBACK) @offkeyboardheightchange **示例代码**
取消监听键盘高度变化事件 ```js
uni.onKeyboardHeightChange(res => {
**平台差异说明** console.log(res.height)
})
|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序| ```
|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|
|HBuilderX 3.1.0+|x|基础库2.9.2+|x|x|x|x|x|√| ### uni.offKeyboardHeightChange(CALLBACK) @offkeyboardheightchange
**示例代码** 取消监听键盘高度变化事件
```js **平台差异说明**
uni.offKeyboardHeightChange(callback)
``` |App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序|
|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|
### uni.getSelectedTextRange(OBJECT) @getselectedtextrange |HBuilderX 3.1.0+|x|基础库2.9.2+|x|x|x|x|x|√|
在input、textarea等focus之后,获取输入框的光标位置。注意:只有在focus的时候调用此接口才有效。目前仅支持 vue 页面,nvue 可以直接使用 weex 的 [getSelectionRange](https://weex.apache.org/zh/docs/components/input.html#getSelectionRange) **参数**
**平台差异说明** function listener
|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序| onKeyboardHeightChange 传入的监听函数。不传此参数则移除所有监听函数。
|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|
|HBuilderX 2.8.12+|HBuilderX 2.8.12+|基础库 2.7.0+|x|x|x|x|√|x|
**示例代码**
**OBJECT 参数说明:**
```js
| 参数名 | 类型 | 默认值 | 必填 | 说明 | const listener = function (res) { console.log(res) }
| --- | --- | --- | --- | --- |
| success | Function | | 否 | 接口调用成功的回调函数 | uni.onKeyboardHeightChange(listener)
| fail | Function | | 否 | 接口调用失败的回调函数 | uni.offKeyboardHeightChange(listener) // 需传入与监听时同一个的函数对象
| complete | Function | | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | ```
**success 返回参数说明:** ### uni.getSelectedTextRange(OBJECT) @getselectedtextrange
| 属性 | 类型 | 说明 | 在input、textarea等focus之后,获取输入框的光标位置。注意:只有在focus的时候调用此接口才有效。目前仅支持 vue 页面,nvue 可以直接使用 weex 的 [getSelectionRange](https://weex.apache.org/zh/docs/components/input.html#getSelectionRange)
| --- | --- | --- |
| start | Number | 输入框光标起始位置 | **平台差异说明**
| end | Number | 输入框光标结束位置 |
|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序|
**示例代码** |:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|
|HBuilderX 2.8.12+|HBuilderX 2.8.12+|基础库 2.7.0+|x|x|x|x|√|x|
```js
uni.getSelectedTextRange({ **OBJECT 参数说明:**
success: res => {
console.log('getSelectedTextRange res', res.start, res.end) | 参数名 | 类型 | 默认值 | 必填 | 说明 |
} | --- | --- | --- | --- | --- |
}) | success | Function | | 否 | 接口调用成功的回调函数 |
``` | fail | Function | | 否 | 接口调用失败的回调函数 |
| complete | Function | | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
**success 返回参数说明:**
| 属性 | 类型 | 说明 |
| --- | --- | --- |
| start | Number | 输入框光标起始位置 |
| end | Number | 输入框光标结束位置 |
**示例代码**
```js
uni.getSelectedTextRange({
success: res => {
console.log('getSelectedTextRange res', res.start, res.end)
}
})
```
### uni.onAccelerometerChange(CALLBACK) ### uni.onAccelerometerChange(CALLBACK)
监听加速度数据,频率:5次/秒,接口调用后会自动开始监听,可使用 ``uni.offAccelerometer`` 取消监听。 监听加速度数据,频率:5次/秒,接口调用后会自动开始监听,可使用 ``uni.offAccelerometer`` 取消监听。
**CALLBACK 返回参数** **参数**
|参数|类型|说明| function listener
|:-|:-|:-|
|x|Number|X 轴| 加速度数据事件的监听函数
|y|Number|Y 轴|
|z|Number|Z 轴| **参数**
**Tips** Object res
- H5端获取加速度信息,需要部署在 **https** 服务上,本地预览(localhost)仍然可以使用 http 协议。 |参数|类型|说明|
|:-|:-|:-|
**示例** |x|Number|X 轴|
|y|Number|Y 轴|
```javascript |z|Number|Z 轴|
uni.onAccelerometerChange(function (res) {
console.log(res.x); **Tips**
console.log(res.y);
console.log(res.z); - H5端获取加速度信息,需要部署在 **https** 服务上,本地预览(localhost)仍然可以使用 http 协议。
});
``` **示例**
### uni.offAccelerometerChange(CALLBACK) ```javascript
取消监听加速度数据。 uni.onAccelerometerChange(function (res) {
console.log(res.x);
**平台差异说明** console.log(res.y);
console.log(res.z);
|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序| });
|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:| ```
|HBuilderX 2.9.6+|HBuilderX 2.9.6+|基础库 2.9.3+|x|x|x|x|√|√|
### uni.offAccelerometerChange(CALLBACK)
### uni.startAccelerometer(OBJECT) 取消监听加速度数据。
开始监听加速度数据。
**平台差异说明**
**平台差异说明**
|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序|
|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序| |:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|
|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:| |HBuilderX 2.9.6+|HBuilderX 2.9.6+|基础库 2.9.3+|x|x|x|x|√|√|
|√|√|√|x|√|√|√|√|√|
**参数**
**OBJECT 参数说明**
function listener
|参数名|类型|默认|必填|说明|平台差异说明|
|:-|:-|:-|:-|:-|:-| onAccelerometerChange 传入的监听函数。不传此参数则移除所有监听函数。
|interval|String|normal|否|监听加速度数据回调函数的执行频率|微信小程序、百度小程序、QQ小程序、快手小程序、京东小程序|
|success|Function||否|接口调用成功的回调|| **示例**
|fail|Function||否|接口调用失败的回调函数||
|complete|Function||否|接口调用结束的回调函数(调用成功、失败都会执行)| | ```javascript
const listener = function (res) { console.log(res) }
`interval` 的合法值
uni.onAccelerometerChange(listener)
|值|说明| uni.offAccelerometerChange(listener) // 需传入与监听时同一个的函数对象
|:-|:-| ```
|game|适用于更新游戏的回调频率,在 20ms/次 左右|
|ui|适用于更新 UI 的回调频率,在 60ms/次 左右|
|normal|普通的回调频率,在 200ms/次 左右| ### uni.startAccelerometer(OBJECT)
开始监听加速度数据。
**示例** **平台差异说明**
```javascript |App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序|
uni.startAccelerometer(); |:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|
``` |√|√|√|x|√|√|√|√|√|
### uni.stopAccelerometer(OBJECT) **OBJECT 参数说明**
停止监听加速度数据。
|参数名|类型|默认|必填|说明|平台差异说明|
**OBJECT 参数说明** |:-|:-|:-|:-|:-|:-|
|interval|String|normal|否|监听加速度数据回调函数的执行频率|微信小程序、百度小程序、QQ小程序、快手小程序、京东小程序|
|参数名|类型|必填|说明| |success|Function||否|接口调用成功的回调||
|:-|:-|:-|:-| |fail|Function||否|接口调用失败的回调函数||
|success|Function|否|接口调用成功的回调| |complete|Function||否|接口调用结束的回调函数(调用成功、失败都会执行)| |
|fail|Function|否|接口调用失败的回调函数|
|complete|Function|否|接口调用结束的回调函数(调用成功、失败都会执行)| `interval` 的合法值
**示例** |值|说明|
|:-|:-|
```javascript |game|适用于更新游戏的回调频率,在 20ms/次 左右|
uni.stopAccelerometer(); |ui|适用于更新 UI 的回调频率,在 60ms/次 左右|
``` |normal|普通的回调频率,在 200ms/次 左右|
**示例**
```javascript
uni.startAccelerometer();
```
### uni.stopAccelerometer(OBJECT)
停止监听加速度数据。
**OBJECT 参数说明**
|参数名|类型|必填|说明|
|:-|:-|:-|:-|
|success|Function|否|接口调用成功的回调|
|fail|Function|否|接口调用失败的回调函数|
|complete|Function|否|接口调用结束的回调函数(调用成功、失败都会执行)|
**示例**
```javascript
uni.stopAccelerometer();
```
### uni.onUserCaptureScreen(CALLBACK) ### uni.onUserCaptureScreen(CALLBACK)
监听用户主动截屏事件,用户使用系统截屏按键截屏时触发此事件。 监听用户主动截屏事件,用户使用系统截屏按键截屏时触发此事件。
**平台差异说明** **平台差异说明**
|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序| |App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序|
|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:| |:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|
|x|x|√|√|√|√|√|√|√| |x|x|√|√|√|√|√|√|√|
注:App没有内置截屏相关功能,可以在插件市场搜索相关插件,[详见](https://ext.dcloud.net.cn/search?q=%E6%88%AA%E5%B1%8F) 注:App没有内置截屏相关功能,可以在插件市场搜索相关插件,[详见](https://ext.dcloud.net.cn/search?q=%E6%88%AA%E5%B1%8F)
**CALLBACK返回参数:** **CALLBACK返回参数:**
**代码示例** **代码示例**
```javascript ```javascript
uni.onUserCaptureScreen(function() { uni.onUserCaptureScreen(function() {
console.log('用户截屏了') console.log('用户截屏了')
}); });
``` ```
### uni.offUserCaptureScreen(function callback) ### uni.offUserCaptureScreen(function callback)
用户主动截屏事件。取消事件监听。 用户主动截屏事件。取消事件监听。
**平台差异说明** **平台差异说明**
|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序| |App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序|
|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:| |:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|
|x|x|√|√|√|√|x|√|√| |x|x|√|√|√|√|x|√|√|
**参数** **参数**
|属性 | 类型|说明| |属性 | 类型|说明|
|-- |-- |-- | |-- |-- |-- |
|回调函数| Function|用户主动截屏事件的回调函数| |回调函数| Function|用户主动截屏事件的回调函数|
\ No newline at end of file
### uni.onCompassChange(CALLBACK) ### uni.onCompassChange(CALLBACK)
监听罗盘数据,频率:5次/秒,接口调用后会自动开始监听,可使用 ``uni.offCompassChange`` 取消监听。 监听罗盘数据,频率:5次/秒,接口调用后会自动开始监听,可使用 ``uni.offCompassChange`` 取消监听。
**CALLBACK 返回参数** **CALLBACK 返回参数**
|参数|类型|说明| |参数|类型|说明|
|:-|:-|:-| |:-|:-|:-|
|direction|Number|面对的方向度数| |direction|Number|面对的方向度数|
**Tips** **Tips**
- H5端获取罗盘信息,需要部署在 **https** 服务上,本地预览(localhost)仍然可以使用 http 协议。 - H5端获取罗盘信息,需要部署在 **https** 服务上,本地预览(localhost)仍然可以使用 http 协议。
**示例** **示例**
```javascript ```javascript
const callback = function (res) { const callback = function (res) {
console.log(res.direction); console.log(res.direction);
} }
uni.onCompassChange(callback); uni.onCompassChange(callback);
``` ```
### uni.offCompassChange(CALLBACK) ### uni.offCompassChange(CALLBACK)
取消监听罗盘数据。 取消监听罗盘数据。
**平台差异说明** **平台差异说明**
|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序| |App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序|
|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:| |:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|
|HBuilderX 2.9.6+|HBuilderX 2.9.6+|基础库 2.9.3+|x|x|x|x|√|x| |HBuilderX 2.9.6+|HBuilderX 2.9.6+|基础库 2.9.3+|x|x|x|x|√|x|
**示例** **示例**
```javascript ```javascript
const callback = function (res) { const callback = function (res) {
console.log(res.direction); console.log(res.direction);
} }
uni.onCompassChange(callback); uni.onCompassChange(callback);
// 和 onCompassChange 传入同一个函数即可 // 和 onCompassChange 传入同一个函数即可
uni.offCompassChange(callback); uni.offCompassChange(callback);
``` ```
**Tips** **Tips**
- `CALLBACK`为调用`uni.onCompassChange`时传入的`CALLBACK` - `CALLBACK`为调用`uni.onCompassChange`时传入的`CALLBACK`
### uni.startCompass(OBJECT) ### uni.startCompass(OBJECT)
开始监听罗盘数据。 开始监听罗盘数据。
**平台差异说明** **平台差异说明**
|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序| |App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序|
|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:| |:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|
|√|√|√|x|√|√|√|√|x| |√|√|√|x|√|√|√|√|x|
**OBJECT 参数说明** **OBJECT 参数说明**
|参数名|类型|必填|说明| |参数名|类型|必填|说明|
|:-|:-|:-|:-| |:-|:-|:-|:-|
|success|Function|否|接口调用成功的回调| |success|Function|否|接口调用成功的回调|
|fail|Function|否|接口调用失败的回调函数| |fail|Function|否|接口调用失败的回调函数|
|complete|Function|否|接口调用结束的回调函数(调用成功、失败都会执行)| |complete|Function|否|接口调用结束的回调函数(调用成功、失败都会执行)|
**示例** **示例**
```javascript ```javascript
uni.startCompass(); uni.startCompass();
``` ```
### uni.stopCompass(OBJECT) ### uni.stopCompass(OBJECT)
停止监听罗盘数据。 停止监听罗盘数据。
**OBJECT 参数说明** **OBJECT 参数说明**
|参数名|类型|必填|说明| |参数名|类型|必填|说明|
|:-|:-|:-|:-| |:-|:-|:-|:-|
|success|Function|否|接口调用成功的回调| |success|Function|否|接口调用成功的回调|
|fail|Function|否|接口调用失败的回调函数| |fail|Function|否|接口调用失败的回调函数|
|complete|Function|否|接口调用结束的回调函数(调用成功、失败都会执行)| |complete|Function|否|接口调用结束的回调函数(调用成功、失败都会执行)|
**示例** **示例**
```javascript ```javascript
uni.stopCompass(); uni.stopCompass();
``` ```
### uni.onMemoryWarning(CALLBACK) ### uni.onMemoryWarning(CALLBACK)
监听内存不足告警事件。 监听内存不足告警事件。
当 iOS/Android 向小程序进程发出内存警告时,触发该事件。Android 下有告警等级划分,iOS 无等级划分。 当 iOS/Android 向小程序进程发出内存警告时,触发该事件。Android 下有告警等级划分,iOS 无等级划分。
**平台差异说明** **平台差异说明**
|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序| |App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序|
|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:| |:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|
|x|x|√|√|√|x|√|√|√| |x|x|√|√|√|x|√|√|√|
**CALLBACK返回参数:** **CALLBACK返回参数:**
|参数名|类型|说明| |参数名|类型|说明|
|---|---|---| |---|---|---|
|level|Number|仅 Android 有该字段,对应系统内存告警等级宏定义| |level|Number|仅 Android 有该字段,对应系统内存告警等级宏定义|
**level 的合法值** **level 的合法值**
|值|说明| |值|说明|
|---|---| |---|---|
|5|TRIM_MEMORY_RUNNING_MODERATE| |5|TRIM_MEMORY_RUNNING_MODERATE|
|10|TRIM_MEMORY_RUNNING_LOW| |10|TRIM_MEMORY_RUNNING_LOW|
|15|TRIM_MEMORY_RUNNING_CRITICAL| |15|TRIM_MEMORY_RUNNING_CRITICAL|
**代码示例** **代码示例**
```javascript ```javascript
uni.onMemoryWarning(function () { const callback = function (res) {
console.log('onMemoryWarningReceive') console.log(res,'onMemoryWarningReceive');
}) }
``` uni.onMemoryWarning(callback);
```
### uni.offMemoryWarning(CALLBACK)
### uni.offMemoryWarning(CALLBACK)
取消监听内存不足告警事件。不传入 callback 则取消所有监听。
取消监听内存不足告警事件。不传入 callback 则取消所有监听。
**平台差异说明**
**平台差异说明**
|App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序|
|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:| |App|H5|微信小程序|支付宝小程序|百度小程序|字节跳动小程序、飞书小程序|QQ小程序|快手小程序|京东小程序|
|x|x|√|√|√|x|x|√|√| |:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|
|x|x|√|√|√|x|x|√|√|
**参数**
|属性 | 类型|说明|
|属性 | 类型|说明| |-- |-- |-- |
|-- |-- |-- | | 回调函数| Function|内存不足告警事件的回调函数|
| 回调函数| Function|内存不足告警事件的回调函数|
**代码示例**
```javascript
const callback = function (res) {
console.log(res);
}
uni.onMemoryWarning(callback);
// 和 onMemoryWarning 传入同一个函数即可
uni.offMemoryWarning(callback);
```
**Tips**
- `CALLBACK`为调用`uni.onMemoryWarning`时传入的`CALLBACK`
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册