@tarojs/components 3.5.6-alpha.2 → 3.5.7-alpha.0

package/types/Input.d.ts

@@ -30,7 +30,7 @@ interface InputProps extends StandardProps, FormItemProps {
 
   /** 指定 placeholder 的样式类
    * @default "input-placeholder"
-   * @supported weapp, alipay, swan, tt, qq, jd
+   * @supported weapp, alipay, swan, qq, jd
    */
   placeholderClass?: string
 
@@ -75,7 +75,7 @@ interface InputProps extends StandardProps, FormItemProps {
 
   /** 点击键盘右下角按钮时是否保持键盘不收起
    * @default false
-   * @supported weapp, alipay, swan, tt, qq, jd
+   * @supported weapp, alipay, swan, qq, jd
    */
   confirmHold?: boolean
 
@@ -104,7 +104,7 @@ interface InputProps extends StandardProps, FormItemProps {
 
   /** focus 时，点击页面的时候不收起键盘
    * @default false
-   * @supported weapp, tt
+   * @supported weapp
    */
   holdKeyboard?: boolean
 
@@ -202,7 +202,6 @@ interface InputProps extends StandardProps, FormItemProps {
   name?: string
 
   /** 是否强制使用系统键盘和 Web-view 创建的 input 元素。为 true 时，confirm-type、confirm-hold 可能失效。
-   * 版本要求：基础库 2.7.3 及以上
    * @supported alipay
    */
   alwaysSystem?: string

package/types/LivePlayer.d.ts

@@ -136,6 +136,12 @@ interface LivePlayerProps extends StandardProps {
    * @supported swan
    */
   id?: string
+
+  /** 是否开启手机横屏时自动全屏，当系统设置开启自动旋转时生效
+   * @supported weapp
+   * @default false
+   */
+  enableAutoRotation?: string
 }
 declare namespace LivePlayerProps {
   /** mode 的合法值 */

package/types/Map.d.ts

@@ -188,9 +188,7 @@ interface MapProps extends StandardProps {
   /** 视野发生变化时触发
    * @supported weapp, alipay, swan, tt, qq, jd
    */
-  onRegionChange?: CommonEventFunction<
-    MapProps.onRegionEventDetail<'begin'> | MapProps.onRegionEventDetail<'end'>
-  >
+  onRegionChange?: CommonEventFunction<MapProps.onRegionEventDetail<'begin'> | MapProps.onRegionEventDetail<'end'>>
 
   /** 点击地图poi点时触发，e.detail = {name, longitude, latitude}
    * @supported weapp, swan, qq
@@ -200,9 +198,7 @@ interface MapProps extends StandardProps {
   /** 视野在地图 padding 范围内展示
    * @supported alipay
    */
-  includePadding?: {
-    [key in 'left' | 'right' | 'top' | 'bottom']: number | string
-  }
+  includePadding?: { [key in 'left' | 'right' | 'top' | 'bottom']: number | string }
 
   /** 覆盖物，自定义贴图
    * @supported alipay
@@ -234,19 +230,7 @@ interface MapProps extends StandardProps {
    */
   onAnchorPointTap?: CommonEventFunction
 
-  /** 内联样式。
-   * @supported alipay
-   */
-  style?: string
-
-  /** 样式名。
-   * @supported alipay
-   */
-  class?: string
-
   /** 覆盖物，多边形。
-   *
-   * 版本要求：基础库 1.10.0 及以上
    * @supported alipay
    */
   polygon?: string
@@ -255,37 +239,24 @@ 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
+  onPanelTap?: CommonEventFunction<{
+    panelId
+    layoutId
+  }>
 
   /** 地图初始化完成即将开始渲染第一帧时触发。
-   *
-   * 版本要求：基础库 2.7.2 及以上
    * @supported alipay
    */
   onInitComplete?: CommonEventFunction
@@ -295,16 +266,16 @@ interface MapProps extends StandardProps {
    */
   theme?: string
 
-  /** 内联样式。
-   * @supported alipay
-   */
-  optimize?: string
-
   /** 展示3D楼块
    * @supported weapp, swan, tt, qq
    * @default false
    */
   enable3D?: string
+
+  /** 内联样式。
+   * @supported alipay
+   */
+  optimize?: string
 }
 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/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

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

@@ -38,12 +38,12 @@ interface PickerViewProps extends StandardProps {
   onChange?: CommonEventFunction<PickerViewProps.onChangeEventDetail>
 
   /** 当滚动选择开始时候触发事件
-   * @supported weapp, tt, qq
+   * @supported weapp, alipay, tt, qq
    */
   onPickStart?: CommonEventFunction
 
   /** 当滚动选择结束时候触发事件
-   * @supported weapp, tt, qq
+   * @supported weapp, alipay, tt, qq
    */
   onPickEnd?: CommonEventFunction
 
@@ -56,18 +56,6 @@ interface PickerViewProps extends StandardProps {
    * @supported qq
    */
   ariaLabel?: string
-
-  /** 当滚动选择开始时候触发事件。
-   * 版本要求： 基础库 2.7.23 及以上
-   * @supported alipay
-   */
-  onPickerStart?: CommonEventFunction
-
-  /** 当滚动选择结束时候触发事件。
-   * 版本要求： 基础库 2.7.23 及以上
-   * @supported alipay
-   */
-  onPickerEnd?: CommonEventFunction
 }
 declare namespace PickerViewProps {
   interface onChangeEventDetail {

package/types/ScrollView.d.ts

@@ -164,73 +164,55 @@ interface ScrollViewProps extends StandardProps {
   /** 滑动开始事件 (同时开启 enhanced 属性后生效)
    * @supported weapp
    */
-  onDragStart?: CommonEventFunction
+  onDragStart?: CommonEventFunction<ScrollViewProps.onDragDetail>
 
   /** 滑动事件 (同时开启 enhanced 属性后生效)
    * @supported weapp
    */
-  onDragging?: CommonEventFunction
+  onDragging?: CommonEventFunction<ScrollViewProps.onDragDetail>
 
-  /** 滑动结束事件 (同时开启 enhanced 属性后生效) detail { scrollTop, scrollLeft, velocity }
+  /** 滑动结束事件 (同时开启 enhanced 属性后生效)
    * @supported weapp
    */
-  onDragend?: CommonEventFunction
-
-  /** 外部样式名。
-   * @supported alipay
-   */
-  class?: string
-
-  /** 内联样式名。
-   * @supported alipay
-   */
-  style?: string
+  onDragEnd?: CommonEventFunction<ScrollViewProps.onDragDetail>
 
   /** 当 scroll-with-animation设置为 true 时，可以设置 scroll-animation-duration 来控制动画的执行时间，单位 ms。
-   * 版本要求： 基础库 1.9.0 及以上
    * @supported alipay
    */
   scrollAnimationDuration?: string
 
   /** 纵向滚动时，当滚动到顶部或底部时，强制禁止触发页面滚动，仍然只触发 scroll-view 自身的滚动。
-   * 默认值： false
-   * 版本要求： 基础库 1.11.2 及以上
    * @supported alipay
+   * @default false
    */
   trapScroll?: string
 
   /** 触摸动作开始。
-   * 版本要求： 基础库 1.15.0 及以上
    * @supported alipay
    */
   onTouchStart?: CommonEventFunction
 
   /** 触摸后移动。
-   * 版本要求： 基础库 1.15.0 及以上
    * @supported alipay
    */
   onTouchMove?: CommonEventFunction
 
   /** 触摸动作结束。
-   * 版本要求： 基础库 1.15.0 及以上
    * @supported alipay
    */
   onTouchEnd?: CommonEventFunction
 
   /** 触摸动作被打断，如来电提醒、弹窗。
-   * 版本要求： 基础库 1.15.0 及以上
    * @supported alipay
    */
   onTouchCancel?: CommonEventFunction
 
   /** 发生滚动前，对滚动方向进行判断，当方向是顶部/左边时，如果值为 always 将始终禁止滚动，如果值为 out-of-bounds 且当前已经滚动到顶部/左边，禁止滚动。
-   * 版本要求：基础库 2.6.2 及以上
    * @supported alipay
    */
   disableLowerScroll?: string
 
   /** 发生滚动前，对滚动方向进行判断，当方向是底部/右边时，如果值为 always 将始终禁止滚动，如果值为 out-of-bounds 且当前已经滚动到底部/右边，禁止滚动。
-   * 版本要求：基础库 2.6.2 及以上
    * @supported alipay
    */
   disableUpperScroll?: string
@@ -239,6 +221,12 @@ interface ScrollViewProps extends StandardProps {
    * @supported qq
    */
   ariaLabel?: string
+
+  /** 开启 passive 特性，能优化一定的滚动性能
+   * @supported weapp
+   * @default false
+   */
+  enablePassive?: string
 }
 declare namespace ScrollViewProps {
   interface onScrollDetail {
@@ -256,6 +244,17 @@ declare namespace ScrollViewProps {
     deltaX: number
     deltaY: number
   }
+
+  interface onDragDetail {
+    /** 横向滚动条位置 */
+    scrollLeft: number
+
+    /** 竖向滚动条位置 */
+    scrollTop: number
+
+    /** 滚动速度 */
+    velocity: number
+  }
 }
 
 /** 可滚动视图区域。使用竖向滚动时，需要给scroll-view一个固定高度，通过 WXSS 设置 height。组件属性的长度单位默认为 px

package/types/Swiper.d.ts

@@ -119,26 +119,22 @@ interface SwiperProps extends StandardProps {
   disableTouch?: boolean
 
   /** swiper-item 可见时的 class。
-   * 版本要求： 基础库 1.13.7 以及上。
    * @supported alipay
    */
   activeClass?: string
 
   /** acceleration 设置为 {{true}} 时且处于滑动过程中，中间若干屏处于可见时的 class。
-   * 版本要求： 基础库 1.13.7 以及上。
    * @supported alipay
    */
   changingClass?: string
 
   /** 当开启时，会根据滑动速度，连续滑动多屏。
-   * 版本要求： 基础库 1.13.7 及以上
    * @default false
    * @supported alipay
    */
   acceleration?: string
 
   /** 是否禁用代码变动触发 swiper 切换时使用动画。
-   * 版本要求： 基础库 1.13.7 及以上
    * @default false
    * @supported alipay
    */
@@ -150,31 +146,26 @@ interface SwiperProps extends StandardProps {
   onAnimationEnd?: CommonEventFunction<SwiperProps.onCommonEventDetail>
 
   /** 滑动距离阈值，当滑动距离超过阈值时进行 swiper-item 切换。
-   * 版本要求：基础库 1.24.11 及以上
    * @supported alipay
    */
   swipeRatio?: string
 
   /** 滑动综合速度阈值，当超过阈值时进行 swiper-item 切换，数值越小越敏感。
-   * 版本要求：基础库 1.24.11 及以上
    * @supported alipay
    */
   swipeSpeed?: string
 
   /** 计算用户手势时所依赖的滑动角度。角度根据 touchstart 事件和首次 touchmove 事件的坐标计算得出。数值越小越对用户的滑动方向准确度要求越高。
-   * 版本要求：基础库 1.24.11 及以上
    * @supported alipay
    */
   touchAngle?: string
 
   /** 自动以指定滑块的高度为整个容器的高度。当 vertical 为 true 时，默认不调整。可选值为：
-   * 版本要求：基础库 2.6.4 及以上
    * @supported alipay
    */
   adjustHeight?: 'first' | 'current' | 'highest' | 'none'
 
   /** vertical 为 true 时强制使 adjust-height 生效。
-   * 版本要求：基础库 2.6.4 及以上
    * @supported alipay
    */
   adjustVerticalHeight?: string

package/types/Switch.d.ts

@@ -41,7 +41,6 @@ interface SwitchProps extends StandardProps, FormItemProps {
   name?: string
 
   /** 是否为受控组件，为 true 时，checked 会完全受 setData 控制。
-   * 版本要求： 基础库 1.8.0 及以上
    * @default false
    * @supported alipay
    */

package/types/Textarea.d.ts

@@ -159,13 +159,11 @@ interface TextareaProps extends StandardProps, FormItemProps {
   name?: string
 
   /** 是否渲染字数统计功能（是否删除默认计数器/是否显示字数统计）。
-   * 版本要求： 基础库 1.8.0 及以上
    * @supported alipay
    */
   showCount?: string
 
   /** 是否为受控组件。为 true 时，value 内容会完全受 setData 控制。
-   * 版本要求： 基础库 1.8.0 及以上
    * @supported alipay
    */
   controlled?: string

package/types/Video.d.ts

@@ -336,23 +336,12 @@ interface VideoProps extends StandardProps {
    */
   onControlsToggle?: CommonEventFunction<VideoProps.onControlsToggleEventDetail>
 
-  /** 内联样式。
-   * @supported alipay
-   */
-  style?: string
-
-  /** 外部样式名。
-   * @supported alipay
-   */
-  class?: string
-
   /** 当 poster 高宽比跟视频高宽不匹配时，如何显示 poster，设置规则同 background-size 一致。
    * @supported alipay
    */
   posterSize?: string
 
   /** 当底部工具条隐藏时，是否显示细进度条（controls=false 时设置无效）。
-   * 版本要求： 基础库 1.15.0 及以上
    * @supported alipay
    */
   showThinProgressBar?: string
@@ -364,7 +353,6 @@ interface VideoProps extends StandardProps {
    * 2 - 阻塞提醒(无消耗流量大小)
    * 3 - 阻塞提醒(有消耗流量大小提醒)
    *
-   * 版本要求： 基础库 1.13.0 及以上
    * @supported alipay, jd
    */
   mobilenetHintType?: string
@@ -385,13 +373,11 @@ interface VideoProps extends StandardProps {
   onUserAction?: CommonEventFunction<VideoProps.onUserActionEventDetail>
 
   /** 视频播放终止。
-   * 版本要求： 基础库 1.9.0 及以上
    * @supported alipay
    */
   onStop?: CommonEventFunction
 
   /** 当视频加载完真正开始播放时触发。
-   * 版本要求： 基础库 1.13.6 及以上
    * @supported alipay
    */
   onRenderStart?: CommonEventFunction
@@ -401,7 +387,6 @@ interface VideoProps extends StandardProps {
    *
    * none：无浮窗。
    * page：页面内浮窗。
-   * 版本要求：基础库 1.24.6 及以上
    * @supported alipay
    */
   floatingMode?: string
@@ -479,17 +464,23 @@ interface VideoProps extends StandardProps {
   /** 视频倍速改变完成时触发。返回改变后的倍速值
    * @supported tt
    */
-  onPlayBackRateChange?: CommonEventFunction<{ playbackRate: string }>
+  onPlayBackRateChange?: CommonEventFunction<{
+    playbackRate: string
+  }>
 
   /** 静音状态改变完成时触发。返回当前是否静音
    * @supported tt
    */
-  onMuteChange?: CommonEventFunction<{ isMuted: boolean }>
+  onMuteChange?: CommonEventFunction<{
+    isMuted: boolean
+  }>
 
   /** 点击控件时触发。返回当前点击的控件类型
    * @supported tt
    */
-  onControlTap?: CommonEventFunction<{ controlType }>
+  onControlTap?: CommonEventFunction<{
+    controlType
+  }>
 
   /** 进入小窗播放时触发
    * @supported tt
@@ -622,14 +613,19 @@ declare namespace VideoProps {
   interface UserActionTag {
     /** 底部播放按钮 */
     play
+
     /** 中心播放按钮 */
     centerplay
+
     /** 静音按钮 */
     mute
+
     /** 全屏按钮 */
     fullscreen
+
     /** 重试按钮 */
     retry
+
     /** 网络提醒的播放按钮 */
     mobilenetplay
   }