vtils

Home > mp

mp package

小程序工具库。

Functions

Function Description
ensureInMiniProgram(cb) 确保当前在小程序环境并执行回调。
getCurrentPagePath(pageInstance) 获取当前页面的路径(不含查询参数),始终以 / 开头。
getCurrentPageQuery(pageInstance) 获取当前页面的查询参数,已经对每个值执行了 decodeURIComponent。
getCurrentPageUrl(pageInstance) 获取当前页面的地址(包含查询参数)。
getMiniProgramConfig()  
getSceneParams(parser) 获取场景参数。
getTopBarInfo() 获取顶栏信息。
navigatePageBack(delta) 关闭当前页面,返回上一页面或多级页面。
navigatePageTo(url, query, redirect) <p>跳转至某个页面,跳转失败时会尝试切换到 Tab 页。</p><p>**注意:在页面真正切换后 Promise 才会被 resolve,因而此时的页面上下文已经是新页面。**</p>
patchMiniProgram() 打补丁。
redirectPageTo(url, query) 关闭当前页面,跳转至某个页面,跳转失败时会尝试切换到 Tab 页。
setMiniProgramConfig(config)  
usePullDownRefresh(callback)  
useSceneParams(parser) 获取场景参数。
useShareAppMessage(callback)  
useSubmit(action, deps) 对提交类行为的封装。
useTopBarInfo() 获取顶栏信息。

Interfaces

Interface Description
GetTopBarInfoResult  
MiniProgramBusListeners  
MiniProgramBusRouteChangePageInfo  
MiniProgramBusRouteChangePayload  
MiniProgramConfig  

Namespaces

Namespace Description
patchMiniProgram  

Variables

Variable Description
currentPageListeners  
miniProgramBus  
pageListeners  
pageListenerToCurrentPageListener  
submit 对提交类行为的封装。

Type Aliases

Type Alias Description
GetSceneParamsParser  
MiniProgramBusRouteChangeAction