@spcsn/taro 0.1.0

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

@@ -0,0 +1,196 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  namespace showTabBarRedDot {
+    interface Option {
+      /** tabBar 的哪一项，从左边算起 */
+      index: number
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  namespace showTabBar {
+    interface Option {
+      /** 是否需要动画效果 */
+      animation?: boolean
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  namespace setTabBarStyle {
+    interface Option {
+      /** tab 的背景色，HexColor */
+      backgroundColor?: string
+      /** tabBar上边框的颜色， 仅支持 black/white */
+      borderStyle?: string
+      /** tab 上的文字默认颜色，HexColor */
+      color?: string
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** tab 上的文字选中时的颜色，HexColor */
+      selectedColor?: string
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  namespace setTabBarItem {
+    interface Option {
+      /** tabBar 的哪一项，从左边算起 */
+      index: number
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 图片路径，icon 大小限制为 40kb，建议尺寸为 81px * 81px，当 postion 为 top 时，此参数无效 */
+      iconPath?: string
+      /** 选中时的图片路径，icon 大小限制为 40kb，建议尺寸为 81px * 81px ，当 postion 为 top 时，此参数无效 */
+      selectedIconPath?: string
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+      /** tab 上的按钮文字 */
+      text?: string
+    }
+  }
+
+  namespace setTabBarBadge {
+    interface Option {
+      /** tabBar 的哪一项，从左边算起 */
+      index: number
+      /** 显示的文本，超过 4 个字符则显示成 ... */
+      text: string
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  namespace removeTabBarBadge {
+    interface Option {
+      /** tabBar 的哪一项，从左边算起 */
+      index: number
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  namespace hideTabBarRedDot {
+    interface Option {
+      /** tabBar 的哪一项，从左边算起 */
+      index: number
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  namespace hideTabBar {
+    interface Option {
+      /** 是否需要动画效果 */
+      animation?: boolean
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  interface TaroStatic {
+    /** 显示 tabBar 某一项的右上角的红点
+     * @supported weapp, h5, rn, tt, harmony_hybrid
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/tab-bar/wx.showTabBarRedDot.html
+     */
+    showTabBarRedDot(option: showTabBarRedDot.Option): Promise<TaroGeneral.CallbackResult>
+
+    /** 显示 tabBar
+     * @supported weapp, h5, rn, tt, harmony_hybrid
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/tab-bar/wx.showTabBar.html
+     */
+    showTabBar(option?: showTabBar.Option): Promise<TaroGeneral.CallbackResult>
+
+    /** 动态设置 tabBar 的整体样式
+     * @supported weapp, h5, rn, tt, harmony_hybrid
+     * @example
+     * ```tsx
+     * Taro.setTabBarStyle({
+     *   color: '#FF0000',
+     *   selectedColor: '#00FF00',
+     *   backgroundColor: '#0000FF',
+     *   borderStyle: 'white'
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/tab-bar/wx.setTabBarStyle.html
+     */
+    setTabBarStyle(option?: setTabBarStyle.Option): Promise<TaroGeneral.CallbackResult>
+
+    /** 动态设置 tabBar 某一项的内容，`2.7.0` 起图片支持临时文件和网络文件。
+     * @supported weapp, h5, rn, tt, harmony_hybrid
+     * @example
+     * ```tsx
+     * Taro.setTabBarItem({
+     *   index: 0,
+     *   text: 'text',
+     *   iconPath: '/path/to/iconPath',
+     *   selectedIconPath: '/path/to/selectedIconPath'
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/tab-bar/wx.setTabBarItem.html
+     */
+    setTabBarItem(option: setTabBarItem.Option): Promise<TaroGeneral.CallbackResult>
+
+    /** 为 tabBar 某一项的右上角添加文本
+     * @supported weapp, h5, rn, tt, harmony_hybrid
+     * @example
+     * ```tsx
+     * Taro.setTabBarBadge({
+     *   index: 0,
+     *   text: '1'
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/tab-bar/wx.setTabBarBadge.html
+     */
+    setTabBarBadge(option: setTabBarBadge.Option): Promise<TaroGeneral.CallbackResult>
+
+    /** 移除 tabBar 某一项右上角的文本
+     * @supported weapp, h5, rn, tt, harmony_hybrid
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/tab-bar/wx.removeTabBarBadge.html
+     */
+    removeTabBarBadge(option: removeTabBarBadge.Option): Promise<TaroGeneral.CallbackResult>
+
+    /** 隐藏 tabBar 某一项的右上角的红点
+     * @supported weapp, h5, rn, tt, harmony_hybrid
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/tab-bar/wx.hideTabBarRedDot.html
+     */
+    hideTabBarRedDot(option: hideTabBarRedDot.Option): Promise<TaroGeneral.CallbackResult>
+
+    /** 隐藏 tabBar
+     * @supported weapp, h5, rn, tt, harmony_hybrid
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/tab-bar/wx.hideTabBar.html
+     */
+    hideTabBar(option?: hideTabBar.Option): Promise<TaroGeneral.CallbackResult>
+  }
+}

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

@@ -0,0 +1,71 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  namespace setWindowSize {
+    interface Option {
+      /** 窗口宽度，以像素为单位 */
+      width: string
+      /** 窗口高度，以像素为单位 */
+      height: string
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+  namespace onWindowResize {
+    /** 窗口尺寸变化事件的回调函数 */
+    type Callback = (result: CallbackResult) => void
+
+    interface CallbackResult {
+      size: Size
+    }
+
+    interface Size {
+      /** 变化后的窗口高度，单位 px */
+      windowHeight: number
+      /** 变化后的窗口宽度，单位 px */
+      windowWidth: number
+    }
+  }
+
+  namespace offWindowResize {
+    /** 窗口尺寸变化事件的回调函数 */
+    type Callback = (res: TaroGeneral.CallbackResult) => void
+  }
+
+  interface TaroStatic {
+    /** 设置窗口大小，该接口仅适用于 PC 平台，使用细则请参见指南
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/window/wx.setWindowSize.html
+     */
+    setWindowSize(option: setWindowSize.Option): Promise<TaroGeneral.CallbackResult>
+
+    /** 监听窗口尺寸变化事件
+     * @supported weapp, h5, rn, harmony_hybrid
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/window/wx.onWindowResize.html
+     */
+    onWindowResize(
+      /** 窗口尺寸变化事件的回调函数 */
+      callback: onWindowResize.Callback,
+    ): void
+
+    /** 取消监听窗口尺寸变化事件
+     * @supported weapp, h5, rn, harmony_hybrid
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/window/wx.offWindowResize.html
+     */
+    offWindowResize(
+      /** 窗口尺寸变化事件的回调函数 */
+      callback: offWindowResize.Callback,
+    ): void
+
+    /**
+     * 返回当前是否存在小窗播放（小窗在 video/live-player/live-pusher 下可用）
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui/window/wx.checkIsPictureInPictureActive.html
+     */
+    checkIsPictureInPictureActive(): boolean
+  }
+}

package/types/api/worker/index.d.ts

@@ -0,0 +1,83 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  namespace Worker {
+    type OnMessageCallback = (
+      result: OnMessageCallbackResult,
+    ) => void
+    interface OnMessageCallbackResult {
+      /** 主线程/Worker 线程向当前线程发送的消息 */
+      message: TaroGeneral.IAnyObject
+    }
+  }
+  interface Worker {
+    /** 监听主线程/Worker 线程向当前线程发送的消息的事件。
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/worker/Worker.onMessage.html
+     */
+    onMessage(
+      /** 主线程/Worker 线程向当前线程发送的消息的事件的回调函数 */
+      callback: Worker.OnMessageCallback,
+    ): void
+    /** 监听 worker 线程被系统回收事件（当 iOS 系统资源紧张时，worker 线程存在被系统回收的可能，开发者可监听此事件并重新创建一个 worker）
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/worker/Worker.onProcessKilled.html
+     */
+    onProcessKilled(
+      /** worker 线程被系统回收事件的回调函数 */
+      callback: Worker.OnMessageCallback,
+    ): void
+    /** 向主线程/Worker 线程发送的消息。
+     * @supported weapp
+     * @example
+     * worker 线程中
+     *
+     * ```tsx
+     * worker.postMessage({
+     *   msg: 'hello from worker'
+     * })
+     * ```
+     *
+     * 主线程中
+     *
+     * ```tsx
+     * const worker = Taro.createWorker('workers/request/index.js')
+     * worker.postMessage({
+     *   msg: 'hello from main'
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/worker/Worker.postMessage.html
+     */
+    postMessage(
+      /** 需要发送的消息，必须是一个可序列化的 JavaScript key-value 形式的对象。 */
+      message: TaroGeneral.IAnyObject,
+    ): void
+    /** 结束当前 Worker 线程。仅限在主线程 worker 对象上调用。
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/worker/Worker.terminate.html
+     */
+    terminate(): void
+  }
+
+  interface TaroStatic {
+    /** 创建一个 Worker 线程。目前限制最多只能创建一个 Worker，创建下一个 Worker 前请先调用 [Worker.terminate](/docs/apis/worker/#terminate)
+     * @supported weapp
+     * @example
+     * ```tsx
+     * const worker = Taro.createWorker('workers/request/index.js') // 文件名指定 worker 的入口文件路径，绝对路径
+     *   worker.onMessage(function (res) {
+     *   console.log(res)
+     * })
+     * worker.postMessage({
+     *   msg: 'hello worker'
+     * })
+     * worker.terminate()
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/worker/wx.createWorker.html
+     */
+    createWorker(
+      /** worker 入口文件的**绝对路径** */
+      scriptPath: string,
+    ): Worker
+  }
+}