vscode miniapp helper
1.0.0
微信小程式開發助手for VSCode,程式碼提示+ 語法高亮
前綴 | 描述 |
---|---|
animation-backgroundColor | 設定背景色 |
animation-bottom | 底部距離 |
animation-height | 長度 |
animation-left | 左側距離 |
animation-matrix | 平面矩陣變換 |
animation-matrix3d | 立體矩陣變換 |
animation-opacity | 透明度,參數範圍0~1 |
animation-right | 右側距離 |
animation-rotate | 繞原點旋轉 |
animation-rotate3d | 3D 旋轉 |
animation-rotateX | 繞x 軸旋轉 |
animation-rotateY | 繞Y 軸旋轉 |
animation-rotateZ | 從Z 軸順時針旋轉一個角度 |
animation-scale | x軸[y軸]縮放。一個參數時,表示在X軸、Y軸兩個相同;兩個參數時表示在X軸,在Y軸不同 |
animation-scale3d | 3D 縮放 |
animation-scaleX | x 軸縮放 |
animation-scaleY | y 軸縮放 |
animation-scaleZ | z 軸縮放 |
animation-skew | x軸[y軸]傾斜。一個參數時,表示在X軸;兩個參數時表示在X軸,在Y軸 |
animation-skewX | x 軸傾斜 |
animation-skewY | y 軸傾斜 |
animation-top | 頂部距離 |
animation-translate | x軸[y軸]偏移。一個參數時,表示在X軸;兩個參數時表示在X軸,在Y軸 |
animation-translate3d | 3D 偏移 |
animation-translateX | x 軸偏移 |
animation-translateY | y 軸偏移 |
animation-translateZ | z 軸偏移 |
animation-width | 寬度 |
audioContext-pause | 暫停。 1.6.0 起不再維護 |
audioContext-play | 播放。 1.6.0 起不再維護 |
audioContext-seek | 跳到指定位置,單位s。 1.6.0 起不再維護 |
audioContext-setSrc | 設定音頻的地址。 1.6.0 起不再維護 |
backAudioManager-onCanplay | 背景音訊進入可以播放狀態,但不保證後面可以流暢播放 |
backAudioManager-onEnded | 背景音訊自然播放結束事件 |
backAudioManager-onError | 背景音訊播放錯誤事件 |
backAudioManager-onNext | 使用者在系統音樂播放面板點擊下一曲事件(iOS only) |
backAudioManager-onPause | 背景音訊暫停事件 |
backAudioManager-onPlay | 背景音訊播放事件 |
backAudioManager-onPrev | 使用者在系統音樂播放面板點擊上一曲事件(iOS only) |
backAudioManager-onStop | 背景音訊停止事件 |
backAudioManager-onTimeUpdate | 背景音訊播放進度更新事件 |
backAudioManager-onWaiting | 音訊載入中事件,當音訊因為資料不足,需要停下來載入時會觸發 |
backAudioManager-pause | 暫停 |
backAudioManager-play | 播放 |
backAudioManager-seek | 跳到指定位置,單位s。精確到小數點後3 位,即支援ms 等級精確度 |
backAudioManager-src | 音訊的資料來源,預設為空字串,當設定了新的src 時,會自動開始播放,目前支援的格式有m4a, aac, mp3, wav |
backAudioManager-stop | 停止 |
cameraContext-startRecord | 開始錄影 |
cameraContext-stopRecord | 結束錄像,成功則返回封面與視頻 |
cameraContext-takePhoto | 拍照,可指定質量(high, normal, low,預設normal),成功則回傳圖片 |
cvsCtx-addColorStop | 建立一個顏色的漸層 |
cvsCtx-arc | 畫一條弧線 |
cvsCtx-arcTo | 根據控制點和半徑繪製圓弧路徑 |
cvsCtx-beginPath | 開始建立一個路徑,需要呼叫fill 或stroke 才會使用路徑進行填滿或描邊 |
cvsCtx-bezierCurveTo | 建立三次方貝塞爾曲線路徑。曲線的起始點為路徑中前一個點 |
cvsCtx-clearRect | 清除畫布上在該矩形區域內的內容 |
cvsCtx-clip | 從原始畫布中剪下任意形狀和尺寸 |
cvsCtx-closePath | 關閉一個路徑 |
cvsCtx-createCircularGradient | 建立一個圓形的漸層顏色。需要使用addColorStop() 來指定漸層點,至少要兩個 |
cvsCtx-createLinearGradient | 建立一個線性的漸層顏色。需要使用addColorStop() 來指定漸層點,至少要兩個 |
cvsCtx-createPattern | 對指定的影像建立模式的方法,可在指定的方向上重複元影像 |
cvsCtx-draw | 將先前在繪圖上下文中的描述(路徑、變形、樣式)畫到canvas 中 |
cvsCtx-drawImage | 繪製圖像到畫布 |
cvsCtx-fill | 對目前路徑中的內容進行填充 |
cvsCtx-fillRect | 填滿一個矩形 |
cvsCtx-fillStyle | 設定填充色。基礎庫1.9.90 起支持 |
cvsCtx-fillText | 在畫布上繪製被填充的文本 |
cvsCtx-font | 設定目前字體樣式的屬性 |
cvsCtx-globalAlpha | 設定全域畫筆透明度。基礎庫1.9.90 起支持 |
cvsCtx-globalCompositeOperation | 此屬性是設定要在繪製新形狀時套用的合成操作的類型 |
cvsCtx-lineCap | 設定線條的端點樣式。基礎庫1.9.90 起支持 |
cvsCtx-lineDashOffset | 設定虛線偏移量的屬性 |
cvsCtx-lineJoin | 設定線條的交點樣式。基礎庫1.9.90 起支持 |
cvsCtx-lineTo | lineTo 方法增加一個新點,然後建立一條從上次指定點到目標點的線 |
cvsCtx-lineWidth | 設定線條的寬度。基礎庫1.9.90 起支持 |
cvsCtx-measureText | 測量文字尺寸信息,目前僅返回文字寬度。同步介面 |
cvsCtx-moveTo | 把路徑移到畫布中的指定點,不建立線條 |
cvsCtx-quadraticCurveTo | 建立二次貝塞爾曲線路徑。曲線的起始點為路徑中前一個點 |
cvsCtx-rect | 建立一個矩形 |
cvsCtx-restore | 恢復之前儲存的繪圖上下文 |
cvsCtx-rotate | 以原點為中心,原點可以用translate 方法修改。順時針旋轉目前座標軸 |
cvsCtx-save | 儲存目前的繪圖上下文 |
cvsCtx-scale | 在呼叫scale 方法後,之後建立的路徑其橫縱座標會被縮放。多次呼叫scale,倍數會相乘 |
cvsCtx-setFillStyle | 設定填充色 |
cvsCtx-setFontSize | 設定字體的字號 |
cvsCtx-setGlobalAlpha | 設定全域畫筆透明度 |
cvsCtx-setLineCap | 設定線條的端點樣式 |
cvsCtx-setLineDash | 設定線條的寬度 |
cvsCtx-setLineJoin | 設定線條的交點樣式 |
cvsCtx-setLineWidth | 設定線條的寬度 |
cvsCtx-setMiterLimit | 設定最大斜接長度,斜接長度指的是兩條線交會處內角和外角之間的距離。 當setLineJoin() 為miter 時才有效 |
cvsCtx-setShadow | 設定陰影樣式 |
cvsCtx-setStrokeStyle | 設定邊框顏色 |
cvsCtx-setTextAlign | 用於設定文字的對齊 |
cvsCtx-setTextBaseline | 用於設定文字的水平對齊 |
cvsCtx-setTransform | 使用矩陣重新設定(覆蓋)目前變換的方法 |
cvsCtx-shadowBlur | 設定陰影的模糊級別 |
cvsCtx-shadowColor | 設定陰影的顏色 |
cvsCtx-shadowOffsetX | 設定陰影相對於形狀在水平方向的偏移 |
cvsCtx-shadowOffsetY | 設定陰影相對於形狀在垂直方向的偏移 |
cvsCtx-stroke | 畫出目前路徑的邊框 |
cvsCtx-strokeRect | 畫一個矩形(非填充) |
cvsCtx-strokeStyle | 設定邊框顏色。基礎庫1.9.90 起支持 |
cvsCtx-strokeText | 給定的(x, y) 位置繪製文字描邊的方法 |
cvsCtx-textAlign | 用於設定文字的對齊,基礎庫1.9.90 起支持 |
cvsCtx-textBaseline | 用於設定文字的水平對齊,基礎庫1.9.90 起支持 |
cvsCtx-translate | 將目前座標系的原點(0, 0)進行變換,預設的座標係原點為頁面左上角 |
downTask-abort | 中斷下載任務 |
downTask-onProgressUpdate | 監聽下載進度變更事件 |
fileManager-access | 判斷檔案/目錄是否存在 |
fileManager-accessSync | 判斷檔案/目錄是否存在,同步介面 |
fileManager-appendFile | 在檔案結尾追加內容 |
fileManager-appendFileSync | 在檔案結尾追加內容,同步介面 |
fileManager-copyFile | 複製文件 |
fileManager-copyFileSync | 複製文件,同步介面 |
fileManager-getFileInfo | 取得該小程式下的本機暫存檔案或本機快取檔案信息 |
fileManager-getSavedFileList | 取得該小程式下已儲存的本機快取檔案列表 |
fileManager-mkdir | 建立目錄 |
fileManager-mkdirSync | 建立目錄,同步介面 |
fileManager-readFile | 讀取本機檔案內容 |
fileManager-readFileSync | 讀取本機檔案內容,同步介面 |
fileManager-readdir | 讀取目錄內檔案列表 |
fileManager-readdirSync | 讀取目錄內文件列表,同步介面 |
fileManager-removeSavedFile | 刪除該小程式下已儲存的本機快取文件 |
fileManager-rename | 重新命名文件,可以把文件從oldPath 移到newPath |
fileManager-renameSync | 重新命名文件,可以把文件從oldPath 移動到newPath,同步接口 |
fileManager-rmdir | 刪除目錄 |
fileManager-rmdirSync | 刪除目錄,同步介面 |
fileManager-saveFile | 儲存臨時檔案到本地。此介面會移動暫存文件,因此呼叫成功後,tempFilePath 將無法使用 |
fileManager-saveFileSync | 儲存臨時檔案到本地。此介面會移動暫存文件,因此呼叫成功後,tempFilePath 將不可用,同步介面 |
fileManager-stat | 取得檔案Stats 對象 |
fileManager-statSync | 取得檔案Stats 對象,同步介面 |
fileManager-unlink | 刪除文件 |
fileManager-unlinkSync | 刪除檔案,同步介面 |
fileManager-unzip | 解壓縮文件 |
fileManager-writeFile | 寫文件 |
fileManager-writeFileSync | 寫文件,同步介面 |
fileStat-isDirectory | 判斷目前檔案是否一個目錄 |
fileStat-isFile | 判斷目前文件是否一個普通文件 |
getApp | 取得小程式實例 |
getCurrentPages | 取得當前頁面堆疊 |
innerAudioContext-destroy | 銷毀目前實例 |
innerAudioContext-offCanplay | 取消監聽onCanplay 事件 |
innerAudioContext-offEnded | 取消監聽onEnded 事件 |
innerAudioContext-offError | 取消監聽onError 事件 |
innerAudioContext-offPlay | 取消監聽onPlay 事件 |
innerAudioContext-offSeeked | 取消監聽onSeeked 事件 |
innerAudioContext-offSeeking | 取消監聽onSeeking 事件 |
innerAudioContext-offStop | 取消監聽onStop 事件 |
innerAudioContext-offTimeUpdate | 取消監聽onTimeUpdate 事件 |
innerAudioContext-offWaiting | 取消監聽onWaiting 事件 |
innerAudioContext-onCanplay | 音訊進入可以播放狀態,但不保證後面可以流暢播放 |
innerAudioContext-onEnded | 音訊自然播放結束事件 |
innerAudioContext-onError | 音訊播放錯誤事件 |
innerAudioContext-onPause | 音訊暫停播放事件 |
innerAudioContext-onPlay | 音訊播放事件 |
innerAudioContext-onSeeked | 音訊完成seek 操作事件 |
innerAudioContext-onSeeking | 音訊進行seek 操作事件 |
innerAudioContext-onStop | 音訊停止播放事件 |
innerAudioContext-onTimeUpdate | 音訊播放進度更新事件 |
innerAudioContext-onWaiting | 音訊載入中事件,當音訊因為資料不足,需要停下來載入時會觸發 |
innerAudioContext-pause | ???? |
innerAudioContext-play | 播放 |
innerAudioContext-seek | 跳到指定位置,單位s。精確到小數點後3 位,即支援ms 等級精確度 |
innerAudioContext-stop | 停止 |
interObser-disconnect | 停止監聽,回呼函數將不再觸發 |
interObser-observe | 指定目標節點並開始監聽相交狀態變更狀況 |
interObser-relativeTo | 使用選擇器指定一個節點,作為參考區域之一 |
interObser-relativeToViewport | 指定頁面顯示區域作為參考區域之一 |
livePlayerContext-exitFullScreen | 退出全螢幕 |
livePlayerContext-mute | 靜音 |
livePlayerContext-pause | 暫停 |
livePlayerContext-play | 播放 |
livePlayerContext-requestFullScreen | 進入全螢幕 |
livePlayerContext-resume | 恢復 |
livePlayerContext-stop | 停止 |
livePusherContext-pause | 暫停推流 |
livePusherContext-play | 播放推流 |
livePusherContext-resume | 恢復推流 |
livePusherContext-snapshot | 快照 |
livePusherContext-stop | 停止推流 |
livePusherContext-switchCamera | 切換前後相機 |
livePusherContext-toggleTorch | 切換閃光燈 |
logger-debug | 寫debug 日誌,可以提供任一參數 |
logger-info | 寫info 日誌,可以提供任一參數 |
logger-log | 寫log 日誌,可以提供任一參數 |
logger-warn | 寫warn 日誌,可以提供任一參數 |
mapContext-getCenterLocation | 取得目前地圖中心的經緯度,回傳的是gcj02 座標系,可以用於wx.openLocation |
mapContext-getRegion | 取得目前地圖的視野範圍 |
mapContext-getScale | 取得當前地圖的縮放級別 |
mapContext-includePoints | 縮放視野展示所有經緯度 |
mapContext-moveToLocation | 將地圖中心移動到目前定位點,需要配合map 元件的show-location 使用 |
mapContext-translateMarker | 平移marker,附動畫 |
recordManager-onError | 錄音錯誤事件, 會回呼錯誤訊息 |
recordManager-onFrameRecorded | 已錄製完指定影格大小的文件,會回呼錄音分片結果數據 |
recordManager-onPause | 錄音暫停事件 |
recordManager-onStart | 錄音開始事件 |
recordManager-onStop | 錄音停止事件,會回呼檔案位址 |
recordManager-pause | 暫停錄音 |
recordManager-resume | 恢復錄音 |
recordManager-start | ?? |
recordManager-stop | 停止錄音 |
reqTask-abort | 中斷請求任務 |
selQuery-exec | 執行所有的請求,請求結果按請求次序構成數組,在callback 的第一個參數中返回 |
selQuery-in | 將選擇器的選取範圍變更為自訂元件component 內(初始時,選擇器僅選取頁面範圍的節點,不會選取任何自訂元件中的節點) |
selQuery-select | 在目前頁面下選擇第一個符合選擇器selector 的節點,傳回一個NodesRef 物件實例,可以用來取得節點資訊 |
selQuery-selectAll | 在目前頁面下選擇符合選擇器selector 的所有節點 |
selQuery-selectViewport | 選擇顯示區域,可用於取得顯示區域的尺寸、捲動位置等信息 |
sockTask-close | 關閉WebSocket 連接 |
sockTask-onClose | 監聽WebSocket 連線關閉事件 |
sockTask-onError | 監聽WebSocket 錯誤 |
sockTask-onMessage | 監聽WebSocket 接受到伺服器的訊息事件 |
sockTask-onOpen | 監聽WebSocket 連線開啟事件 |
sockTask-send | 透過WebSocket 連線發送數據 |
upTask-abort | 中斷上傳任務 |
upTask-onProgressUpdate | 監聽上傳進度變更事件 |
updateManager-applyUpdate | 當新版本下載完成,呼叫該方法會強制當前小程式應用新版本並重新啟動 |
updateManager-onCheckForUpdate | 當向微信後台請求完新版訊息,會進行回調 |
updateManager-onUpdateFailed | 當新版本下載失敗,會進行回調 |
updateManager-onUpdateReady | 當新版本下載完成,會進行回調 |
videoContext-exitFullScreen | 退出全螢幕 |
videoContext-hideStatusBar | 隱藏狀態列,僅在iOS 全螢幕下有效 |
videoContext-pause | 暫停 |
videoContext-play | 播放 |
videoContext-playbackRate | 設定倍速播放,支援的倍率有0.5/0.8/1.0/1.25/1.5 |
videoContext-requestFullScreen | 進入全屏,可傳入direction 參數, 有效值為0, 90, -90 |
videoContext-seek | 跳到指定位置,單位s |
videoContext-sendDanmu | 發送彈幕,包含兩個屬性text, color |
videoContext-showStatusBar | 顯示狀態列,僅在iOS 全螢幕下有效 |
videoContext-stop | 停止 |
worker-onMessage | 監聽Worker 執行緒向目前執行緒發送的訊息 |
worker-postMessage | 向Worker 線程發送的訊息 |
worker-terminate | 結束目前Worker 線程,僅限在主線程Worker 實例上調用 |
wx-addCard | 批量添加卡券 |
wx-addPhoneContact | 呼叫後,使用者可以選擇將該表單以「新增聯絡人」或「新增至已有聯絡人」的方式,寫入手機系統通訊錄,完成手機通訊錄聯絡人和聯絡人的方式增加。此API 參數非常多,請參考文檔 |
wx-authorize | 提前向使用者發起授權請求。呼叫後會立刻彈出視窗詢問使用者是否同意授權小程式使用某項功能或取得使用者的某些數據,但不會實際呼叫對應介面。如果使用者之前已經同意授權,則不會出現彈跳窗,直接返回成功 |
wx-canIUse | 判斷小程式的API,回調,參數,元件等是否在目前版本可用 |
wx-canvasGetImageData | 傳回一個數組,用來描述canvas 區域隱含的像素數據 |
wx-canvasPutImageData | 將像素資料繪製到畫布的方法 |
wx-canvasToTempFilePath | 把目前畫布指定區域的內容匯出產生指定大小的圖片,並返回檔案路徑 |
wx-checkIsSoterEnrolledInDevice | 取得設備內是否輸入如指紋等生物資訊的接口 |
wx-checkIsSupportSoterAuthentication | 取得本機支援的SOTER 生物認證方式 |
wx-checkSession | 校驗使用者目前session_key 是否有效 |
wx-chooseAddress | 調起使用者編輯收貨地址原生介面,並在編輯完成後回傳使用者選擇的地址 |
wx-chooseImage | 從本地相簿選擇圖片或使用相機拍照 |
wx-chooseInvoice | 選擇用戶已有的發票 |
wx-chooseInvoiceTitle | 選擇用戶的發票抬頭 |
wx-chooseLocation | 打開地圖選擇位置。需要使用者授權scope.userLocation |
wx-chooseVideo | 拍攝視頻或從手機相簿中選視頻,返回視頻的臨時文件路徑 |
wx-clearStorage | 非同步清除本地資料快取 |
wx-clearStorageSync | 同步清除本機資料快取 |
wx-closeBLEConnection | 中斷與低功耗藍牙裝置的連接 |
wx-closeBluetoothAdapter | 關閉藍牙模組,使其進入未初始化狀態。呼叫該方法將斷開所有已建立的連結並釋放系統資源 |
wx-closeSocket | 關閉WebSocket 連接 |
wx-connectSocket | 建立一個WebSocket 連接 |
wx-connectWifi | 連接WiFi。若已知WiFi 訊息,可以直接利用此介面連接 |
wx-createAnimation | 建立一個動畫實例animation。呼叫實例的方法來描述動畫 |
wx-createAudioContext | 建立並傳回audio 上下文audioContext 物件。在自訂元件下,第二個參數傳入元件實例this,以操作元件內<audio/> 元件。 1.6.0 起不再維護 |
wx-createBLEConnection | 連接低功耗藍牙設備 |
wx-createCameraContext | 建立並返回camera 上下文cameraContext 對象,cameraContext 與頁面的camera 元件綁定,一個頁面只能有一個camera,透過它可以操作對應的<camera/> 元件。 1.6.0 開始支持 |
wx-createCanvasContext | 建立canvas 繪圖上下文(指定canvasId) |
wx-createInnerAudioContext | 建立並傳回內部audio 上下文innerAudioContext 物件。本介面是wx.createAudioContext 升級版。 1.6.0 開始支持 |
wx-createIntersectionObserver | 建立並傳回一個IntersectionObserver 物件實例 |
wx-createLivePlayerContext | 操作對應的<live-player/> 元件。 建立並傳回live-player 上下文LivePlayerContext 物件。在自訂元件下,第二個參數傳入元件實例this,以操作元件內<live-player/> 元件 |
wx-createLivePusherContext | 建立並返回live-pusher 上下文LivePusherContext 對象,LivePusherContext 與頁面的<live-pusher /> 元件綁定,一個頁面只能有一個live-pusher,透過它可以操作對應的<live-pusher/> 元件。 在自訂元件下,第一個參數傳入元件實例this,以操作元件內<live-pusher/> 元件 |
wx-createMapContext | 建立並傳回map 上下文mapContext 物件。在自訂元件下,第二個參數傳入元件實例this,以操作元件內<map/> 元件 |
wx-createSelectorQuery | 傳回一個SelectorQuery 物件實例 |
wx-createVideoContext | 建立並傳回video 上下文videoContext 物件。在自訂元件下,第二個參數傳入元件實例this,以操作元件內<video/> 元件 |
wx-createWorker | 建立一個Worker 線程,並回傳Worker 實例,目前限制最多只能建立一個Worker,建立下一個Worker 前請呼叫Worker.terminate |
wx-downloadFile | 下載檔案資源到本地,客戶端直接發起一個HTTP GET 請求,返回檔案的本地臨時路徑 |
wx-faceVerifyForPay | 支付各個安全場景驗證人臉 |
wx-getAccountInfoSync | 取得目前帳號資訊 |
wx-getAvailableAudioSources | 取得目前支援的音訊輸入來源 |
wx-getBLEDeviceCharacteristics | 取得藍牙裝置某個服務中的所有characteristic(特徵值) |
wx-getBLEDeviceServices | 取得藍牙設備所有service(服務) |
wx-getBackgroundAudioManager | 取得全域唯一的背景音訊管理器backgroundAudioManager |
wx-getBackgroundAudioPlayerState | 取得後台音樂播放狀態。 1.2.0 起不再維護 |
wx-getBeacons | 取得所有已搜尋的iBeacon 設備 |
wx-getBluetoothAdapterState | 取得本機藍牙適配器狀態 |
wx-getBluetoothDevices | 取得在小程式藍牙模組生效期間所有已發現的藍牙設備,包括已經和本機處於連線狀態的設備 |
wx-getClipboardData | 取得系統剪貼簿內容 |
wx-getConnectedBluetoothDevices | 根據uuid 取得處於已連線狀態的裝置 |
wx-getConnectedWifi | 取得已連線中的WiFi 訊息 |
wx-getExtConfig | 取得第三方平台自訂的資料字段 |
wx-getExtConfigSync | 同步取得第三方平台自訂的資料字段 |
wx-getFileSystemManager | 取得全域唯一的檔案管理器 |
wx-getHCEState | 判斷目前設備是否支援HCE 能力 |
wx-getImageInfo | 取得圖片訊息,倘若為網路圖片,需先設定download 網域才能生效 |
wx-getLocation | 取得目前的地理位置、速度 |
wx-getLogManager | 取得日誌管理器logManager 對象 |
wx-getMenuButtonBoundingClientRect | 取得選單按鈕的佈局置信息 |
wx-getNetworkType | 取得網路類型 |
wx-getRecorderManager | 取得全域唯一的錄音管理器recorderManager |
wx-getSavedFileInfo | 取得本地文件的文件資訊。此介面只能用於取得已儲存至本機的文件,若需要取得暫存文件信息,請使用wx.getFileInfo 介面 |
wx-getSavedFileList | 取得本機已儲存的檔案列表 |
wx-getScreenBrightness | 取得螢幕亮度 |
wx-getSetting | 取得用戶的目前設置 |
wx-getShareInfo | 獲取轉發詳細信息 |
wx-getStorage | 從本機快取中非同步取得指定key 對應的內容 |
wx-getStorageInfo | 異步獲取當前storage 的相關信息 |
wx-getStorageInfoSync | 同步取得當前storage 的相關信息 |
wx-getStorageSync | 從本機快取中同步取得指定key 對應的內容 |
wx-getSystemInfo | 異步獲取系統信息 |
wx-getSystemInfoSync | 取得系統資訊同步介面 |
wx-getUpdateManager | 取得全域唯一的版本更新管理器,用於管理小程式更新 |
wx-getUserInfo | 當使用者未授權過,呼叫該介面將直接報錯;當使用者授權過,可以使用該介面取得使用者資訊 |
wx-getWeRunData | 取得用戶過去三十天微信運動步數,需要先呼叫wx.login 介面 |
wx-getWifiList | 請求獲取WiFi列表,在onGetWifiList 註冊的回呼中返回wifiList 數據 |
wx-hideLoading | 隱藏loading 提示框 |
wx-hideNavigationBarLoading | 隱藏導航條載入動畫 |
wx-hideShareMenu | 隱藏轉發按鈕 |
wx-hideTabBar | ?? tabBar |
wx-hideTabBarRedDot | 隱藏tabBar 某一項的右上角的紅點 |
wx-hideToast | 隱藏訊息提示框 |
wx-loadFontFace | 動態載入網頁字體 |
wx-login | 呼叫介面wx.login() 取得臨時登入憑證(code) |
wx-makePhoneCall | 撥打電話 |
wx-navigateBack | 關閉目前頁面,返回上一頁或多級頁面。可透過getCurrentPages()) 取得目前的頁面棧,決定需要傳回幾層 |
wx-navigateBackMiniProgram | 返回上一個小程序,只有在當前小程序是被其他小程序打開時可以調用成功 |
wx-navigateTo | 保留目前頁面,跳到應用程式內的某個頁面,使用wx.navigateBack 可以回到原始頁面。目前頁面路徑最多只能十層 |
wx-navigateToMiniProgram | 打開同一公眾號下關聯的另一個小程序 |
wx-nextTick | 用於延遲一部分操作到下一個時間片再執行 |
wx-notifyBLECharacteristicValueChange | 啟用低功耗藍牙裝置特徵值變更時的notify 功能,訂閱特徵值。注意:必須設備的特徵值支援notify 或indicate 才可以成功調用,具體參考characteristic 的properties 屬性 |
wx-offWindowResize | 取消監聽視窗尺寸變更事件 |
wx-onAccelerometerChange | 監聽加速度數據,頻率:5 次/秒,介面呼叫後會自動開始監聽,可使用wx.stopAccelerometer 停止監聽 |
wx-onBLECharacteristicValueChange | 監聽低功耗藍牙裝置的特徵值變化。必須先啟用notify 介面才能接收到裝置推送的notification |
wx-onBLEConnectionStateChange | 監聽低功耗藍牙連接狀態的改變事件,包括開發者主動連接或斷開連接,設備丟失,連接異常斷開等等 |
wx-onBackgroundAudioPause | 監聽音樂暫停。 1.2.0 起不再維護 |
wx-onBackgroundAudioPlay | 監聽音樂播放。 1.2.0 起不再維護 |
wx-onBackgroundAudioStop | 監聽音樂停止。 1.2.0 起不再維護 |
wx-onBeaconServiceChange | 監聽iBeacon 服務的狀態變化 |
wx-onBeaconUpdate | 監聽iBeacon 設備的更新事件 |
wx-onBluetoothAdapterStateChange | 監聽藍牙適配器狀態變化事件 |
wx-onBluetoothDeviceFound | 監聽尋找到新設備的事件 |
wx-onCompassChange | 監聽羅盤數據,頻率:5 次/秒,介面呼叫後會自動開始監聽,可使用wx.stopCompass 停止監聽 |
wx-onGetWifiList | 監聽在取得到WiFi 清單資料時的事件,在回呼中將回傳wifiList |
wx-onHCEMessage | 監聽NFC 設備的訊息回調,並在回調中處理 |
wx-onMemoryWarning | 監聽記憶體不足的警告事件,Android 下有警告等級劃分,只有LOW 和CRITICAL 會回調開發者;iOS 無等級劃分 |
wx-onNetworkStatusChange | 監聽網路狀態變化 |
wx-onSocketClose | 監聽WebSocket 關閉 |
wx-onSocketError | 監聽WebSocket 錯誤 |
wx-onSocketMessage | 監聽WebSocket 接受到伺服器的訊息事件 |
wx-onSocketOpen | 監聽WebSocket 連線開啟事件 |
wx-onUserCaptureScreen | 監聽使用者主動截圖事件,使用者使用系統截圖按鍵截圖時觸發此事件 |
wx-onWifiConnected | 監聽連線上WiFi 的事件 |
wx-onWindowResize | 監聽視窗尺寸變化事件 |
wx-openBluetoothAdapter | 初始化小程式藍牙模組,生效週期為呼叫wx.openBluetoothAdapter 至呼叫wx.closeBluetoothAdapter 或小程式被銷毀為止 |
wx-openCard | 查看微信卡包中的卡券 |
wx-openDocument | 新開頁面開啟文檔,支援格式:doc, xls, ppt, pdf, docx, xlsx, pptx |
wx-openLocation | 使用微信內建地圖查看位置,需要使用者授權scope.userLocation |
wx-openSetting | 調起客戶端小程式設定介面,返回使用者設定的操作結果 |
wx-pageScrollTo | 將頁面捲動到目標位置 |
wx-pauseBackgroundAudio | 暫停播放音樂,1.2.0 起不再維護 |
wx-pauseVoice | 暫停正在播放的語音,1.6.0 起不再維護 |
wx-playBackgroundAudio | 使用後台播放器播放音樂,對於微信客戶端來說,只能同時有一個後台音樂在播放。 1.2.0 起不再維護 |
wx-playVoice | 開始播放語音,同時只允許一個語音檔案正在播放,如果前一個語音檔案還沒播放完,就會中斷前一個語音播放。 1.6.0 起不再維護 |
wx-previewImage | 預覽圖片 |
wx-reLaunch | 關閉所有頁面,開啟到應用程式內的某個頁面 |
wx-readBLECharacteristicValue | 讀取低功耗藍牙裝置的特徵值的二進位資料值。注意:必須設備的特徵值支援read 才可以成功調用,具體參考characteristic 的properties 屬性 |
wx-redirectTo | 關閉目前頁面,跳到應用程式內的某個頁面 |
wx-removeSavedFile | 刪除本地儲存的文件 |
wx-removeStorage | 從本機快取中非同步移除指定key |
wx-removeStorageSync | 從本機快取中同步移除指定key |
wx-removeTabBarBadge | 移除tabBar 某一項右上角的文本 |
wx-reportMonitor | 自訂業務資料監控上報接口 |
wx-request | 發起網路請求 |
wx-requestPayment | 發起微信支付 |
wx-saveFile | 儲存檔案到本機。注意:saveFile 會把臨時檔案移動,因此呼叫成功後傳入的tempFilePath 將無法使用 |
wx-saveImageToPhotosAlbum | 儲存圖片到系統相簿。需要使用者授權scope.writePhotosAlbum |
wx-saveVideoToPhotosAlbum | 儲存影片到系統相簿。需要使用者授權scope.writePhotosAlbum |
wx-scanCode | 調起客戶端掃碼介面,掃碼成功後回傳對應的結果 |
wx-seekBackgroundAudio | 控制音樂播放進度(秒)。 1.2.0 起不再維護 |
wx-sendHCEMessage | 發送NFC 訊息。僅在安卓系統下有效 |
wx-sendSocketMessage | 透過WebSocket 連線發送數據,需要先wx.connectSocket,並在wx.onSocketOpen 回呼之後才能發送 |
wx-setBackgroundColor | 動態設定視窗的背景色 |
wx-setBackgroundTextStyle | 動態設定下拉背景字型、loading 圖的樣式 |
wx-setClipboardData | 設定係統剪貼簿的內容 |
wx-setEnableDebug | 設定是否開啟調試開關,此開關對正式版也能生效 |
wx-setKeepScreenOn | 設定是否保持常亮狀態。僅在目前小程式生效,離開小程式後設定失效 |
wx-setNavigationBarColor | 設定導覽列顏色 |
wx-setNavigationBarTitle | 動態設定目前頁面的標題 |
wx-setScreenBrightness | 設定螢幕亮度 |
wx-setStorage | 將資料儲存在本機快取中指定的key 中,會覆寫原來該key 對應的內容,這是一個非同步介面 |
wx-setStorageSync | 將data 儲存在本機快取中指定的key 中,會覆寫原來該key 對應的內容,這是一個同步介面 |
wx-setTabBarBadge | 為tabBar某一項的右上角加上文本 |
wx-setTabBarItem | 動態設定tabBar 某一項的內容 |
wx-setTabBarStyle | 動態設定tabBar 的整體樣式 |
wx-setTopBarText | 動態設定置頂欄文字內容,只有當前小程式被置頂時能生效,如果當前小程式沒有被置頂,也能呼叫成功,但是不會立即生效,只有在用戶將這個小程式置頂後才換上設定的文字內容 |
wx-setWifiList | iOS 特有接口,在onGetWifiList 回呼後,利用接口設定wifiList 中AP 的相關訊息 |
wx-showActionSheet | 顯示操作選單 |
wx-showLoading | 顯示loading 提示框, 需主動呼叫wx.hideLoading 才能關閉提示框 |
wx-showModal | 顯示模態彈窗 |
wx-showNavigationBarLoading | 在目前頁面顯示導航條載入動畫 |
wx-showShareMenu | 顯示目前頁面的轉發按鈕 |
wx-showTabBar | ?? tabBar |
wx-showTabBarRedDot | 顯示tabBar 某一項的右上角的紅點 |
wx-showToast | 顯示訊息提示框 |
wx-startAccelerometer | 開始監聽加速度數據 |
wx-startBeaconDiscovery | 開始搜尋附近的iBeacon 設備 |
wx-startBluetoothDevicesDiscovery | 開始搜尋附近的藍牙週邊設備。請注意,此操作比較耗費系統資源,請在搜尋並連接到裝置後呼叫stop 方法停止搜尋 |
wx-startCompass | 開始監聽羅盤資料。 |
wx-startHCE | 初始化NFC 模組 |
wx-startPullDownRefresh | 開始下拉刷新,呼叫後觸發下拉刷新動畫,效果與使用者手動下拉刷新一致 |
wx-startRecord | 開始錄音。需要使用者授權scope.record。 1.6.0 起不再維護 |
wx-startSoterAuthentication | 開始SOTER 生物認證 |
wx-startWifi | 初始化WiFi 模組 |
wx-stopAccelerometer | 停止監聽加速度數據 |
wx-stopBackgroundAudio | 停止播放音樂。 1.2.0 起不再維護 |
wx-stopBeaconDiscovery | 停止搜尋附近的iBeacon 設備 |
wx-stopBluetoothDevicesDiscovery | 停止搜尋附近的藍牙週邊設備。若已找到需要的藍牙裝置並不需要繼續搜尋時,建議呼叫該介面停止藍牙搜尋 |
wx-stopCompass | 停止監聽羅盤資料。 |
wx-stopHCE | 關閉NFC 模組。僅在安卓系統下有效 |
wx-stopPullDownRefresh | 停止當前頁面下拉刷新 |
wx-stopRecord | 停止錄音。 1.6.0 起不再維護 |
wx-stopVoice | 結束播放語音。 1.6.0 起不再維護 |
wx-stopWifi | 關閉WiFi 模組 |
wx-switchTab | 跳到tabBar 頁面,並關閉其他所有非tabBar 頁面 |
wx-updateShareMenu | 更新轉送屬性 |
wx-uploadFile | 將本機資源上傳到開發者伺服器,客戶端發起HTTPS POST 請求,其中content-type 為multipart/form-data |
wx-vibrateLong | 使手機發生較長時間的震動(400ms) |
wx-vibrateShort | 使手機發生較短時間的震動(15ms) |
wx-writeBLECharacteristicValue | 寫入二進位資料到低功耗藍牙裝置特徵值。注意:必須裝置的特徵值支援write 才能成功調用,具體參考characteristic 的properties 屬性 |
wx-Component | Component 物件及其生命週期函數與回呼函數 |
wx-app | App 物件及其生命週期函數和回呼函數 |
wx-page | Page 物件及其生命週期函數與回呼函數 |
前綴 | 描述 |
---|---|
debug | App 對應的JSON 檔案debug 配置項,是否為偵錯模式 |
functionalPages | 是否啟用插件功能頁 |
networktimeout | App 對應的JSON 檔案networktimeout 設定項,逾時設定 |
pages | App 對應的JSON 檔案pages 設定項 |
plugins | 使用到的插件 |
preloadRule | 分包預下載規則 |
requiredBackgroundModes | 需要在後台使用的能力,如“音樂播放” |
resizable | iPad 小程式是否支援螢幕旋轉,預設為關閉 |
subPackages | App 對應的JSON 檔案subPackages 配置項,分包結構配置 |
tabbar | App 對應的JSON 檔案tabbar 設定項 |
window | App 對應的JSON 檔案window 設定項 |
workers | Worker 程式碼放置的目錄 |
page | Page 頁面對應的JSON 檔案設定項 |
前綴 | 描述 |
---|---|
ad | 廣告 |
audio | 音頻。 1.6.0 版本開始,此元件不再維護 |
block | block 標籤,不是元件,只是包裝元素,不會在頁面中做任何渲染,只接受控制屬性 |
button | 按鈕 |
camera | 系統相機。需要使用者授權scope.camera |
canvas | 畫布 |
checkbox-group | 多項選擇器,內部由多個checkbox 組成 |
checkbox | 多選項目 |
cover-image | 覆蓋在原生組件之上的圖片視圖,可覆蓋的原生組件同cover-view,支援嵌套在cover-view 裡 |
cover-view | 覆蓋在原生元件之上的文字視圖,可覆寫的原生元件包括map、video、canvas、camera、live-player、live-pusher,只支援嵌套cover-view、cover-image,可在cover-view 中使用button |
form | 表單,將元件內的使用者輸入的<switch/> 、 <input/> 、 <checkbox/> 、 <slider/> 、 <radio/> <picker/> 提交 |
functional-page-navigator | 頁面連結 |
icon | 圖示 |
image | 圖片。預設寬度300px、高度225px。 image 元件中二維碼/小程式碼圖片不支援長按識別 |
input | 輸入框 |
label | 用來改進表單元件的可用性,使用for 屬性找到對應的id,或將控制項放在該標籤下,當點擊時,就會觸發對應的控制項。 for 優先權高於內部控件,內部有多個控件的時候預設觸發第一個控件。目前可以綁定的控制項有<button/> 、 <checkbox/> 、 <radio/> 、 <switch/> |
live-player | 即時音視訊播放。預設寬度300px、高度225px,可透過wxss 設定寬高 |
live-pusher | 即時音訊錄影。需要使用者授權scope.camera、scope.record。預設寬度為100%、無預設高度,請透過wxss 設定寬高 |
map | 地圖 |
movable-area | movable-view 的可移動區域 |
movable-view | 可移動的視圖容器,在頁面中可以拖曳滑動 |
navigator | 頁面連結 |
open-data | 用於展示微信開放的數據 |
picker-view-column | 僅可放置於<picker-view /> 中其孩子節點的高度會自動設定成與picker-view 的選取框的高度一致 |
picker-view | 嵌入頁面的捲動選擇器 |
picker | 捲動選擇器。現支援三種選擇器透過mode 來區分,分別是普通選擇器、時間選擇器、日期選擇器。預設是普通選擇器 |
progress | 進度條 |
radio-group | 單項選擇器,內部由多個<radio/> 組成 |
radio | 單選項目 |
rich-text | 富文本 |
scroll-view | 可捲動視圖區域 |
slider | 滑動選擇器 |
swiper-item | 僅可放置在<swiper/> 組件中,寬高自動設定為100% |
swiper | 滑桿視圖容器 |
switch | 開關選擇器 |
text | 文字 |
textarea | 多行輸入框 |
video | 影片.預設寬度300px、高度225px,可透過wxss 設定寬高 |
view | 基礎的視圖容器 |
web-view | 可以用來承載網頁的容器,會自動鋪滿整個小程式頁面 |
Many thanks to Jetbrains for kindly providing a license for me to work on this and other open-source projects.
MIT
程式碼提示部分內容參考自拓展:ChandZhang/wechat-snippet-vscode
Enjoy!