API
框架提供丰富的API,可以方便的调起原生能力
说明
- uni.on 开头的 API 是监听某个事件发生的API接口，接受一个 CALLBACK 函数作为参数。当该事件触发时，会调用 CALLBACK 函数。
- 如未特殊约定，其他 API 接口都接受一个OBJECT作为参数。
- OBJECT中可以指定
success,fail,complete来接收接口调用结果。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| success | Function | 否 | 接口调用成功的回调函数 |
| fail | Function | 否 | 接口调用失败的回调函数 |
| complete | Function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
API列表
界面 API
| 说明 | 平台支持 | |
|---|---|---|
| uni.navigateTo | 新窗口打开页面 | all |
| uni.redirectTo | 原窗口打开页面 | all |
| uni.switchTab | 切换到tabbar页面 | all? |
| uni.navigateBack | 退回上一个页面 | all |
| uni.reLaunch | 关闭所有页面,打开指定页面 | all? |
| uni.setTitlebar | 设置当前页面标题栏 | all |
| uni.showTitlebarLoading | 显示标题栏加载动画 | u?,w,a |
| uni.hideTitlebarLoading | 隐藏标题栏加载动画 | u?,w,a |
| uni.showToast | 显示提示框 | all |
| uni.hideToast | 隐藏提示框 | all |
| uni.showLoading | 显示加载提示框 | all? |
| uni.hideLoading | 隐藏加载提示框 | all? |
| uni.showModal | 显示模态弹窗 | all |
| uni.showActionSheet | 显示菜单列表 | all |
| uni.startPullDownRefresh | 开始下拉刷新动画 | all? |
| uni.stopPullDownRefresh | 停止下拉刷新动画 | all? |