feat(mp): 新增 useTopBarInfo, useSubmit, usePullDownRefresh

src/mp/index.ts

@@ -19,4 +19,7 @@ export * from './navigatePageTo'
 export * from './patchMiniProgram'
 export * from './redirectPageTo'
 export * from './submit'
+export * from './usePullDownRefresh'
+export * from './useSubmit'
+export * from './useTopBarInfo'
 // @endindex

src/mp/navigatePageTo.ts

@@ -4,7 +4,7 @@ import { ensureInMiniProgram } from './ensureInMiniProgram'
 import { getMiniProgramConfig } from './miniProgramConfig'
 
 /**
- * 跳转至某个页面。
+ * 跳转至某个页面，跳转失败时会尝试切换到 Tab 页。
  *
  * @param url 要跳转去的页面地址
  * @param query 查询参数

src/mp/redirectPageTo.ts

@@ -2,7 +2,7 @@ import { AnyObject } from '../types'
 import { navigatePageTo } from './navigatePageTo'
 
 /**
- * 关闭当前页面，跳转至某个页面。
+ * 关闭当前页面，跳转至某个页面，跳转失败时会尝试切换到 Tab 页。
  *
  * @param url 要跳转去的页面地址
  * @param query 查询参数

src/mp/usePullDownRefresh.ts

@@ -0,0 +1,21 @@
+import { ensureInMiniProgram } from './ensureInMiniProgram'
+import { isPromiseLike } from '../utils'
+import { miniProgramBus } from './miniProgramBus'
+import { useEffect } from 'react'
+import { useLatest } from '../react'
+
+export function usePullDownRefresh(callback: () => any): void {
+  const latestCallback = useLatest(callback)
+  useEffect(() => {
+    return miniProgramBus.on('currentPagePullDownRefresh', () => {
+      ensureInMiniProgram(mp => {
+        const res = latestCallback.current()
+        if (isPromiseLike(res)) {
+          res.then(() => mp.stopPullDownRefresh())
+        } else {
+          mp.stopPullDownRefresh()
+        }
+      })
+    })
+  }, [])
+}

src/mp/useSubmit.ts

@@ -0,0 +1,13 @@
+import React, { useCallback } from 'react'
+import { submit } from './submit'
+import { SubmitActionPayload } from '../utils'
+
+/**
+ * 对提交类行为的封装。
+ */
+export function useSubmit<TResult>(
+  action: (payload: SubmitActionPayload) => Promise<TResult>,
+  deps: React.DependencyList,
+): () => Promise<TResult> {
+  return useCallback(() => submit(action), deps)
+}

src/mp/useTopBarInfo.ts

@@ -0,0 +1,11 @@
+import { getTopBarInfo, GetTopBarInfoResult } from './getTopBarInfo'
+import { useMemo } from 'react'
+
+/**
+ * 获取顶栏信息。
+ *
+ * @returns 返回获取到的顶栏信息
+ */
+export function useTopBarInfo(): GetTopBarInfoResult {
+  return useMemo(getTopBarInfo, [])
+}

src/taro/index.ts

@@ -1,5 +1,5 @@
 /**
- * Taro 3 工具库。
+ * Taro 3 工具库。(已废弃，使用小程序工具库代替)
  *
  * @packageDocumentation
  */

src/taro/useAutoStopPullDownRefresh.ts

@@ -1,18 +1,6 @@
-import { isPromiseLike } from '../utils'
-import { stopPullDownRefresh, usePullDownRefresh } from '@tarojs/taro'
+import { usePullDownRefresh as mpUsePullDownRefresh } from '../mp'
 
 /**
- * 同 `Taro.usePullDownRefresh`，不过在回调函数完成后会自动调用 `Taro.stopPullDownRefresh()`。
- *
- * @param callback 回调函数
+ * @deprecated 使用 `import { usePullDownRefresh } from 'vtils/mp'` 代替
  */
-export function useAutoStopPullDownRefresh(callback: () => any) {
-  usePullDownRefresh(() => {
-    const res = callback()
-    if (isPromiseLike(res)) {
-      res.then(() => stopPullDownRefresh())
-    } else {
-      stopPullDownRefresh()
-    }
-  })
-}
+export const useAutoStopPullDownRefresh = mpUsePullDownRefresh

src/taro/useSubmit.ts

@@ -1,10 +1,6 @@
-import React, { useCallback } from 'react'
-import { submit } from '../mp'
-import { SubmitActionPayload } from '../utils'
+import { useSubmit as mpUseSubmit } from '../mp'
 
-export function useSubmit<TResult>(
-  action: (payload: SubmitActionPayload) => Promise<TResult>,
-  deps: React.DependencyList,
-): () => Promise<TResult> {
-  return useCallback(() => submit(action), deps)
-}
+/**
+ * @deprecated 使用 `import { useSubmit } from 'vtils/mp'` 代替
+ */
+export const useSubmit = mpUseSubmit

src/taro/useTopBarInfo.ts

@@ -1,6 +1,6 @@
-import { getTopBarInfo, GetTopBarInfoResult } from '../mp'
-import { useMemo } from 'react'
+import { useTopBarInfo as mpUseTopBarInfo } from '../mp'
 
-export function useTopBarInfo(): GetTopBarInfoResult {
-  return useMemo(getTopBarInfo, [])
-}
+/**
+ * @deprecated 使用 `import { useTopBarInfo } from 'vtils/mp'` 代替
+ */
+export const useTopBarInfo = mpUseTopBarInfo