@tarojs/components 3.5.6 → 3.5.7-alpha.1

package/types/LivePlayer.d.ts

@@ -72,6 +72,37 @@ interface LivePlayerProps extends StandardProps {
    */
   pictureInPictureMode?: ('push' | 'pop')[] | 'push' | 'pop' | ''
 
+  /** 当跳转到其它微信原生页面时，是否自动暂停本页面的实时音视频播放
+   * @supported weapp, qq
+   */
+  autoPauseIfOpenNative?: string
+
+  /** 格式固定为 https://servicewechat.com/{appid}/{version}/page-frame.html，其中 {appid} 为小程序的 appid，{version} 为小程序的版本号，版本号为 0 表示为开发版、体验版以及审核版本，版本号为 devtools 表示为开发者工具，其余为正式版本；
+   * @supported weapp
+   */
+  referrerPolicy?: 'origin' | 'no-referrer'
+
+  /** 设置署名水印
+   * @supported tt
+   */
+  signature?: string
+
+  /** 是否回调metadata
+   * @supported qq
+   */
+  enableMetadata?: string
+
+  /** live-player 属性的唯一标志符
+   * @supported swan
+   */
+  id?: string
+
+  /** 是否开启手机横屏时自动全屏，当系统设置开启自动旋转时生效
+   * @supported weapp
+   * @default false
+   */
+  enableAutoRotation?: string
+
   /** 播放状态变化事件，detail = {code}
    * @supported weapp, swan, tt, qq, jd
    */
@@ -102,40 +133,15 @@ interface LivePlayerProps extends StandardProps {
    */
   onLeavePictureInPicture?: CommonEventFunction
 
-  /** 当跳转到其它微信原生页面时，是否自动暂停本页面的实时音视频播放
-   * @supported weapp, qq
-   */
-  autoPauseIfOpenNative?: string
-
-  /** 格式固定为 https://servicewechat.com/{appid}/{version}/page-frame.html，其中 {appid} 为小程序的 appid，{version} 为小程序的版本号，版本号为 0 表示为开发版、体验版以及审核版本，版本号为 devtools 表示为开发者工具，其余为正式版本；
-   * @supported weapp
-   */
-  referrerPolicy?: 'origin' | 'no-referrer'
-
-  /** 设置署名水印
-   * @supported tt
-   */
-  signature?: string
-
   /** 播放错误事件
    * @supported tt
    */
   onError?: CommonEventFunction
 
-  /** 是否回调metadata
-   * @supported qq
-   */
-  enableMetadata?: string
-
   /** metadata通知，detail = {info}
    * @supported qq
    */
   onMetaDataChange?: CommonEventFunction
-
-  /** live-player 属性的唯一标志符
-   * @supported swan
-   */
-  id?: string
 }
 declare namespace LivePlayerProps {
   /** mode 的合法值 */

package/types/LivePusher.d.ts

@@ -186,6 +186,11 @@ interface LivePusherProps extends StandardProps {
    */
   filter?: keyof LivePusherProps.FilterType
 
+  /** 设置小窗模式： push, pop，空字符串或通过数组形式设置多种模式（如： ["push", "pop"]）
+   * @supported weapp
+   */
+  pictureInPictureMode?: string | any[]
+
   /** 状态变化事件，detail = {code}
    * @supported weapp, qq
    */
@@ -211,11 +216,6 @@ interface LivePusherProps extends StandardProps {
    */
   onAudioVolumeNotify?: CommonEventFunction
 
-  /** 设置小窗模式： push, pop，空字符串或通过数组形式设置多种模式（如： ["push", "pop"]）
-   * @supported weapp
-   */
-  pictureInPictureMode?: string | any[]
-
   /** 网络状态通知，detail = {info}
    * @supported weapp, qq
    */

package/types/Map.d.ts

@@ -155,54 +155,10 @@ interface MapProps extends StandardProps {
         [key: string]: number | string | any
       }
 
-  /** 点击地图时触发
-   * @supported weapp, alipay, swan, tt, qq, jd
-   */
-  onTap?: CommonEventFunction
-
-  /** 点击标记点时触发，e.detail = {markerId}
-   * @supported weapp, alipay, swan, tt, qq, jd
-   */
-  onMarkerTap?: CommonEventFunction<MapProps.onMarkerTapEventDetail>
-
-  /** 点击label时触发，e.detail = {markerId}
-   * @supported weapp, tt
-   */
-  onLabelTap?: CommonEventFunction<MapProps.onLabelTapEventDetail>
-
-  /** 点击控件时触发，e.detail = {controlId}
-   * @supported weapp, alipay, swan, jd
-   */
-  onControlTap?: CommonEventFunction<MapProps.onControlTapEventDetail>
-
-  /** 点击标记点对应的气泡时触发，e.detail = {markerId}
-   * @supported alipay
-   */
-  onCalloutTap?: CommonEventFunction<MapProps.onCalloutTapEventDetail>
-
-  /** 在地图渲染更新完成时触发
-   * @supported weapp, swan, tt, qq
-   */
-  onUpdated?: CommonEventFunction
-
-  /** 视野发生变化时触发
-   * @supported weapp, alipay, swan, tt, qq, jd
-   */
-  onRegionChange?: CommonEventFunction<
-    MapProps.onRegionEventDetail<'begin'> | MapProps.onRegionEventDetail<'end'>
-  >
-
-  /** 点击地图poi点时触发，e.detail = {name, longitude, latitude}
-   * @supported weapp, swan, qq
-   */
-  onPoiTap?: CommonEventFunction<MapProps.onPoiTapEventDetail>
-
   /** 视野在地图 padding 范围内展示
    * @supported alipay
    */
-  includePadding?: {
-    [key in 'left' | 'right' | 'top' | 'bottom']: number | string
-  }
+  includePadding?: { [key in 'left' | 'right' | 'top' | 'bottom']: number | string }
 
   /** 覆盖物，自定义贴图
    * @supported alipay
@@ -224,29 +180,7 @@ interface MapProps extends StandardProps {
    */
   enableBuilding?: string
 
-  /** 点击标记点对应的气泡时触发e.detail = {markerId}
-   * @supported weapp, swan, tt, jd
-   */
-  onCallOutTap?: CommonEventFunction
-
-  /** 点击定位标时触发，e.detail = {longitude, latitude}
-   * @supported weapp, tt
-   */
-  onAnchorPointTap?: CommonEventFunction
-
-  /** 内联样式。
-   * @supported alipay
-   */
-  style?: string
-
-  /** 样式名。
-   * @supported alipay
-   */
-  class?: string
-
   /** 覆盖物，多边形。
-   *
-   * 版本要求：基础库 1.10.0 及以上
    * @supported alipay
    */
   polygon?: string
@@ -255,41 +189,15 @@ interface MapProps extends StandardProps {
    *
    * default：默认样式
    * light：精简样式
-   *
-   * 版本要求：基础库 1.20.0 及以上
    * @supported alipay
    */
   customMapStyle?: string
 
   /** 基于 map 高级定制渲染，设置覆盖在地图上的 view。
-   *
-   * 版本要求：基础库 1.23.0 及以上
    * @supported alipay
    */
   panels?: string
 
-  /** 点击 panel 时触发。
-   *
-   * {
-   *
-   *    panelId,
-   *
-   *    layoutId,
-   *
-   * }
-   *
-   * 版本要求：基础库 1.23.0 及以上
-   * @supported alipay
-   */
-  onPanelTap?: CommonEventFunction
-
-  /** 地图初始化完成即将开始渲染第一帧时触发。
-   *
-   * 版本要求：基础库 2.7.2 及以上
-   * @supported alipay
-   */
-  onInitComplete?: CommonEventFunction
-
   /** 否
    * @supported jd
    */
@@ -305,6 +213,69 @@ interface MapProps extends StandardProps {
    * @default false
    */
   enable3D?: string
+
+  /** 点击地图时触发
+   * @supported weapp, alipay, swan, tt, qq, jd
+   */
+  onTap?: CommonEventFunction
+
+  /** 点击标记点时触发，e.detail = {markerId}
+   * @supported weapp, alipay, swan, tt, qq, jd
+   */
+  onMarkerTap?: CommonEventFunction<MapProps.onMarkerTapEventDetail>
+
+  /** 点击label时触发，e.detail = {markerId}
+   * @supported weapp, tt
+   */
+  onLabelTap?: CommonEventFunction<MapProps.onLabelTapEventDetail>
+
+  /** 点击控件时触发，e.detail = {controlId}
+   * @supported weapp, alipay, swan, jd
+   */
+  onControlTap?: CommonEventFunction<MapProps.onControlTapEventDetail>
+
+  /** 点击标记点对应的气泡时触发，e.detail = {markerId}
+   * @supported alipay
+   */
+  onCalloutTap?: CommonEventFunction<MapProps.onCalloutTapEventDetail>
+
+  /** 在地图渲染更新完成时触发
+   * @supported weapp, swan, tt, qq
+   */
+  onUpdated?: CommonEventFunction
+
+  /** 视野发生变化时触发
+   * @supported weapp, alipay, swan, tt, qq, jd
+   */
+  onRegionChange?: CommonEventFunction<MapProps.onRegionEventDetail<'begin'> | MapProps.onRegionEventDetail<'end'>>
+
+  /** 点击地图poi点时触发，e.detail = {name, longitude, latitude}
+   * @supported weapp, swan, qq
+   */
+  onPoiTap?: CommonEventFunction<MapProps.onPoiTapEventDetail>
+
+  /** 点击标记点对应的气泡时触发e.detail = {markerId}
+   * @supported weapp, swan, tt, jd
+   */
+  onCallOutTap?: CommonEventFunction
+
+  /** 点击定位标时触发，e.detail = {longitude, latitude}
+   * @supported weapp, tt
+   */
+  onAnchorPointTap?: CommonEventFunction
+
+  /** 点击 panel 时触发。
+   * @supported alipay
+   */
+  onPanelTap?: CommonEventFunction<{
+    panelId
+    layoutId
+  }>
+
+  /** 地图初始化完成即将开始渲染第一帧时触发。
+   * @supported alipay
+   */
+  onInitComplete?: CommonEventFunction
 }
 declare namespace MapProps {
   /** 标记点用于在地图上显示标记的位置 */
@@ -661,9 +632,7 @@ declare namespace MapProps {
     /** 导致视野变化的原因
      * @remarks 有效值为 gesture（手势触发）、update（接口触发或调用更新接口导致）、drag（拖动导致）、scale（缩放导致）
      */
-    causedBy: keyof (T extends 'begin'
-      ? RegionChangeDetail.CausedByBegin
-      : RegionChangeDetail.CausedByEnd)
+    causedBy: keyof (T extends 'begin' ? RegionChangeDetail.CausedByBegin : RegionChangeDetail.CausedByEnd)
 
     /** 视野改变详情 */
     detail: regionChangeDetail<RegionChangeDetail.type>
@@ -674,9 +643,7 @@ declare namespace MapProps {
 
     /** 倾斜角度 */
     skew: number
-    causedBy: keyof (T extends 'begin'
-      ? RegionChangeDetail.CausedByBegin
-      : RegionChangeDetail.CausedByEnd)
+    causedBy: keyof (T extends 'begin' ? RegionChangeDetail.CausedByBegin : RegionChangeDetail.CausedByEnd)
     type: T | string
     scale: number
     centerLocation: point

package/types/MovableView.d.ts

@@ -1,9 +1,5 @@
 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
@@ -86,10 +82,10 @@ interface MovableViewProps extends Omit<StandardProps, 'animation'> {
    */
   onChange?: CommonEventFunction<MovableViewProps.onChangeEventDetail>
 
-  /** 缩放过程中触发的事件
-   * @supported weapp, alipay, swan, tt, qq
+  /** 拖动结束触发的事件
+   * @supported alipay
    */
-  onScale?: CommonEventFunction<MovableViewProps.onScaleEventDetail>
+  onChangeEnd?: CommonEventFunction<MovableViewProps.onChangeEventDetail>
 
   /** 开始拖动时触发
    * @supported rn
@@ -101,64 +97,56 @@ interface MovableViewProps extends Omit<StandardProps, 'animation'> {
    */
   onDragEnd?: CommonEventFunction
 
-  /** 初次手指触摸后移动为横向的移动时触发，如果 catch 此事件，则意味着 touchmove 事件也被catch
-   * @supported weapp, tt
+  /** 缩放过程中触发的事件
+   * @supported weapp, alipay, swan, tt, qq
    */
-  catchTouchmove?: CommonEventFunction
+  onScale?: CommonEventFunction<MovableViewProps.onScaleEventDetail>
 
   /** 触摸动作开始，事件会向父节点传递。
-   * 版本要求： 基础库 1.11.5 及以上
    * @supported alipay
    */
   onTouchStart?: CommonEventFunction
 
   /** 触摸动作开始，事件仅作用于组件，不向父节点传递。
-   * 版本要求： 基础库 1.11.5 及以上
    * @supported alipay
    */
-  catchTouchStart?: CommonEventFunction
+  onTouchMove?: CommonEventFunction
 
-  /** 触摸移动事件，事件会向父节点传递。
-   * 版本要求： 基础库 1.11.5 及以上
+  /** 手指触摸动作结束
+   * @supported alipay, h5
+   * @h5 此事件的触发顺序会因为当前事件机制引起组件内外注册的事件执行顺序不正常，外部注册的事件可能会优先于内部执行，如需保证执行顺序一致，需要在回调函数中包裹 setTimeout 临时处理
+   */
+  onTouchEnd?: TouchEventFunction
+
+  /** 触摸动作被打断，如来电提醒、弹窗。
    * @supported alipay
    */
-  onTouchMove?: CommonEventFunction
+  onTouchCancel?: CommonEventFunction
 
   /** 初次手指触摸后移动为横向的移动，如果 catch 此事件，则意味着 touchmove 事件也被 catch
-   * @supported swan
+   * @supported weapp, swan, tt
    */
   onHTouchMove?: TouchEventFunction
 
   /** 初次手指触摸后移动为纵向的移动，如果 catch 此事件，则意味着 touchmove 事件也被 catch
-   * @supported swan
+   * @supported weapp, swan, tt
    */
   onVTouchMove?: TouchEventFunction
 
   /** 触摸移动事件，事件仅作用于组件，不向父节点传递。
-   * 版本要求： 基础库 1.11.5 及以上
    * @supported alipay
    */
-  catchTouchMove?: CommonEventFunction
+  catchTouchStart?: CommonEventFunction
 
-  /** 触摸动作结束，事件会向父节点传递。
+  /** 触摸移动事件，事件仅作用于组件，不向父节点传递。
    * @supported alipay
    */
-  onTouchEnd?: CommonEventFunction
+  catchTouchMove?: CommonEventFunction
 
   /** 触摸动作结束，事件仅作用于组件，不向父节点传递。
    * @supported alipay
    */
   catchTouchEnd?: CommonEventFunction
-
-  /** 触摸动作被打断，如来电提醒、弹窗。
-   * @supported alipay
-   */
-  onTouchCancel?: CommonEventFunction
-
-  /** 拖动结束触发的事件
-   * @supported alipay
-   */
-  onChangeEnd?: CommonEventFunction<MovableViewProps.onChangeEventDetail>
 }
 declare namespace MovableViewProps {
   /** 拖动过程中触发的事件 */

package/types/NavigationBar.d.ts

@@ -37,7 +37,7 @@ interface NavigationBarProps extends StandardProps {
 /** 页面导航条配置节点，用于指定导航栏的一些属性。只能是 PageMeta 组件内的第一个节点，需要配合它一同使用。
  * 通过这个节点可以获得类似于调用 Taro.setNavigationBarTitle Taro.setNavigationBarColor 等接口调用的效果。
  * @supported weapp
- * @see https://developers.weixin.qq.com/miniprogram/dev/component/open-data.html
+ * @see https://developers.weixin.qq.com/miniprogram/dev/component/navigation-bar.html
  */
 declare const NavigationBar: ComponentType<NavigationBarProps>
 export { NavigationBar, NavigationBarProps }

package/types/Navigator.d.ts

@@ -67,6 +67,16 @@ interface NavigatorProps extends StandardProps {
    */
   hoverStayTime?: number
 
+  /** 当target="miniProgram"时有效，当传递该参数后，可以不传 app-id 和 path。链接可以通过【小程序菜单】->【复制链接】获取。
+   * @supported weapp
+   */
+  shortLink?: string
+
+  /** 无障碍访问，（属性）元素的额外描述
+   * @supported qq
+   */
+  ariaLabel?: string
+
   /** 当 `target="miniProgram"` 时有效，跳转小程序成功
    * @supported weapp, swan, qq
    */
@@ -81,16 +91,6 @@ interface NavigatorProps extends StandardProps {
    * @supported weapp, swan, qq
    */
   onComplete?: CommonEventFunction
-
-  /** 当target="miniProgram"时有效，当传递该参数后，可以不传 app-id 和 path。链接可以通过【小程序菜单】->【复制链接】获取。
-   * @supported weapp
-   */
-  shortLink?: string
-
-  /** 无障碍访问，（属性）元素的额外描述
-   * @supported qq
-   */
-  ariaLabel?: string
 }
 declare namespace NavigatorProps {
   /** target 的合法值 */

package/types/OpenData.d.ts

@@ -27,11 +27,6 @@ interface OpenDataProps extends StandardProps {
    */
   defaultAvatar?: string
 
-  /** 群名称或用户信息为空时触发
-   * @supported weapp, tt, qq
-   */
-  onError?: CommonEventFunction
-
   /** 当数据为空且未设置默认值时，是否显示官方默认值
    * @supported tt
    */
@@ -51,6 +46,11 @@ interface OpenDataProps extends StandardProps {
    * @supported qq
    */
   componentData?: string
+
+  /** 群名称或用户信息为空时触发
+   * @supported weapp, tt, qq
+   */
+  onError?: CommonEventFunction
 }
 declare namespace OpenDataProps {
   /** type 的合法值 */

package/types/PageContainer.d.ts

@@ -1,8 +1,5 @@
 import { ComponentType } from 'react'
-import {
-  StandardProps,
-  CommonEventFunction,
-} from './common'
+import { StandardProps, CommonEventFunction } from './common'
 interface PageContainerProps extends StandardProps {
   /** 是否显示容器组件
    * @default false
@@ -50,6 +47,12 @@ interface PageContainerProps extends StandardProps {
    */
   customStyle?: string
 
+  /** 是否在下滑一段距离后关闭
+   * @supported weapp
+   * @default false
+   */
+  closeOnSlideDown?: string
+
   /** 进入前触发
    * @supported weapp, rn
    */
@@ -84,12 +87,6 @@ interface PageContainerProps extends StandardProps {
    * @supported weapp
    */
   onClickOverlay?: CommonEventFunction
-
-  /** 是否在下滑一段距离后关闭
-   * @supported weapp
-   * @default false
-   */
-  closeOnSlideDown?: string
 }
 declare namespace PageContainerProps {
   /** 弹出位置 */

package/types/PageMeta.d.ts

@@ -45,35 +45,35 @@ interface PageMetaProps extends StandardProps {
    */
   rootFontSize?: string
 
-  /** 页面尺寸变化时会触发 resize 事件
-   * @supported weapp
+  /** 页面内容的背景色，用于页面中的空白部分和页面大小变化 resize 动画期间的临时空闲区域
+   * @supported weapp, alipay
    */
-  onResize?: CommonEventFunction<PageMetaProps.onResizeEventDetail>
+  rootBackgroundColor?: string
 
-  /** 页面滚动时会触发 scroll 事件
+  /** 页面 page 的字体大小，可以设置为 system ，表示使用当前用户设置的微信字体大小
    * @supported weapp, alipay
    */
-  onScroll?: CommonEventFunction<PageMetaProps.onScrollEventDetail>
+  pageFontSize?: string
 
-  /** 如果通过改变 scroll-top 属性来使页面滚动，页面滚动结束后会触发 scrolldone 事件
+  /** 页面的方向，可为 auto portrait 或 landscape
    * @supported weapp
    */
-  onScrollDone?: CommonEventFunction
+  pageOrientation?: string
 
-  /** 页面内容的背景色，用于页面中的空白部分和页面大小变化 resize 动画期间的临时空闲区域
-   * @supported weapp, alipay
+  /** 页面尺寸变化时会触发 resize 事件
+   * @supported weapp
    */
-  rootBackgroundColor?: string
+  onResize?: CommonEventFunction<PageMetaProps.onResizeEventDetail>
 
-  /** 页面 page 的字体大小，可以设置为 system ，表示使用当前用户设置的微信字体大小
+  /** 页面滚动时会触发 scroll 事件
    * @supported weapp, alipay
    */
-  pageFontSize?: string
+  onScroll?: CommonEventFunction<PageMetaProps.onScrollEventDetail>
 
-  /** 页面的方向，可为 auto portrait 或 landscape
+  /** 如果通过改变 scroll-top 属性来使页面滚动，页面滚动结束后会触发 scrolldone 事件
    * @supported weapp
    */
-  pageOrientation?: string
+  onScrollDone?: CommonEventFunction
 }
 declare namespace PageMetaProps {
   interface onResizeEventDetail {

package/types/Picker.d.ts

@@ -436,11 +436,7 @@ declare namespace PickerRegionProps {
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/picker.html
  */
 declare const Picker: ComponentType<
-  | PickerMultiSelectorProps
-  | PickerTimeProps
-  | PickerDateProps
-  | PickerRegionProps
-  | PickerSelectorProps
+  PickerMultiSelectorProps | PickerTimeProps | PickerDateProps | PickerRegionProps | PickerSelectorProps
 >
 export {
   Picker,

package/types/PickerView.d.ts

@@ -32,21 +32,6 @@ interface PickerViewProps extends StandardProps {
    */
   immediateChange?: boolean
 
-  /** 当滚动选择，value 改变时触发 change 事件，event.detail = {value: value}；value为数组，表示 picker-view 内的 picker-view-column 当前选择的是第几项（下标从 0 开始）
-   * @supported weapp, alipay, swan, tt, qq, jd, rn
-   */
-  onChange?: CommonEventFunction<PickerViewProps.onChangeEventDetail>
-
-  /** 当滚动选择开始时候触发事件
-   * @supported weapp, tt, qq
-   */
-  onPickStart?: CommonEventFunction
-
-  /** 当滚动选择结束时候触发事件
-   * @supported weapp, tt, qq
-   */
-  onPickEnd?: CommonEventFunction
-
   /** 选择器标题，建议标题控制在 12 个中文汉字长度内，避免出现截断现象, 截断部分将以 ... 形式展示
    * @supported swan
    */
@@ -57,17 +42,20 @@ interface PickerViewProps extends StandardProps {
    */
   ariaLabel?: string
 
-  /** 当滚动选择开始时候触发事件。
-   * 版本要求： 基础库 2.7.23 及以上
-   * @supported alipay
+  /** 当滚动选择，value 改变时触发 change 事件，event.detail = {value: value}；value为数组，表示 picker-view 内的 picker-view-column 当前选择的是第几项（下标从 0 开始）
+   * @supported weapp, alipay, swan, tt, qq, jd, rn
    */
-  onPickerStart?: CommonEventFunction
+  onChange?: CommonEventFunction<PickerViewProps.onChangeEventDetail>
 
-  /** 当滚动选择结束时候触发事件。
-   * 版本要求： 基础库 2.7.23 及以上
-   * @supported alipay
+  /** 当滚动选择开始时候触发事件
+   * @supported weapp, alipay, tt, qq
    */
-  onPickerEnd?: CommonEventFunction
+  onPickStart?: CommonEventFunction
+
+  /** 当滚动选择结束时候触发事件
+   * @supported weapp, alipay, tt, qq
+   */
+  onPickEnd?: CommonEventFunction
 }
 declare namespace PickerViewProps {
   interface onChangeEventDetail {

package/types/Progress.d.ts

@@ -68,15 +68,15 @@ interface ProgressProps extends StandardProps {
    */
   duration?: number
 
-  /** 动画完成事件
-   * @supported weapp, qq, jd, h5
-   */
-  onActiveEnd?: CommonEventFunction
-
   /** 无障碍访问，（属性）元素的额外描述
    * @supported qq
    */
   ariaLabel?: string
+
+  /** 动画完成事件
+   * @supported weapp, qq, jd, h5
+   */
+  onActiveEnd?: CommonEventFunction
 }
 
 /** 进度条。组件属性的长度单位默认为 px