@tarojs/taro 3.3.13 → 3.3.17

package/types/api/ui/interaction.d.ts

@@ -1,48 +1,33 @@
-declare namespace Taro {
+import Taro from '../../index'
+
+declare module '../../index' {
   namespace showToast {
     interface Option {
       /** 提示的内容 */
       title: string
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
-      complete?: (res: General.CallbackResult) => void
+      complete?: (res: TaroGeneral.CallbackResult) => void
       /** 提示的延迟时间 */
       duration?: number
       /** 接口调用失败的回调函数 */
-      fail?: (res: General.CallbackResult) => void
+      fail?: (res: TaroGeneral.CallbackResult) => void
       /** 图标
        *
        * 可选值：
        * - 'success': 显示成功图标，此时 title 文本最多显示 7 个汉字长度;
+       * - 'error': 显示失败图标，此时 title 文本最多显示 7 个汉字长度;
        * - 'loading': 显示加载图标，此时 title 文本最多显示 7 个汉字长度;
        * - 'none': 不显示图标，此时 title 文本最多可显示两行 */
-      icon?: 'success' | 'loading' | 'none'
+      icon?: 'success' | 'error' | 'loading' | 'none'
       /** 自定义图标的本地路径，image 的优先级高于 icon */
       image?: string
       /** 是否显示透明蒙层，防止触摸穿透 */
       mask?: boolean
       /** 接口调用成功的回调函数 */
-      success?: (res: General.CallbackResult) => void
+      success?: (res: TaroGeneral.CallbackResult) => void
     }
   }
 
-  /** 显示消息提示框
-   *
-   * **注意**
-   * - Taro.showLoading 和 Taro.showToast 同时只能显示一个
-   * - Taro.showToast 应与 Taro.hideToast 配对使用
-   * @supported weapp, h5, rn
-   * @example
-   * ```tsx
-   * Taro.showToast({
-   *   title: '成功',
-   *   icon: 'success',
-   *   duration: 2000
-   * })
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/interaction/wx.showToast.html
-   */
-  function showToast(option?: showToast.Option): Promise<General.CallbackResult>
-
   namespace showModal {
     interface Option {
       /** 取消按钮的文字颜色，必须是 16 进制格式的颜色字符串 */
@@ -50,7 +35,7 @@ declare namespace Taro {
       /** 取消按钮的文字，最多 4 个字符 */
       cancelText?: string
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
-      complete?: (res: General.CallbackResult) => void
+      complete?: (res: TaroGeneral.CallbackResult) => void
       /** 确认按钮的文字颜色，必须是 16 进制格式的颜色字符串 */
       confirmColor?: string
       /** 确认按钮的文字，最多 4 个字符 */
@@ -58,7 +43,7 @@ declare namespace Taro {
       /** 提示的内容 */
       content?: string
       /** 接口调用失败的回调函数 */
-      fail?: (res: General.CallbackResult) => void
+      fail?: (res: TaroGeneral.CallbackResult) => void
       /** 是否显示取消按钮 */
       showCancel?: boolean
       /** 接口调用成功的回调函数 */
@@ -67,7 +52,7 @@ declare namespace Taro {
       title?: string
     }
 
-    interface SuccessCallbackResult extends General.CallbackResult {
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
       /** 为 true 时，表示用户点击了取消（用于 Android 系统区分点击蒙层关闭还是点击取消按钮关闭） */
       cancel: boolean
       /** 为 true 时，表示用户点击了确定按钮 */
@@ -77,77 +62,37 @@ declare namespace Taro {
     }
   }
 
-  /** 显示模态对话框
-   * **注意**
-   * - Android 6.7.2 以下版本，点击取消或蒙层时，回调 fail, errMsg 为 "fail cancel"；
-   * - Android 6.7.2 及以上版本 和 iOS 点击蒙层不会关闭模态弹窗，所以尽量避免使用「取消」分支中实现业务逻辑
-   * @supported weapp, h5, rn
-   * @example
-   * ```tsx
-   * Taro.showModal({
-   *   title: '提示',
-   *   content: '这是一个模态弹窗',
-   *   success: function (res) {
-   *     if (res.confirm) {
-   *       console.log('用户点击确定')
-   *     } else if (res.cancel) {
-   *       console.log('用户点击取消')
-   *     }
-   *   }
-   * })
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/interaction/wx.showModal.html
-   */
-  function showModal(option?: showModal.Option): Promise<showModal.SuccessCallbackResult>
-
   namespace showLoading {
     interface Option {
       /** 提示的内容 */
       title: string
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
-      complete?: (res: General.CallbackResult) => void
+      complete?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用失败的回调函数 */
-      fail?: (res: General.CallbackResult) => void
+      fail?: (res: TaroGeneral.CallbackResult) => void
       /** 是否显示透明蒙层，防止触摸穿透 */
       mask?: boolean
       /** 接口调用成功的回调函数 */
-      success?: (res: General.CallbackResult) => void
+      success?: (res: TaroGeneral.CallbackResult) => void
     }
   }
 
-  /** 显示 loading 提示框。需主动调用 Taro.hideLoading 才能关闭提示框
-   *
-   * **注意**
-   * - Taro.showLoading 和 Taro.showToast 同时只能显示一个
-   * - Taro.showLoading 应与 Taro.hideLoading 配对使用
-   * @supported weapp, h5, rn
-   * @example
-   * ```tsx
-   * Taro.showLoading({
-   *   title: '加载中',
-   * })
-   * setTimeout(function () {
-   *   Taro.hideLoading()
-   * }, 2000)
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/interaction/wx.showLoading.html
-   */
-  function showLoading(option?: showLoading.Option): Promise<General.CallbackResult>
-
   namespace showActionSheet {
     interface Option {
+      /** 警示文案 */
+      alertText?: string
       /** 按钮的文字数组，数组长度最大为 6 */
       itemList: string[]
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
-      complete?: (res: General.CallbackResult) => void
+      complete?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用失败的回调函数 */
-      fail?: (res: General.CallbackResult) => void
+      fail?: (res: TaroGeneral.CallbackResult) => void
       /** 按钮的文字颜色 */
       itemColor?: string
       /** 接口调用成功的回调函数 */
       success?: (result: SuccessCallbackResult) => void
     }
-    interface SuccessCallbackResult extends General.CallbackResult {
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
       /** 用户点击的按钮序号，从上到下的顺序，从0开始 */
       tapIndex: number
       /** 调用结果 */
@@ -155,110 +100,174 @@ declare namespace Taro {
     }
   }
 
-  /** 显示操作菜单
-   *
-   * **注意**
-   * - Android 6.7.2 以下版本，点击取消或蒙层时，回调 fail, errMsg 为 "fail cancel"；
-   * - Android 6.7.2 及以上版本 和 iOS 点击蒙层不会关闭模态弹窗，所以尽量避免使用「取消」分支中实现业务逻辑
-   * @supported weapp, h5, rn
-   * @example
-   * ```tsx
-   * Taro.showActionSheet({
-   *   itemList: ['A', 'B', 'C'],
-   *   success: function (res) {
-   *     console.log(res.tapIndex)
-   *   },
-   *   fail: function (res) {
-   *     console.log(res.errMsg)
-   *   }
-   * })
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/interaction/wx.showActionSheet.html
-   */
-  function showActionSheet(option: showActionSheet.Option): Promise<showActionSheet.SuccessCallbackResult>
-
   namespace hideToast {
     interface Option {
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
-      complete?: (res: General.CallbackResult) => void
+      complete?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用失败的回调函数 */
-      fail?: (res: General.CallbackResult) => void
+      fail?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用成功的回调函数 */
-      success?: (res: General.CallbackResult) => void
+      success?: (res: TaroGeneral.CallbackResult) => void
     }
   }
 
-  /** 隐藏消息提示框
-   * @supported weapp, h5, rn
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/interaction/wx.hideToast.html
-   */
-  function hideToast(option?: hideToast.Option): void
-
   namespace hideLoading {
     interface Option {
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
-      complete?: (res: General.CallbackResult) => void
+      complete?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用失败的回调函数 */
-      fail?: (res: General.CallbackResult) => void
+      fail?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用成功的回调函数 */
-      success?: (res: General.CallbackResult) => void
+      success?: (res: TaroGeneral.CallbackResult) => void
     }
   }
 
-  /** 隐藏 loading 提示框
-   * @supported weapp, h5, rn
-   * @example
-   * ```tsx
-   * Taro.showLoading({
-   *   title: '加载中',
-   * })
-   * setTimeout(function (){
-   *   Taro.hideLoading()
-   * },2000)
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/interaction/wx.hideLoading.html
-   */
-  function hideLoading(option?: hideLoading.Option): void
-  
   namespace enableAlertBeforeUnload {
     interface Option {
+      /** 询问对话框内容 */
+      message: string
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
-      complete?: (res: General.CallbackResult) => void
+      complete?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用失败的回调函数 */
-      fail?: (res: General.CallbackResult) => void
+      fail?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用成功的回调函数 */
-      success?: (res: General.CallbackResult) => void
+      success?: (res: TaroGeneral.CallbackResult) => void
     }
   }
-  
-  /** 开启小程序页面返回询问对话框
-   * @supported weapp
-   * @example
-   * ```tsx
-   * Taro.enableAlertBeforeUnload({
-   *   success: function () {
-   *     console.log('success')
-   *   },
-   * })
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/interaction/wx.enableAlertBeforeUnload.html
-   */
-  function enableAlertBeforeUnload(option?: enableAlertBeforeUnload.Option): void
-  
+
   namespace disableAlertBeforeUnload {
     interface Option {
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
-      complete?: (res: General.CallbackResult) => void
+      complete?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用失败的回调函数 */
-      fail?: (res: General.CallbackResult) => void
+      fail?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用成功的回调函数 */
-      success?: (res: General.CallbackResult) => void
+      success?: (res: TaroGeneral.CallbackResult) => void
     }
   }
-  
-  /** 关闭小程序页面返回询问对话框
-   * @supported weapp
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/interaction/wx.disableAlertBeforeUnload.html
-   */
-  function disableAlertBeforeUnload(option?: disableAlertBeforeUnload.Option): void
+
+  interface TaroStatic {
+    /** 显示消息提示框
+     *
+     * **注意**
+     * - Taro.showLoading 和 Taro.showToast 同时只能显示一个
+     * - Taro.showToast 应与 Taro.hideToast 配对使用
+     * @supported weapp, h5, rn
+     * @example
+     * ```tsx
+     * Taro.showToast({
+     *   title: '成功',
+     *   icon: 'success',
+     *   duration: 2000
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/interaction/wx.showToast.html
+     */
+    showToast(option?: showToast.Option): Promise<TaroGeneral.CallbackResult>
+
+    /** 显示模态对话框
+     * **注意**
+     * - Android 6.7.2 以下版本，点击取消或蒙层时，回调 fail, errMsg 为 "fail cancel"；
+     * - Android 6.7.2 及以上版本 和 iOS 点击蒙层不会关闭模态弹窗，所以尽量避免使用「取消」分支中实现业务逻辑
+     * @supported weapp, h5, rn
+     * @example
+     * ```tsx
+     * Taro.showModal({
+     *   title: '提示',
+     *   content: '这是一个模态弹窗',
+     *   success: function (res) {
+     *     if (res.confirm) {
+     *       console.log('用户点击确定')
+     *     } else if (res.cancel) {
+     *       console.log('用户点击取消')
+     *     }
+     *   }
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/interaction/wx.showModal.html
+     */
+    showModal(option?: showModal.Option): Promise<showModal.SuccessCallbackResult>
+
+    /** 显示 loading 提示框。需主动调用 Taro.hideLoading 才能关闭提示框
+     *
+     * **注意**
+     * - Taro.showLoading 和 Taro.showToast 同时只能显示一个
+     * - Taro.showLoading 应与 Taro.hideLoading 配对使用
+     * @supported weapp, h5, rn
+     * @example
+     * ```tsx
+     * Taro.showLoading({
+     *   title: '加载中',
+     * })
+     * setTimeout(function () {
+     *   Taro.hideLoading()
+     * }, 2000)
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/interaction/wx.showLoading.html
+     */
+    showLoading(option?: showLoading.Option): Promise<TaroGeneral.CallbackResult>
+
+    /** 显示操作菜单
+     *
+     * **注意**
+     * - Android 6.7.2 以下版本，点击取消或蒙层时，回调 fail, errMsg 为 "fail cancel"；
+     * - Android 6.7.2 及以上版本 和 iOS 点击蒙层不会关闭模态弹窗，所以尽量避免使用「取消」分支中实现业务逻辑
+     * @supported weapp, h5, rn
+     * @example
+     * ```tsx
+     * Taro.showActionSheet({
+     *   itemList: ['A', 'B', 'C'],
+     *   success: function (res) {
+     *     console.log(res.tapIndex)
+     *   },
+     *   fail: function (res) {
+     *     console.log(res.errMsg)
+     *   }
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/interaction/wx.showActionSheet.html
+     */
+    showActionSheet(option: showActionSheet.Option): Promise<showActionSheet.SuccessCallbackResult>
+
+    /** 隐藏消息提示框
+     * @supported weapp, h5, rn
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/interaction/wx.hideToast.html
+     */
+    hideToast(option?: hideToast.Option): void
+
+    /** 隐藏 loading 提示框
+     * @supported weapp, h5, rn
+     * @example
+     * ```tsx
+     * Taro.showLoading({
+     *   title: '加载中',
+     * })
+     * setTimeout(function (){
+     *   Taro.hideLoading()
+     * },2000)
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/interaction/wx.hideLoading.html
+     */
+    hideLoading(option?: hideLoading.Option): void  /** 隐藏 loading 提示框
+
+    /** 开启小程序页面返回询问对话框
+     * @supported weapp
+     * @example
+     * ```tsx
+     * Taro.enableAlertBeforeUnload({
+     *   success: function () {
+     *     console.log('success')
+     *   },
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/interaction/wx.enableAlertBeforeUnload.html
+     */
+    enableAlertBeforeUnload(option: enableAlertBeforeUnload.Option): void
+
+    /** 关闭小程序页面返回询问对话框
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/interaction/wx.disableAlertBeforeUnload.html
+     */
+    disableAlertBeforeUnload(option?: disableAlertBeforeUnload.Option): void
+  }
 }

package/types/api/ui/keyboard.d.ts

@@ -1,39 +1,27 @@
-declare namespace Taro {
+import Taro from '../../index'
+
+declare module '../../index' {
   namespace hideKeyboard {
     interface Option {
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
-      complete?: (res: General.CallbackResult) => void
+      complete?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用失败的回调函数 */
-      fail?: (res: General.CallbackResult) => void
+      fail?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用成功的回调函数 */
-      success?: (res: General.CallbackResult) => void
+      success?: (res: TaroGeneral.CallbackResult) => void
     }
   }
 
-  /** 在input、textarea等focus拉起键盘之后，手动调用此接口收起键盘
-   * @supported weapp, rn
-   * @example
-   * ```tsx
-   * Taro.hideKeyboard({
-   *   complete: res => {
-   *     console.log('hideKeyboard res', res)
-   *   }
-   * })
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/keyboard/wx.hideKeyboard.html
-   */
-  function hideKeyboard(option?: hideKeyboard.Option): Promise<General.CallbackResult>
-
   namespace getSelectedTextRange {
     interface Option {
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
-      complete?: (res: General.CallbackResult) => void
+      complete?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用失败的回调函数 */
-      fail?: (res: General.CallbackResult) => void
+      fail?: (res: TaroGeneral.CallbackResult) => void
       /** 接口调用成功的回调函数 */
       success?: (result: SuccessCallbackResult) => void
     }
-    interface SuccessCallbackResult extends General.CallbackResult {
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
       /** 输入框光标结束位置 */
       end: number
       /** 输入框光标起始位置 */
@@ -43,20 +31,6 @@ declare namespace Taro {
     }
   }
 
-  /** 在input、textarea等focus之后，获取输入框的光标位置。注意：只有在focus的时候调用此接口才有效。
-   * @supported weapp
-   * @example
-   * ```tsx
-   * Taro.getSelectedTextRange({
-   *   complete: res => {
-   *     console.log('getSelectedTextRange res', res.start, res.end)
-   *   }
-   * })
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/keyboard/wx.getSelectedTextRange.html
-   */
-  function getSelectedTextRange(option?: getSelectedTextRange.Option): Promise<getSelectedTextRange.SuccessCallbackResult>
-
   namespace onKeyboardHeightChange {
     type Callback = (
       result: CallbackResult,
@@ -67,25 +41,55 @@ declare namespace Taro {
     }
   }
 
-  /** 监听键盘高度变化
-   * @supported weapp, rn
-   * @example
-   * ```tsx
-   * Taro.onKeyboardHeightChange(res => {
-   *   console.log(res.height)
-   * })
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/keyboard/wx.onKeyboardHeightChange.html
-   */
-  function onKeyboardHeightChange(callback: onKeyboardHeightChange.Callback): void
+  interface TaroStatic {
+    /** 在input、textarea等focus拉起键盘之后，手动调用此接口收起键盘
+     * @supported weapp, rn
+     * @example
+     * ```tsx
+     * Taro.hideKeyboard({
+     *   complete: res => {
+     *     console.log('hideKeyboard res', res)
+     *   }
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/keyboard/wx.hideKeyboard.html
+     */
+    hideKeyboard(option?: hideKeyboard.Option): Promise<TaroGeneral.CallbackResult>
 
-  /**
-   * 取消监听键盘高度变化事件。
-   * @supported weapp, rn
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/keyboard/wx.offKeyboardHeightChange.html
-   */
-  function offKeyboardHeightChange(
-    /** 键盘高度变化事件的回调函数 */
-    callback?: (...args: any[]) => any,
-  ): void
+    /** 在input、textarea等focus之后，获取输入框的光标位置。注意：只有在focus的时候调用此接口才有效。
+     * @supported weapp
+     * @example
+     * ```tsx
+     * Taro.getSelectedTextRange({
+     *   complete: res => {
+     *     console.log('getSelectedTextRange res', res.start, res.end)
+     *   }
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/keyboard/wx.getSelectedTextRange.html
+     */
+    getSelectedTextRange(option?: getSelectedTextRange.Option): Promise<getSelectedTextRange.SuccessCallbackResult>
+
+    /** 监听键盘高度变化
+     * @supported weapp, rn
+     * @example
+     * ```tsx
+     * Taro.onKeyboardHeightChange(res => {
+     *   console.log(res.height)
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/keyboard/wx.onKeyboardHeightChange.html
+     */
+    onKeyboardHeightChange(callback: onKeyboardHeightChange.Callback): void
+
+    /**
+     * 取消监听键盘高度变化事件。
+     * @supported weapp, rn
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/keyboard/wx.offKeyboardHeightChange.html
+     */
+    offKeyboardHeightChange(
+      /** 键盘高度变化事件的回调函数 */
+      callback?: (...args: any[]) => any,
+    ): void
+  }
 }

package/types/api/ui/menu.d.ts

@@ -1,4 +1,6 @@
-declare namespace Taro {
+import Taro from '../../index'
+
+declare module '../../index' {
   namespace getMenuButtonBoundingClientRect {
     /** 菜单按钮的布局位置信息 */
     interface Rect {
@@ -17,9 +19,11 @@ declare namespace Taro {
     }
   }
 
-  /** 获取菜单按钮（右上角胶囊按钮）的布局位置信息。坐标信息以屏幕左上角为原点。
-   * @supported weapp
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/menu/wx.getMenuButtonBoundingClientRect.html
-   */
-  function getMenuButtonBoundingClientRect(): getMenuButtonBoundingClientRect.Rect
+  interface TaroStatic {
+    /** 获取菜单按钮（右上角胶囊按钮）的布局位置信息。坐标信息以屏幕左上角为原点。
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/menu/wx.getMenuButtonBoundingClientRect.html
+     */
+    getMenuButtonBoundingClientRect(): getMenuButtonBoundingClientRect.Rect
+  }
 }