@spcsn/taro 0.1.0

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

@@ -0,0 +1,281 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  namespace showToast {
+    interface Option {
+      /** 提示的内容 */
+      title: string
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 提示的延迟时间 */
+      duration?: number
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 图标
+       *
+       * 可选值：
+       * - 'success': 显示成功图标，此时 title 文本最多显示 7 个汉字长度;
+       * - 'error': 显示失败图标，此时 title 文本最多显示 7 个汉字长度;
+       * - 'loading': 显示加载图标，此时 title 文本最多显示 7 个汉字长度;
+       * - 'none': 不显示图标，此时 title 文本最多可显示两行 */
+      icon?: 'success' | 'error' | 'loading' | 'none'
+      /** 自定义图标的本地路径，image 的优先级高于 icon */
+      image?: string
+      /** 是否显示透明蒙层，防止触摸穿透 */
+      mask?: boolean
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  namespace showModal {
+    interface Option {
+      /** 取消按钮的文字颜色，必须是 16 进制格式的颜色字符串 */
+      cancelColor?: string
+      /** 取消按钮的文字，最多 4 个字符 */
+      cancelText?: string
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 确认按钮的文字颜色，必须是 16 进制格式的颜色字符串 */
+      confirmColor?: string
+      /** 确认按钮的文字，最多 4 个字符 */
+      confirmText?: string
+      /** 提示的内容 */
+      content?: string
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 是否显示取消按钮 */
+      showCancel?: boolean
+      /** 接口调用成功的回调函数 */
+      success?: (result: SuccessCallbackResult) => void
+      /** 提示的标题 */
+      title?: string
+    }
+
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+      /** 为 true 时，表示用户点击了取消（用于 Android 系统区分点击蒙层关闭还是点击取消按钮关闭） */
+      cancel: boolean
+      /** 为 true 时，表示用户点击了确定按钮 */
+      confirm: boolean
+      /** 调用结果 */
+      errMsg: string
+    }
+  }
+
+  namespace showLoading {
+    interface Option {
+      /** 提示的内容 */
+      title: string
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 是否显示透明蒙层，防止触摸穿透 */
+      mask?: boolean
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  namespace showActionSheet {
+    interface Option {
+      /** 警示文案 */
+      alertText?: string
+      /** 按钮的文字数组，数组长度最大为 6 */
+      itemList: string[]
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 按钮的文字颜色 */
+      itemColor?: string
+      /** 接口调用成功的回调函数 */
+      success?: (result: SuccessCallbackResult) => void
+    }
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+      /** 用户点击的按钮序号，从上到下的顺序，从0开始 */
+      tapIndex: number
+      /** 调用结果 */
+      errMsg: string
+    }
+  }
+
+  namespace hideToast {
+    interface Option {
+      /** 目前 toast 和 loading 相关接口可以相互混用，此参数可用于取消混用特性
+       * @default false
+       */
+      noConflict?: boolean
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  namespace hideLoading {
+    interface Option {
+      /** 目前 toast 和 loading 相关接口可以相互混用，此参数可用于取消混用特性
+       * @default false
+       */
+      noConflict?: boolean
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  namespace enableAlertBeforeUnload {
+    interface Option {
+      /** 询问对话框内容 */
+      message: string
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  namespace disableAlertBeforeUnload {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  interface TaroStatic {
+    /** 显示消息提示框
+     *
+     * **注意**
+     * - Taro.showLoading 和 Taro.showToast 同时只能显示一个
+     * - Taro.showToast 应与 Taro.hideToast 配对使用
+     * @supported weapp, h5, rn, tt, harmony, harmony_hybrid
+     * @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, swan, h5, rn, tt, harmony, harmony_hybrid
+     * @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, tt, harmony_hybrid
+     * @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, tt, harmony, harmony_hybrid
+     * @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, tt, harmony_hybrid
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/interaction/wx.hideToast.html
+     */
+    hideToast(option?: hideToast.Option): void
+
+    /** 隐藏 loading 提示框
+     * @supported weapp, h5, rn, tt, harmony_hybrid
+     * @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/menu.d.ts

@@ -0,0 +1,29 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  namespace getMenuButtonBoundingClientRect {
+    /** 菜单按钮的布局位置信息 */
+    interface Rect {
+      /** 下边界坐标，单位：px */
+      bottom: number
+      /** 高度，单位：px */
+      height: number
+      /** 左边界坐标，单位：px */
+      left: number
+      /** 右边界坐标，单位：px */
+      right: number
+      /** 上边界坐标，单位：px */
+      top: number
+      /** 宽度，单位：px */
+      width: number
+    }
+  }
+
+  interface TaroStatic {
+    /** 获取菜单按钮（右上角胶囊按钮）的布局位置信息。坐标信息以屏幕左上角为原点。
+     * @supported weapp, tt, harmony_hybrid
+     * @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

@@ -0,0 +1,130 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  namespace showNavigationBarLoading {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  namespace setNavigationBarTitle {
+    interface Option {
+      /** 页面标题 */
+      title: string
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  namespace setNavigationBarColor {
+    interface Option {
+      /** 背景颜色值，有效值为十六进制颜色 */
+      backgroundColor: string
+      /** 前景颜色值，包括按钮、标题、状态栏的颜色，仅支持 #ffffff 和 #000000 */
+      frontColor: string
+      /** 动画效果 */
+      animation?: AnimationOption
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+    /** 动画效果 */
+    interface AnimationOption {
+      /** 动画变化时间，单位 ms */
+      duration?: number
+      /** 动画变化方式
+       *
+       * 可选值：
+       * - 'linear': 动画从头到尾的速度是相同的;
+       * - 'easeIn': 动画以低速开始;
+       * - 'easeOut': 动画以低速结束;
+       * - 'easeInOut': 动画以低速开始和结束; */
+      timingFunc?: 'linear' | 'easeIn' | 'easeOut' | 'easeInOut'
+    }
+  }
+
+  namespace hideNavigationBarLoading {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  namespace hideHomeButton {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  interface TaroStatic {
+    /** 在当前页面显示导航条加载动画
+     * @supported weapp, rn, tt, harmony
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/navigation-bar/wx.showNavigationBarLoading.html
+     */
+    showNavigationBarLoading(option?: showNavigationBarLoading.Option): void
+
+    /** 动态设置当前页面的标题
+     * @supported weapp, alipay, tt, h5, rn, harmony, harmony_hybrid
+     * @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, tt, h5, rn, harmony, harmony_hybrid
+     * @h5 不支持 animation 参数
+     * @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, tt, harmony
+     * @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, tt, harmony
+     * @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

@@ -0,0 +1,50 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  namespace stopPullDownRefresh {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  namespace startPullDownRefresh {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  interface TaroStatic {
+    /** 停止当前页面下拉刷新。
+     * @supported weapp, h5, rn, tt, harmony, harmony_hybrid
+     * @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, tt, harmony, harmony_hybrid
+     * @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

@@ -0,0 +1,114 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  namespace pageScrollTo {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 滚动动画的时长，单位 ms */
+      duration?: number
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 滚动到页面的目标位置，单位 px */
+      scrollTop?: number
+      /** 选择器, css selector */
+      selector?: string
+      /** 偏移距离，需要和 selector 参数搭配使用，可以滚动到 selector 加偏移距离的位置，单位 px */
+      offsetTop?: number
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  /** 增强 ScrollView 实例，可通过 [Taro.createSelectorQuery](/docs/apis/wxml/createSelectorQuery) 的 [NodesRef.node](/docs/apis/wxml/NodesRef#node) 方法获取。 仅在 `scroll-view` 组件开启 `enhanced` 属性后生效。
+   * @supported weapp
+   * @example
+   * ```tsx
+   * Taro.createSelectorQuery()
+   *   .select('#scrollview')
+   *   .node()
+   *   .exec((res) => {
+   *     const scrollView = res[0].node;
+   *     scrollView.scrollEnabled = false;
+   *   })
+   * ```
+   * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/scroll/ScrollViewContext.html
+   */
+  interface ScrollViewContext {
+    /** 滚动开关 */
+    scrollEnabled: boolean
+
+    /** 设置滚动边界弹性 (仅在 iOS 下生效) */
+    bounces: boolean
+
+    /** 设置是否显示滚动条 */
+    showScrollbar: boolean
+
+    /** 分页滑动开关 */
+    pagingEnabled: boolean
+
+    /** 设置滚动减速速率 */
+    fastDeceleration: boolean
+
+    /** 取消滚动惯性 (仅在 iOS 下生效) */
+    decelerationDisabled: boolean
+
+    /** 滚动至指定位置
+     * @supported weapp, h5
+     * @h5 不支持 velocity 参数
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/scroll/ScrollViewContext.scrollTo.html
+     */
+    scrollTo(object: ScrollViewContext.scrollTo.Option): void
+
+    /** 滚动至指定位置
+     * @supported weapp, tt, h5
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/scroll/ScrollViewContext.scrollIntoView.html
+     */
+    scrollIntoView(
+      /** 元素选择器 */
+      selector: string
+    ): void
+  }
+
+  namespace ScrollViewContext {
+    namespace scrollTo {
+      interface Option {
+        /** 顶部距离 */
+        top?: number
+        /** 左边界距离 */
+        left?: number
+        /** 初始速度 */
+        velocity?: number
+        /** 滚动动画时长 */
+        duration?: number
+        /** 是否启用滚动动画 */
+        animated?: boolean
+      }
+    }
+  }
+
+  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, rn, tt, harmony, harmony_hybrid
+     * @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

@@ -0,0 +1,32 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  namespace setTopBarText {
+    interface Option {
+      /** 置顶栏文字 */
+      text: string
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+  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>
+  }
+}