@tarojs/taro 3.3.12 → 3.4.0-beta.0

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
+  }
 }

package/types/api/ui/navigation-bar.d.ts

@@ -1,46 +1,30 @@
-declare namespace Taro {
+import Taro from '../../index'
+
+declare module '../../index' {
   namespace showNavigationBarLoading {
     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, rn
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/navigation-bar/wx.showNavigationBarLoading.html
-   */
-  function showNavigationBarLoading(option?: showNavigationBarLoading.Option): void
-
   namespace setNavigationBarTitle {
     interface Option {
       /** 页面标题 */
       title: 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, h5, rn
-   * @example
-   * ```tsx
-   * Taro.setNavigationBarTitle({
-   *   title: '当前页面'
-   * })
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/navigation-bar/wx.setNavigationBarTitle.html
-   */
-  function setNavigationBarTitle(option: setNavigationBarTitle.Option): Promise<General.CallbackResult>
-
   namespace setNavigationBarColor {
     interface Option {
       /** 背景颜色值，有效值为十六进制颜色 */
@@ -50,11 +34,11 @@ declare namespace Taro {
       /** 动画效果 */
       animation?: AnimationOption
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
-      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
     }
     /** 动画效果 */
     interface AnimationOption {
@@ -71,55 +55,75 @@ declare namespace Taro {
     }
   }
 
-  /** 设置页面导航条颜色
-   * @supported weapp, h5, rn
-   * @rn 不支持 animation 参数
-   * @example
-   * ```tsx
-   * Taro.setNavigationBarColor({
-   *     frontColor: '#ffffff',
-   *     backgroundColor: '#ff0000',
-   *     animation: {
-   *         duration: 400,
-   *         timingFunc: 'easeIn'
-   *     }
-   * })
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/navigation-bar/wx.setNavigationBarColor.html
-   */
-  function setNavigationBarColor(option: setNavigationBarColor.Option): Promise<General.CallbackResult>
-
   namespace hideNavigationBarLoading {
     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, rn
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/navigation-bar/wx.hideNavigationBarLoading.html
-   */
-  function hideNavigationBarLoading(option?: hideNavigationBarLoading.Option): void
-
   namespace hideHomeButton {
     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
     }
   }
 
-  /** 隐藏返回首页按钮。微信7.0.7版本起，当用户打开的小程序最底层页面是非首页时，默认展示“返回首页”按钮，开发者可在页面 onShow 中调用 hideHomeButton 进行隐藏。
-   * @supported weapp
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/navigation-bar/wx.hideHomeButton.html
-   */
-  function hideHomeButton(option?: hideHomeButton.Option): Promise<General.CallbackResult>
+  interface TaroStatic {
+    /** 在当前页面显示导航条加载动画
+     * @supported weapp, rn
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/navigation-bar/wx.showNavigationBarLoading.html
+     */
+    showNavigationBarLoading(option?: showNavigationBarLoading.Option): void
+
+    /** 动态设置当前页面的标题
+     * @supported weapp, h5, rn
+     * @example
+     * ```tsx
+     * Taro.setNavigationBarTitle({
+     *   title: '当前页面'
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/navigation-bar/wx.setNavigationBarTitle.html
+     */
+    setNavigationBarTitle(option: setNavigationBarTitle.Option): Promise<TaroGeneral.CallbackResult>
+
+    /** 设置页面导航条颜色
+     * @supported weapp, h5, rn
+     * @rn 不支持 animation 参数
+     * @example
+     * ```tsx
+     * Taro.setNavigationBarColor({
+     *     frontColor: '#ffffff',
+     *     backgroundColor: '#ff0000',
+     *     animation: {
+     *         duration: 400,
+     *         timingFunc: 'easeIn'
+     *     }
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/navigation-bar/wx.setNavigationBarColor.html
+     */
+    setNavigationBarColor(option: setNavigationBarColor.Option): Promise<TaroGeneral.CallbackResult>
+
+    /** 在当前页面隐藏导航条加载动画
+     * @supported weapp, rn
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/navigation-bar/wx.hideNavigationBarLoading.html
+     */
+    hideNavigationBarLoading(option?: hideNavigationBarLoading.Option): void
+
+    /** 隐藏返回首页按钮。微信7.0.7版本起，当用户打开的小程序最底层页面是非首页时，默认展示“返回首页”按钮，开发者可在页面 onShow 中调用 hideHomeButton 进行隐藏。
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/navigation-bar/wx.hideHomeButton.html
+     */
+    hideHomeButton(option?: hideHomeButton.Option): Promise<TaroGeneral.CallbackResult>
+  }
 }

package/types/api/ui/pull-down-refresh.d.ts

@@ -1,46 +1,50 @@
-declare namespace Taro {
+import Taro from '../../index'
+
+declare module '../../index' {
   namespace stopPullDownRefresh {
     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
-   * @example
-   * ```tsx
-   * onPullDownRefresh: function (){
-   *   Taro.stopPullDownRefresh()
-   * }
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/pull-down-refresh/wx.stopPullDownRefresh.html
-   */
-  function stopPullDownRefresh(option?: stopPullDownRefresh.Option): void
-
   namespace startPullDownRefresh {
     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
-   * @rn 无动画效果
-   * @example
-   * ```tsx
-   * Taro.startPullDownRefresh()
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/pull-down-refresh/wx.startPullDownRefresh.html
-   */
-  function startPullDownRefresh(option?: startPullDownRefresh.Option): Promise<General.CallbackResult>
+  interface TaroStatic {
+    /** 停止当前页面下拉刷新。
+     * @supported weapp, h5, rn
+     * @example
+     * ```tsx
+     * onPullDownRefresh: function (){
+     *   Taro.stopPullDownRefresh()
+     * }
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/pull-down-refresh/wx.stopPullDownRefresh.html
+     */
+    stopPullDownRefresh(option?: stopPullDownRefresh.Option): void
+
+    /** 开始下拉刷新。调用后触发下拉刷新动画，效果与用户手动下拉刷新一致。
+     * @supported weapp, h5, rn
+     * @rn 无动画效果
+     * @example
+     * ```tsx
+     * Taro.startPullDownRefresh()
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/pull-down-refresh/wx.startPullDownRefresh.html
+     */
+    startPullDownRefresh(option?: startPullDownRefresh.Option): Promise<TaroGeneral.CallbackResult>
+  }
 }

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

@@ -1,41 +1,45 @@
-declare namespace Taro {
+import Taro from '../../index'
+
+declare module '../../index' {
   namespace pageScrollTo {
     interface Option {
       /** 接口调用结束的回调函数（调用成功、失败都会执行） */
-      complete?: (res: General.CallbackResult) => void
+      complete?: (res: TaroGeneral.CallbackResult) => void
       /** 滚动动画的时长，单位 ms */
       duration?: number
       /** 接口调用失败的回调函数 */
-      fail?: (res: General.CallbackResult) => void
+      fail?: (res: TaroGeneral.CallbackResult) => void
       /** 滚动到页面的目标位置，单位 px */
       scrollTop?: number
       /** 选择器, css selector */
       selector?: string
       /** 接口调用成功的回调函数 */
-      success?: (res: General.CallbackResult) => void
+      success?: (res: TaroGeneral.CallbackResult) => void
     }
   }
 
-  /** 将页面滚动到目标位置，支持选择器和滚动距离两种方式定位
-   *
-   * **selector 语法**
-   * selector类似于 CSS 的选择器，但仅支持下列语法。
-   *
-   * + ID选择器：#the-id
-   * + class选择器（可以连续指定多个）：.a-class.another-class
-   * + 子元素选择器：.the-parent > .the-child
-   * + 后代选择器：.the-ancestor .the-descendant
-   * + 跨自定义组件的后代选择器：.the-ancestor >>> .the-descendant
-   * + 多选择器的并集：#a-node, .some-other-nodes
-   * @supported weapp, h5
-   * @example
-   * ```tsx
-   * Taro.pageScrollTo({
-   *   scrollTop: 0,
-   *   duration: 300
-   * })
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/scroll/wx.pageScrollTo.html
-   */
-  function pageScrollTo(option: pageScrollTo.Option): Promise<General.CallbackResult>
+  interface TaroStatic {
+    /** 将页面滚动到目标位置，支持选择器和滚动距离两种方式定位
+     *
+     * **selector 语法**
+     * selector类似于 CSS 的选择器，但仅支持下列语法。
+     *
+     * + ID选择器：#the-id
+     * + class选择器（可以连续指定多个）：.a-class.another-class
+     * + 子元素选择器：.the-parent > .the-child
+     * + 后代选择器：.the-ancestor .the-descendant
+     * + 跨自定义组件的后代选择器：.the-ancestor >>> .the-descendant
+     * + 多选择器的并集：#a-node, .some-other-nodes
+     * @supported weapp, h5
+     * @example
+     * ```tsx
+     * Taro.pageScrollTo({
+     *   scrollTop: 0,
+     *   duration: 300
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/scroll/wx.pageScrollTo.html
+     */
+    pageScrollTo(option: pageScrollTo.Option): Promise<TaroGeneral.CallbackResult>
+  }
 }

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

@@ -1,29 +1,32 @@
-declare namespace Taro {
+import Taro from '../../index'
+
+declare module '../../index' {
   namespace setTopBarText {
     interface Option {
       /** 置顶栏文字 */
       text: 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
     }
   }
-
-  /** 动态设置置顶栏文字内容。只有当前小程序被置顶时能生效，如果当前小程序没有被置顶，也能调用成功，但是不会立即生效，只有在用户将这个小程序置顶后才换上设置的文字内容.
-   *
-   * **注意**
-   * - 调用成功后，需间隔 5s 才能再次调用此接口，如果在 5s 内再次调用此接口，会回调 fail，errMsg："setTopBarText: fail invoke too frequently"
-   * @supported weapp
-   * @example
-   * ```tsx
-   * Taro.setTopBarText({
-   *   text: 'hello, world!'
-   * })
-   * ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/sticky/wx.setTopBarText.html
-   */
-  function setTopBarText(option: setTopBarText.Option): Promise<General.CallbackResult>
+  interface TaroStatic {
+    /** 动态设置置顶栏文字内容。只有当前小程序被置顶时能生效，如果当前小程序没有被置顶，也能调用成功，但是不会立即生效，只有在用户将这个小程序置顶后才换上设置的文字内容.
+     *
+     * **注意**
+     * - 调用成功后，需间隔 5s 才能再次调用此接口，如果在 5s 内再次调用此接口，会回调 fail，errMsg："setTopBarText: fail invoke too frequently"
+     * @supported weapp
+     * @example
+     * ```tsx
+     * Taro.setTopBarText({
+     *   text: 'hello, world!'
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/sticky/wx.setTopBarText.html
+     */
+    setTopBarText(option: setTopBarText.Option): Promise<TaroGeneral.CallbackResult>
+  }
 }