@tarojs/components 3.5.5 → 3.5.6-alpha.0

package/types/MatchMedia.d.ts

@@ -1,39 +1,38 @@
 import { ComponentType } from 'react'
 import { StandardProps } from './common'
-
 interface MatchMediaProps extends StandardProps {
   /** 页面最小宽度（ px 为单位）
-   * @supported weapp
+   * @supported weapp, alipay
    */
-  minWidth?:	number
+  minWidth?: number
 
   /** 页面最大宽度（ px 为单位）
-   * @supported weapp
+   * @supported weapp, alipay
    */
   maxWidth?: number
 
   /** 页面宽度（ px 为单位）
-   * @supported weapp
+   * @supported weapp, alipay
    */
   width?: number
 
   /** 页面最小高度（ px 为单位）
-   * @supported weapp
+   * @supported weapp, alipay
    */
   minHeight?: number
 
   /** 页面最大高度（ px 为单位）
-   * @supported weapp
+   * @supported weapp, alipay
    */
   maxHeight?: number
 
   /** 页面高度（ px 为单位）
-   * @supported weapp
+   * @supported weapp, alipay
    */
   height?: number
 
   /** 屏幕方向（ landscape 或 portrait ）
-   * @supported weapp
+   * @supported weapp, alipay
    */
   orientation?: string
 }
@@ -75,5 +74,4 @@ interface MatchMediaProps extends StandardProps {
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/match-media.html
  */
 declare const MatchMedia: ComponentType<MatchMediaProps>
-
 export { MatchMedia, MatchMediaProps }

package/types/MovableArea.d.ts

@@ -1,10 +1,9 @@
 import { ComponentType } from 'react'
 import { StandardProps } from './common'
-
 interface MovableAreaProps extends StandardProps {
   /** 当里面的 movable-view 设置为支持双指缩放时，设置此值可将缩放手势生效区域修改为整个 movable-area
    * @default false
-   * @supported weapp, tt
+   * @supported weapp, alipay, swan, tt, qq
    */
   scaleArea?: boolean
 }
@@ -33,5 +32,4 @@ interface MovableAreaProps extends StandardProps {
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/movable-area.html
  */
 declare const MovableArea: ComponentType<MovableAreaProps>
-
 export { MovableArea, MovableAreaProps }

package/types/MovableView.d.ts

@@ -1,141 +1,200 @@
 import { ComponentType } from 'react'
-import { StandardProps, CommonEventFunction, TouchEventFunction } from './common'
-
+import {
+  StandardProps,
+  CommonEventFunction,
+  TouchEventFunction,
+} from './common'
 interface MovableViewProps extends Omit<StandardProps, 'animation'> {
   /** movable-view 的移动方向，属性值有`all`、`vertical`、`horizontal`、`none`
    * @default none
-   * @supported weapp, rn, tt
+   * @supported weapp, alipay, swan, tt, qq, rn
    */
   direction?: 'all' | 'vertical' | 'horizontal' | 'none'
 
   /** movable-view 是否带有惯性
    * @default false
-   * @supported weapp, tt
+   * @supported weapp, alipay, swan, tt, qq
    */
   inertia?: boolean
 
   /** 超过可移动区域后，movable-view 是否还可以移动
    * @default false
-   * @supported weapp, tt
+   * @supported weapp, alipay, swan, tt, qq
    */
   outOfBounds?: boolean
 
   /** 定义 x 轴方向的偏移，如果 x 的值不在可移动范围内，会自动移动到可移动范围；改变 x 的值会触发动画
-   * @supported weapp, rn, tt
+   * @supported weapp, alipay, swan, tt, qq, rn
    */
   x?: number | string
 
   /** 定义 y 轴方向的偏移，如果 y 的值不在可移动范围内，会自动移动到可移动范围；改变 y 的值会触发动画
-   * @supported weapp, rn, tt
+   * @supported weapp, alipay, swan, tt, qq, rn
    */
   y?: number | string
 
   /** 阻尼系数，用于控制x或y改变时的动画和过界回弹的动画，值越大移动越快
    * @default 20
-   * @supported weapp, tt
+   * @supported weapp, alipay, swan, tt, qq
    */
   damping?: number
 
   /** 摩擦系数，用于控制惯性滑动的动画，值越大摩擦力越大，滑动越快停止；必须大于 0，否则会被设置成默认值
    * @default 2
-   * @supported weapp, tt
+   * @supported weapp, alipay, swan, tt, qq
    */
   friction?: number
 
   /** 是否禁用
    * @default false
-   * @supported weapp, rn, tt
+   * @supported weapp, alipay, swan, tt, qq, rn
    */
   disabled?: boolean
 
   /** 是否支持双指缩放，默认缩放手势生效区域是在 movable-view 内
    * @default false
-   * @supported weapp, tt
+   * @supported weapp, alipay, swan, tt, qq
    */
   scale?: boolean
 
   /** 定义缩放倍数最小值
    * @default 0.5
-   * @supported weapp, tt
+   * @supported weapp, alipay, swan, tt, qq
    */
   scaleMin?: number
 
   /** 定义缩放倍数最大值
    * @default 10
-   * @supported weapp, tt
+   * @supported weapp, alipay, swan, tt, qq
    */
   scaleMax?: number
 
   /** 定义缩放倍数，取值范围为 0.5 - 10
    * @default 1
-   * @supported weapp, tt
+   * @supported weapp, alipay, swan, tt, qq
    */
   scaleValue?: number
 
   /** 是否使用动画
    * @default true
-   * @supported weapp, tt
+   * @supported weapp, alipay, swan, tt, qq
    */
   animation?: boolean
 
   /** 拖动过程中触发的事件
-   * @supported weapp, tt
+   * @supported weapp, alipay, swan, tt, qq
    */
   onChange?: CommonEventFunction<MovableViewProps.onChangeEventDetail>
 
   /** 缩放过程中触发的事件
-   * @supported weapp, tt
+   * @supported weapp, alipay, swan, tt, qq
    */
   onScale?: CommonEventFunction<MovableViewProps.onScaleEventDetail>
 
-  /** 初次手指触摸后移动为横向的移动，如果 catch 此事件，则意味着 touchmove 事件也被 catch
+  /** 开始拖动时触发
+   * @supported rn
+   */
+  onDragStart?: CommonEventFunction
+
+  /** 拖动结束时触发
+   * @supported rn
+   */
+  onDragEnd?: CommonEventFunction
+
+  /** 初次手指触摸后移动为横向的移动时触发，如果 catch 此事件，则意味着 touchmove 事件也被catch
    * @supported weapp, tt
    */
+  catchTouchmove?: CommonEventFunction
+
+  /** 触摸动作开始，事件会向父节点传递。
+   * 版本要求： 基础库 1.11.5 及以上
+   * @supported alipay
+   */
+  onTouchStart?: CommonEventFunction
+
+  /** 触摸动作开始，事件仅作用于组件，不向父节点传递。
+   * 版本要求： 基础库 1.11.5 及以上
+   * @supported alipay
+   */
+  catchTouchStart?: CommonEventFunction
+
+  /** 触摸移动事件，事件会向父节点传递。
+   * 版本要求： 基础库 1.11.5 及以上
+   * @supported alipay
+   */
+  onTouchMove?: CommonEventFunction
+
+  /** 初次手指触摸后移动为横向的移动，如果 catch 此事件，则意味着 touchmove 事件也被 catch
+   * @supported swan
+   */
   onHTouchMove?: TouchEventFunction
 
   /** 初次手指触摸后移动为纵向的移动，如果 catch 此事件，则意味着 touchmove 事件也被 catch
-   * @supported weapp, tt
+   * @supported swan
    */
   onVTouchMove?: TouchEventFunction
-  /** 开始拖动时触发
-   * @supported rn
+
+  /** 触摸移动事件，事件仅作用于组件，不向父节点传递。
+   * 版本要求： 基础库 1.11.5 及以上
+   * @supported alipay
    */
-  onDragStart?: CommonEventFunction
-  /** 拖动结束时触发
-   * @supported rn
+  catchTouchMove?: CommonEventFunction
+
+  /** 触摸动作结束，事件会向父节点传递。
+   * @supported alipay
    */
-  onDragEnd?: CommonEventFunction
-}
+  onTouchEnd?: CommonEventFunction
 
+  /** 触摸动作结束，事件仅作用于组件，不向父节点传递。
+   * @supported alipay
+   */
+  catchTouchEnd?: CommonEventFunction
+
+  /** 触摸动作被打断，如来电提醒、弹窗。
+   * @supported alipay
+   */
+  onTouchCancel?: CommonEventFunction
+
+  /** 拖动结束触发的事件
+   * @supported alipay
+   */
+  onChangeEnd?: CommonEventFunction<MovableViewProps.onChangeEventDetail>
+}
 declare namespace MovableViewProps {
   /** 拖动过程中触发的事件 */
   interface TChangeSource {
     /** 拖动 */
     touch
+
     /** 超出移动范围 */
     'touch-out-of-bounds'
+
     /** 超出移动范围后的回弹 */
     'out-of-bounds'
+
     /** 惯性 */
-    'friction'
+    friction
+
     /** setData */
     ''
   }
-
   interface onChangeEventDetail {
     /** X 坐标 */
     x: number
+
     /** Y 坐标 */
     y: number
+
     /** 触发事件 */
     source: keyof MovableViewProps.TChangeSource
   }
-
   interface onScaleEventDetail {
     /** X 坐标 */
     x: number
+
     /** Y 坐标 */
     y: number
+
     /** 缩放比例 */
     scale: number
   }
@@ -165,5 +224,4 @@ declare namespace MovableViewProps {
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/movable-view.html
  */
 declare const MovableView: ComponentType<MovableViewProps>
-
 export { MovableView, MovableViewProps }

package/types/NavigationBar.d.ts

@@ -1,6 +1,5 @@
 import { ComponentType } from 'react'
 import { StandardProps, CommonEventFunction } from './common'
-
 interface NavigationBarProps extends StandardProps {
   /** 导航条标题
    * @supported weapp
@@ -41,5 +40,4 @@ interface NavigationBarProps extends StandardProps {
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/open-data.html
  */
 declare const NavigationBar: ComponentType<NavigationBarProps>
-
 export { NavigationBar, NavigationBarProps }

package/types/Navigator.d.ts

@@ -1,118 +1,136 @@
 import { ComponentType } from 'react'
 import { StandardProps, CommonEventFunction } from './common'
-
 interface NavigatorProps extends StandardProps {
   /** 在哪个目标上发生跳转，默认当前小程序
    * @default "self"
-   * @supported weapp, swan
+   * @supported weapp, swan, qq
    */
   target?: keyof NavigatorProps.Target
 
   /** 当前小程序内的跳转链接
-   * @supported weapp, swan, alipay, tt
+   * @supported weapp, alipay, swan, tt, qq, jd
    */
   url?: string
 
   /** 跳转方式
    * @default "navigate"
-   * @supported weapp, swan, alipay, tt
+   * @supported weapp, alipay, swan, tt, qq, jd
    */
   openType?: keyof NavigatorProps.OpenType
 
   /** 当 open-type 为 'navigateBack' 时有效，表示回退的层数
-   * @supported weapp, swan, tt
+   * @supported weapp, swan, tt, qq, jd
    */
   delta?: number
 
   /** 当 `target="miniProgram"` 时有效，要打开的小程序 appId
-   * @supported weapp, swan
+   * @supported weapp, swan, qq
    */
   appId?: string
 
   /** 当 `target="miniProgram"` 时有效，打开的页面路径，如果为空则打开首页
-   * @supported weapp, swan
+   * @supported weapp, swan, qq
    */
   path?: string
 
   /** 当 `target="miniProgram"` 时有效，需要传递给目标小程序的数据，目标小程序可在 `App.onLaunch()`，`App.onShow()` 中获取到这份数据.
-   * @supported weapp, swan
+   * @supported weapp, swan, qq
    */
   extraData?: object
 
   /** 当 `target="miniProgram"` 时有效，要打开的小程序版本
-   * @supported weapp, swan
+   * @supported weapp, swan, qq
    */
   version?: keyof NavigatorProps.Version
 
   /** 指定按下去的样式类。当 `hover-class="none"` 时，没有点击态效果
    * @default "navigator-hover"
-   * @supported weapp, swan, alipay, tt
+   * @supported weapp, alipay, swan, tt, qq, jd
    */
   hoverClass?: string
 
   /** 指定是否阻止本节点的祖先节点出现点击态
    * @default false
-   * @supported weapp, swan, tt
+   * @supported weapp, swan, tt, qq, jd
    */
   hoverStopPropagation?: boolean
 
   /** 按住后多久出现点击态，单位毫秒
    * @default 50
-   * @supported weapp, swan, alipay, tt
+   * @supported weapp, alipay, swan, tt, qq, jd
    */
   hoverStartTime?: number
 
   /** 手指松开后点击态保留时间，单位毫秒
    * @default 600
-   * @supported weapp, swan, alipay, tt
+   * @supported weapp, alipay, swan, tt, qq, jd
    */
   hoverStayTime?: number
 
   /** 当 `target="miniProgram"` 时有效，跳转小程序成功
-   * @supported weapp, swan
+   * @supported weapp, swan, qq
    */
   onSuccess?: CommonEventFunction
 
   /** 当 `target="miniProgram"` 时有效，跳转小程序失败
-   * @supported weapp, swan
+   * @supported weapp, swan, qq
    */
   onFail?: CommonEventFunction
 
   /** 当 `target="miniProgram"` 时有效，跳转小程序完成
-   * @supported weapp, swan
+   * @supported weapp, swan, qq
    */
   onComplete?: CommonEventFunction
-}
 
+  /** 当target="miniProgram"时有效，当传递该参数后，可以不传 app-id 和 path。链接可以通过【小程序菜单】->【复制链接】获取。
+   * @supported weapp
+   */
+  shortLink?: string
+
+  /** 无障碍访问，（属性）元素的额外描述
+   * @supported qq
+   */
+  ariaLabel?: string
+}
 declare namespace NavigatorProps {
   /** target 的合法值 */
   interface Target {
     /** 当前小程序 */
     self
+
     /** 其它小程序 */
     miniProgram
   }
+
   /** open-type 的合法值 */
   interface OpenType {
     /** 对应 Taro.navigateTo 或 Taro.navigateToMiniProgram 的功能 */
     navigate
+
     /** 对应 Taro.redirectTo 的功能 */
     redirect
+
     /** 对应 Taro.switchTab 的功能 */
     switchTab
+
     /** 对应 Taro.reLaunch 的功能 */
     reLaunch
+
     /** 对应 Taro.navigateBack 的功能 */
     navigateBack
+
     /** 退出小程序，`target="miniProgram"` 时生效 */
     exit
   }
+
   /** version 的合法值 */
   interface Version {
     /** 开发版 */
     develop
+
     /** 体验版 */
     trial
+
     /** 正式版，仅在当前小程序为开发版或体验版时此参数有效；如果当前小程序是正式版，则打开的小程序必定是正式版。 */
     release
   }
@@ -124,5 +142,4 @@ declare namespace NavigatorProps {
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/navigator.html
  */
 declare const Navigator: ComponentType<NavigatorProps>
-
 export { Navigator, NavigatorProps }

package/types/OfficialAccount.d.ts

@@ -1,6 +1,5 @@
 import { ComponentType } from 'react'
 import { StandardProps, CommonEventFunction } from './common'
-
 interface OfficialAccountProps extends StandardProps {
   /** 组件加载成功时触发
    * @supported weapp
@@ -12,33 +11,42 @@ interface OfficialAccountProps extends StandardProps {
    */
   onError?: CommonEventFunction<OfficialAccountProps.Detail>
 }
-
 declare namespace OfficialAccountProps {
   /** detail 对象 */
   interface Detail {
     /** 状态码 */
     status: number
+
     /** 错误信息 */
     errMsg: string
   }
+
   /** status 有效值 */
   interface Status {
     /** 网络错误 */
     '-2'
+
     /** 数据解析错误 */
     '-1'
+
     /** 加载成功 */
     0
+
     /** 小程序关注公众号功能被封禁 */
     1
+
     /** 关联公众号被封禁 */
     2
+
     /** 关联关系解除或未选中关联公众号 */
     3
+
     /** 未开启关注公众号功能 */
     4
+
     /** 场景值错误 */
     5
+
     /** 重复创建 */
     6
   }
@@ -59,5 +67,4 @@ declare namespace OfficialAccountProps {
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/official-account.html
  */
 declare const OfficialAccount: ComponentType<OfficialAccountProps>
-
 export { OfficialAccount, OfficialAccountProps }

package/types/OpenData.d.ts

@@ -1,18 +1,19 @@
 import { ComponentType } from 'react'
 import { StandardProps, CommonEventFunction } from './common'
-
 interface OpenDataProps extends StandardProps {
   /** 开放数据类型
-   * @supported weapp, tt
+   * @supported weapp, swan, tt, qq
    */
   type: keyof OpenDataProps.Type
+
   /** 当 type="groupName" 时生效, 群id
    * @supported weapp
    */
   openGid?: string
+
   /** 当 type="user*" 时生效，以哪种语言展示 userInfo
    * @default "en"
-   * @supported weapp
+   * @supported weapp, qq
    */
   lang?: keyof OpenDataProps.Lang
 
@@ -27,37 +28,66 @@ interface OpenDataProps extends StandardProps {
   defaultAvatar?: string
 
   /** 群名称或用户信息为空时触发
-   * @supported weapp, tt
+   * @supported weapp, tt, qq
    */
   onError?: CommonEventFunction
-}
 
+  /** 当数据为空且未设置默认值时，是否显示官方默认值
+   * @supported tt
+   */
+  useEmptyValue?: string
+
+  /** 当 type=groupCloudStorage 时有效，群分享对应的 shareTicket
+   * @supported qq
+   */
+  shareTicket?: string
+
+  /** 当 type=*CloudStorage 时有效，指定要拉取的 key 列表
+   * @supported qq
+   */
+  keyList?: string
+
+  /** 当 type=*CloudStorage 时有效，从主域透传给开放数据域的数据，会自动注入到自定义开放数据域组件的 properties 中
+   * @supported qq
+   */
+  componentData?: string
+}
 declare namespace OpenDataProps {
   /** type 的合法值 */
   interface Type {
     /** 拉取群名称 */
     groupName
+
     /** 用户昵称 */
     userNickName
+
     /** 用户头像 */
     userAvatarUrl
+
     /** 用户性别 */
     userGender
+
     /** 用户所在城市 */
     userCity
+
     /** 用户所在省份 */
     userProvince
+
     /** 用户所在国家 */
     userCountry
+
     /** 用户的语言 */
     userLanguage
   }
+
   /** lang 的合法值 */
   interface Lang {
     /** 英文 */
     en
+
     /** 简体中文 */
     zh_CN
+
     /** 繁体中文 */
     zh_TW
   }
@@ -85,5 +115,4 @@ declare namespace OpenDataProps {
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/open-data.html
  */
 declare const OpenData: ComponentType<OpenDataProps>
-
 export { OpenData, OpenDataProps }

package/types/PageContainer.d.ts

@@ -1,6 +1,8 @@
 import { ComponentType } from 'react'
-import { StandardProps, CommonEventFunction, BaseEventOrigFunction } from './common'
-
+import {
+  StandardProps,
+  CommonEventFunction,
+} from './common'
 interface PageContainerProps extends StandardProps {
   /** 是否显示容器组件
    * @default false
@@ -38,12 +40,6 @@ interface PageContainerProps extends StandardProps {
    */
   round?: boolean
 
-  /** 是否在下滑一段距离后关闭
-   * @default false
-   * @supported weapp
-   */
-  closeOnSlideDown?: boolean
-
   /** 自定义遮罩层样式
    * @supported weapp, rn
    */
@@ -88,17 +84,25 @@ interface PageContainerProps extends StandardProps {
    * @supported weapp
    */
   onClickOverlay?: CommonEventFunction
-}
 
+  /** 是否在下滑一段距离后关闭
+   * @supported weapp
+   * @default false
+   */
+  closeOnSlideDown?: string
+}
 declare namespace PageContainerProps {
   /** 弹出位置 */
   interface Position {
     /** 上方弹出 */
     top
+
     /** 下方弹出 */
     bottom
+
     /** 右边弹出 */
     right
+
     /** 中央弹出 */
     center
   }
@@ -117,5 +121,4 @@ declare namespace PageContainerProps {
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/page-container.html
  */
 declare const PageContainer: ComponentType<PageContainerProps>
-
 export { PageContainer, PageContainerProps }