微信小程序四 API

官方文檔：https://developers.weixin.qq.com/miniprogram/dev/api/

基礎

• wx.canIUse:判斷小程序的API，回調，參數，組件等是否在當前版本可用。
• wx.base64ToArrayBuffer:將 Base64 字符串轉成 ArrayBuffer 對象
• wx.arrayBufferToBase64:將 ArrayBuffer 對象轉成 Base64 字符串

系統

• wx.getSystemInfoSync:獲取系統信息
• wx.getSystemInfo(Object object):獲取系統信息

更新

• wx.getUpdateManager:獲取全局唯一的版本更新管理器，用於管理小程序更新。

生命週期

• wx.getLaunchOptionsSync:獲取小程序啓動時的參數。與 App.onLaunch 的回調參數一致。

應用級事件

• wx.onPageNotFound:監聽小程序要打開的頁面不存在事件。該事件與 App.onPageNotFound 的回調時機一致。
• wx.onError:監聽小程序錯誤事件。如腳本錯誤或 API 調用報錯等。該事件與 App.onError 的回調時機與參數一致。
• wx.onAudioInterruptionEnd:監聽音頻中斷結束事件。在收到 onAudioInterruptionBegin 事件之後，小程序內所有音頻會暫停，收到此事件之後纔可再次播放成功
• wx.onAudioInterruptionBegin:監聽音頻因爲受到系統佔用而被中斷開始事件。以下場景會觸發此事件：鬧鐘、電話、FaceTime 通話、微信語音聊天、微信視頻聊天。此事件觸發後，小程序內所有音頻會暫停。
• wx.onAppShow:監聽小程序切前臺事件。該事件與 App.onShow 的回調參數一致。
• wx.onAppHide:聽小程序切後臺事件。該事件與 App.onHide 的回調時機一致。
• wx.offPageNotFound:取消監聽小程序要打開的頁面不存在事件
• wx.offError:取消監聽小程序錯誤事件。
• wx.offAudioInterruptionEnd:取消監聽音頻中斷結束事件
• wx.offAudioInterruptionBegin:取消監聽音頻因爲受到系統佔用而被中斷開始事件
• wx.offAppShow:取消監聽小程序切前臺事件
• wx.offAppHide:取消監聽小程序切後臺事件

調試

• wx.setEnableDebug:設置是否打開調試開關。此開關對正式版也能生效。
• wx.getRealtimeLogManager:獲取實時日誌管理器對象。
• wx.getLogManager:獲取日誌管理器對象。

路由

• wx.switchTab:跳轉到 tabBar 頁面，並關閉其他所有非 tabBar 頁面
• wx.reLaunch:關閉所有頁面，打開到應用內的某個頁面
• wx.redirectTo:關閉當前頁面，跳轉到應用內的某個頁面。但是不允許跳轉到 tabbar 頁面。
• wx.navigateTo:保留當前頁面，跳轉到應用內的某個頁面。但是不能跳到 tabbar 頁面。使用 wx.navigateBack 可以返回到原頁面。小程序中頁面棧最多十層。
• wx.navigateBack:關閉當前頁面，返回上一頁面或多級頁面。可通過 getCurrentPages 獲取當前的頁面棧，決定需要返回幾層。
• EventChannel:頁面間事件通信通道

界面交互

• wx.showToast:顯示消息提示框
• wx.showModal:顯示模態對話框
• wx.showLoading:顯示 loading 提示框。需主動調用 wx.hideLoading 才能關閉提示框
• wx.showActionSheet:顯示操作菜單
• wx.hideToast:隱藏消息提示框
• wx.hideLoading:隱藏 loading 提示框

界面導航欄

• wx.showNavigationBarLoading:在當前頁面顯示導航條加載動畫
• wx.setNavigationBarTitle:動態設置當前頁面的標題
• wx.setNavigationBarColor:設置頁面導航條顏色
• wx.hideNavigationBarLoading:在當前頁面隱藏導航條加載動畫
• wx.hideHomeButton:隱藏返回首頁按鈕。

界面背景

• wx.setBackgroundTextStyle:動態設置下拉背景字體、loading 圖的樣式
• wx.setBackgroundColor:動態設置窗口的背景色

界面Tab Bar

• wx.showTabBarRedDot:顯示 tabBar 某一項的右上角的紅點
• wx.showTabBar:顯示 tabBar
• wx.setTabBarStyle:動態設置 tabBar 的整體樣式
• wx.setTabBarItem:動態設置 tabBar 某一項的內容，2.7.0 起圖片支持臨時文件和網絡文件。
• wx.setTabBarBadge:爲 tabBar 某一項的右上角添加文本
• wx.removeTabBarBadge:移除 tabBar 某一項右上角的文本
• wx.hideTabBarRedDot:隱藏 tabBar 某一項的右上角的紅點
• wx.hideTabBar:隱藏 tabBar

界面字體

• wx.loadFontFace:動態加載網絡字體。

界面下拉刷新

• wx.stopPullDownRefresh:停止當前頁面下拉刷新。
• wx.startPullDownRefresh:開始下拉刷新。調用後觸發下拉刷新動畫，效果與用戶手動下拉刷新一致。

界面滾動

• wx.pageScrollTo:將頁面滾動到目標位置，支持選擇器和滾動距離兩種方式定位

界面動畫

• wx.createAnimation:創建一個動畫實例 animation。調用實例的方法來描述動畫。最後通過動畫實例的 export 方法導出動畫數據傳遞給組件的 animation 屬性。
• Animation:動畫對象

界面置頂

• wx.setTopBarText:動態設置置頂欄文字內容。只有當前小程序被置頂時能生效，如果當前小程序沒有被置頂，也能調用成功，但是不會立即生效，只有在用戶將這個小程序置頂後才換上設置的文字內容.

界面自定義組件

• wx.nextTick:延遲一部分操作到下一個時間片再執行。（類似於 setTimeout）

界面菜單

• wx.getMenuButtonBoundingClientRect:獲取菜單按鈕（右上角膠囊按鈕）的佈局位置信息。座標信息以屏幕左上角爲原點。

界面窗口

• wx.onWindowResize:監聽窗口尺寸變化事件
• wx.offWindowResize:取消監聽窗口尺寸變化事件

界面鍵盤

• wx.onKeyboardHeightChange:監聽鍵盤高度變化
• wx.hideKeyboard:在input、textarea等focus拉起鍵盤之後，手動調用此接口收起鍵盤
• wx.getSelectedTextRange:在input、textarea等focus之後，獲取輸入框的光標位置。注意：只有在focus的時候調用此接口才有效。