@dcloudio/uni-app-x 0.7.111 → 0.7.113

package/types/uni/uts-plugin-api/lib/uni-pageScrollTo/utssdk/interface.d.ts

@@ -1,22 +1,22 @@
-/**
- * 设置页面滚动错误码
- * - 4: 框架内部异常
- */
-export type PageScrollToErrorCode = 4
-export interface PageScrollToFail extends IUniError {
-    errCode: PageScrollToErrorCode
-}
-
-export type PageScrollToSuccess = AsyncApiSuccessResult
-export type PageScrollToSuccessCallback = (result: PageScrollToSuccess) => void
-
-export type PageScrollToFailCallback = (result: PageScrollToFail) => void
-export type PageScrollToComplete = AsyncApiResult
-export type PageScrollToCompleteCallback = (
-    result: PageScrollToComplete,
-) => void
-export type PageScrollToOptions = {
-    /**
+/**
+ * 设置页面滚动错误码
+ * - 4: 框架内部异常
+ */
+export type PageScrollToErrorCode = 4
+export interface PageScrollToFail extends IUniError {
+    errCode: PageScrollToErrorCode
+}
+
+export type PageScrollToSuccess = AsyncApiSuccessResult
+export type PageScrollToSuccessCallback = (result: PageScrollToSuccess) => void
+
+export type PageScrollToFailCallback = (result: PageScrollToFail) => void
+export type PageScrollToComplete = AsyncApiResult
+export type PageScrollToCompleteCallback = (
+    result: PageScrollToComplete,
+) => void
+export type PageScrollToOptions = {
+    /**
      * 滚动到页面的目标位置
      * @uniPlatform {
      *   "mp": {
@@ -62,9 +62,9 @@ export type PageScrollToOptions = {
      *     }
      *   }
      * }
-     */
-    scrollTop?: number | null
-    /**
+     */
+    scrollTop?: number | null
+    /**
      * 选择器
      * @uniPlatform {
      *   "mp": {
@@ -110,44 +110,44 @@ export type PageScrollToOptions = {
      *     }
      *   }
      * }
-     */
-    selector?: string | null
-    /**
-     * 偏移距离，可以滚动到 selector 加偏移距离的位置
-     * @uniPlatform {
-     *  "app": {
-     *    "android": {
-     *        "osVer": "5.0",
-     *        "uniVer": "x",
-     *        "unixVer": "3.91"
-     *      },
-     *      "ios": {
-     *          "osVer": "12.0",
-     *          "uniVer": "x",
-     *          "unixVer": "4.11"
-     *      },
-     *    "harmony": {
-     *      "osVer": "3.0",
-     *      "uniVer": "4.23",
-     *      "unixVer": "4.61",
-     *      "unixvVer": "5.0"
-     *    }
-     *  },
-     *  "mp": {
-     *    "weixin": {
-     *        "hostVer": "√",
-     *        "uniVer": "√",
-     *        "unixVer": "4.41"
-     *    }
-     *  },
-     *  "web": {
-     *      "uniVer": "√",
-     *      "unixVer": "4.0"
-     *  }
-     * }
-     */
-    offsetTop?: number | null
-    /**
+     */
+    selector?: string | null
+    /**
+     * 偏移距离，可以滚动到 selector 加偏移距离的位置
+     * @uniPlatform {
+     *  "app": {
+     *    "android": {
+     *        "osVer": "5.0",
+     *        "uniVer": "x",
+     *        "unixVer": "3.91"
+     *      },
+     *      "ios": {
+     *          "osVer": "12.0",
+     *          "uniVer": "x",
+     *          "unixVer": "4.11"
+     *      },
+     *    "harmony": {
+     *      "osVer": "3.0",
+     *      "uniVer": "4.23",
+     *      "unixVer": "4.61",
+     *      "unixVaporVer": "5.0"
+     *    }
+     *  },
+     *  "mp": {
+     *    "weixin": {
+     *        "hostVer": "√",
+     *        "uniVer": "√",
+     *        "unixVer": "4.41"
+     *    }
+     *  },
+     *  "web": {
+     *      "uniVer": "√",
+     *      "unixVer": "4.0"
+     *  }
+     * }
+     */
+    offsetTop?: number | null
+    /**
      * 滚动动画的时长
      * @uniPlatform {
      *   "mp": {
@@ -193,9 +193,9 @@ export type PageScrollToOptions = {
      *     }
      *   }
      * }
-     */
-    duration?: number | null
-    /**
+     */
+    duration?: number | null
+    /**
      * 接口调用成功的回调函数
      * @uniPlatform {
      *   "mp": {
@@ -241,9 +241,9 @@ export type PageScrollToOptions = {
      *     }
      *   }
      * }
-     */
-    success?: PageScrollToSuccessCallback | null
-    /**
+     */
+    success?: PageScrollToSuccessCallback | null
+    /**
      * 接口调用失败的回调函数
      * @uniPlatform {
      *   "mp": {
@@ -289,9 +289,9 @@ export type PageScrollToOptions = {
      *     }
      *   }
      * }
-     */
-    fail?: PageScrollToFailCallback | null
-    /**
+     */
+    fail?: PageScrollToFailCallback | null
+    /**
      * 接口调用结束的回调函数（调用成功、失败都会执行）
      * @uniPlatform {
      *   "mp": {
@@ -337,17 +337,17 @@ export type PageScrollToOptions = {
      *     }
      *   }
      * }
-     */
-    complete?: PageScrollToCompleteCallback | null
-}
-export type PageScrollTo = (options: PageScrollToOptions) => Promise<PageScrollToSuccess> | null
-export interface Uni {
-    /**
-     * 将页面滚动到目标位置
-     *
-     * @tutorial_uni_app https://uniapp.dcloud.net.cn/api/ui/scroll.html#pagescrollto
-     * @tutorial_uni_app_x https://doc.dcloud.net.cn/uni-app-x/api/page-scroll-to.html#pagescrollto
-     * @tutorial https://doc.dcloud.net.cn/uni-app-x/api/page-scroll-to.html#pagescrollto
+     */
+    complete?: PageScrollToCompleteCallback | null
+}
+export type PageScrollTo = (options: PageScrollToOptions) => Promise<PageScrollToSuccess> | null
+export interface Uni {
+    /**
+     * 将页面滚动到目标位置
+     *
+     * @tutorial_uni_app https://uniapp.dcloud.net.cn/api/ui/scroll.html#pagescrollto
+     * @tutorial_uni_app_x https://doc.dcloud.net.cn/uni-app-x/api/page-scroll-to.html#pagescrollto
+     * @tutorial https://doc.dcloud.net.cn/uni-app-x/api/page-scroll-to.html#pagescrollto
      * @uniPlatform {
      *   "app": {
      *     "android": {
@@ -364,7 +364,7 @@ export interface Uni {
      *       "osVer": "3.0",
      *       "uniVer": "4.23",
      *       "unixVer": "4.61",
-     *       "unixvVer": "5.0"
+     *       "unixVaporVer": "5.0"
      *     }
      *   },
      *   "mp": {
@@ -415,6 +415,6 @@ export interface Uni {
      *   }
      * }
      * @tutorial_weixin https://developers.weixin.qq.com/miniprogram/dev/api/ui/scroll/wx.pageScrollTo.html
-     */
-    pageScrollTo(options: PageScrollToOptions): Promise<PageScrollToSuccess> | null
-}
+     */
+    pageScrollTo(options: PageScrollToOptions): Promise<PageScrollToSuccess> | null
+}