@tarojs/components 3.5.7 → 3.5.8

package/types/Input.d.ts

@@ -58,11 +58,13 @@ interface InputProps extends StandardProps, FormItemProps {
 
   /** (即将废弃，请直接使用 focus )自动聚焦，拉起键盘
    * @default false
-   * @supported weapp, qq, jd
+   * @deprecated
+   * @supported weapp, qq, jd, h5
    */
   autoFocus?: boolean
 
   /** 获取焦点
+   * @default false
    * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
    */
   focus?: boolean
@@ -165,6 +167,26 @@ interface InputProps extends StandardProps, FormItemProps {
    */
   controlled?: boolean
 
+  /** 用于透传 `WebComponents` 上的属性到内部 H5 标签上
+   * @supported h5
+   */
+  nativeProps?: Record<string, unknown>
+
+  /** 组件名字，用于表单提交获取数据。
+   * @supported alipay
+   */
+  name?: string
+
+  /** 是否强制使用系统键盘和 Web-view 创建的 input 元素。为 true 时，confirm-type、confirm-hold 可能失效。
+   * @supported alipay
+   */
+  alwaysSystem?: string
+
+  /** 无障碍访问，（属性）元素的额外描述
+   * @supported qq
+   */
+  ariaLabel?: string
+
   /** 当键盘输入时，触发input事件，event.detail = {value, cursor, keyCode}，处理函数可以直接 return 一个字符串，将替换输入框的内容。
    * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
    */
@@ -190,26 +212,6 @@ interface InputProps extends StandardProps, FormItemProps {
    * @supported weapp, qq
    */
   onKeyboardHeightChange?: CommonEventFunction<InputProps.onKeyboardHeightChangeEventDetail>
-
-  /** 用于透传 `WebComponents` 上的属性到内部 H5 标签上
-   * @supported h5
-   */
-  nativeProps?: Record<string, unknown>
-
-  /** 组件名字，用于表单提交获取数据。
-   * @supported alipay
-   */
-  name?: string
-
-  /** 是否强制使用系统键盘和 Web-view 创建的 input 元素。为 true 时，confirm-type、confirm-hold 可能失效。
-   * @supported alipay
-   */
-  alwaysSystem?: string
-
-  /** 无障碍访问，（属性）元素的额外描述
-   * @supported qq
-   */
-  ariaLabel?: string
 }
 declare namespace InputProps {
   /** > 注意：React-Native 端 `inputEventDetail` 仅实现参数 `value`，若需实时获取光标位置则可通过 [`onSelectionChange`](https://reactnative.dev/docs/textinput#onselectionchange) 实现。 */

package/types/Lifestyle.d.ts

@@ -0,0 +1,26 @@
+import { ComponentType } from 'react'
+import { StandardProps } from './common'
+interface LifestyleProps extends StandardProps {
+  /** 必填，生活号 ID（即生活号 APPID），必须是当前小程序同账号主体且已关联的生活号。
+   * @supported alipay
+   */
+  publicId?: string
+
+  /** 文案。支持商家自定义，最多展示一行。
+   * @supported alipay
+   */
+  memo?: string
+
+  /** 当用户关注生活号成功后执行。
+   * @supported alipay
+   */
+  onFollow?: CommonEventFunction
+}
+
+/** 关注生活号
+ * @classification open
+ * @supported alipay
+ * @see https://opendocs.alipay.com/mini/component/lifestyle
+ */
+declare const Lifestyle: ComponentType<LifestyleProps>
+export { Lifestyle, LifestyleProps }

package/types/Like.d.ts

@@ -0,0 +1,107 @@
+import { ComponentType } from 'react'
+import { StandardProps } from './common'
+interface LikeProps extends StandardProps {
+  /** 是否已被点赞
+   * @supported swan
+   * @default false
+   */
+  isLiked?: boolean
+
+  /** 按钮模式。icon：表示仅有图标；mixture：表示图标文字结合
+   * @supported swan
+   * @default "icon"
+   */
+  mode?: string
+
+  /** 图标类型。hand：表示手形；heart：表示心形
+   * @supported swan
+   * @default "hand"
+   */
+  iconType?: string
+
+  /** 点赞按钮上的文案。默认为赞，仅在 mode 属性值为'mixture'时有效
+   * @supported swan
+   * @default "赞"
+   */
+  likeText?: string
+
+  /** 点赞数量
+   * @supported swan
+   * @default 0
+   */
+  likeNum?: number
+
+  /** 被点赞的对象类型。0：表示对文章内容进行点赞；1：表示对评论内容进行点赞
+   * @supported swan
+   * @default 0
+   */
+  likeType?: number
+
+  /** 点赞动效形式。0：无动效；1：轻动效；2：强动效
+   * @supported swan
+   * @default 1
+   */
+  animationType?: number
+
+  /** 点赞后是否弹出 toast 提示
+   * @supported swan
+   * @default false
+   */
+  isShowToast?: boolean
+
+  /** toast 文案，默认为已点赞、已取消
+   * @supported swan
+   * @default ['已点赞', '已取消']
+   */
+  toastText?: string[]
+
+  /** 点赞服务需要的必要参数
+   * @supported swan
+   */
+  likeParam: LikeProps.ILikeParam
+
+  /** 使用 npm 方式引入点赞组件时，点击按钮时在用户未登录状态下会触发此事件；使用动态库方式引入点赞组件时，点击按钮时在用户未登录状态下不会触发此事件
+   * @supported swan
+   */
+  onError?: CommonEventFunction
+
+  /** 点击点赞按钮，在点赞服务成功后将状态返回给使用组件者
+   * @supported swan
+   */
+  onSuccess?: CommonEventFunction
+
+  /** 点击点赞按钮，在点赞服务失败后将状态返回给使用组件者
+   * @supported swan
+   */
+  onFail?: CommonEventFunction
+}
+declare namespace LikeProps {
+  interface ILikeParam {
+    /** 用户身份唯一标识 */
+    openid: string
+
+    /** 被点赞的文章的 id，与 path 参数一一对应
+     * @example "20200101"
+     */
+    snid: string
+
+    /** 被点赞的评论 id */
+    spid?: string
+
+    /** 文章标题 */
+    title: string
+
+    /** 智能小程序内页链接，最长不能超过 194 字符
+     * @example "/pages/index/index"
+     */
+    path: string
+  }
+}
+
+/** 点赞
+ * @classification open
+ * @supported swan
+ * @see https://smartprogram.baidu.com/docs/develop/extended/component-content/like/
+ */
+declare const Like: ComponentType<LikeProps>
+export { Like, LikeProps }

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/Login.d.ts

@@ -0,0 +1,45 @@
+import { ComponentType } from 'react'
+import { StandardProps } from './common'
+interface LoginProps extends StandardProps {
+  /** 组件中用户授权按钮的类名，可用于自定义样式
+   * @supported swan
+   */
+  buttonClass?: string
+
+  /** 组件中用户授权勾选框选中时的颜色，同 CSS 的 color
+   * @supported swan
+   * @default "#3388FF"
+   */
+  checkedColor?: string
+
+  /** 主题颜色，设置后将应用于 “用户授权按钮背景色” 和 “用户授权勾选框选中时的颜色”
+   * 注：theme-color 的优先级低于 button-class 和 checked-color，且当 button-class 存在时，theme-color 不生效
+   * @supported swan
+   * @default "#3388FF"
+   */
+  themeColor?: string
+
+  /** 用户完成授权后，获取用户手机号：
+   * detail.errMsg 值为"getPhoneNumber:ok" 时代表用户信息获取成功；
+   * detail.errMsg 值为"getPhoneNumber:fail auth deny"时代表用户信息获取失败。
+   * 参考 用户数据的签名验证和加解密 对用户数据进行处理获得用户手机号。
+   * 用户手机号信息解密后数据示例：{"mobile":"15000000000"}
+   * 1. 非个人开发者可申请；
+   * 2. 审核通过后，进入小程序首页,在左侧导航栏单击“设置 -> 开发设置”。下拉页面，在“获取用户手机号权限申请”中单击“申请开通”
+   * @supported swan
+   */
+  onGetPhoneNumber?: CommonEventFunction
+
+  /** 组件加载失败回调
+   * @supported swan
+   */
+  onLoadError?: CommonEventFunction
+}
+
+/** 联合登录 / 手机号授权内嵌组件
+ * @classification open
+ * @supported swan
+ * @see https://smartprogram.baidu.com/docs/develop/component/login/
+ */
+declare const Login: ComponentType<LoginProps>
+export { Login, LoginProps }

package/types/Lottie.d.ts

@@ -0,0 +1,113 @@
+import { ComponentType } from 'react'
+import { StandardProps } from './common'
+interface LottieProps extends StandardProps {
+  /** 是否自动播放。
+   * @supported alipay
+   * @default false
+   */
+  autoplay?: boolean
+
+  /** Lottie 资源地址。包含近端（包内地址）和远端（网络）的 JSON 文件地址。
+   * 与 djangoId 二选一。
+   * @supported alipay
+   */
+  path?: string
+
+  /** 播放速度。正数为正向播放，负数负向播放。
+   * @supported alipay
+   * @default 1.0
+   */
+  speed?: number
+
+  /** 循环次数。
+   *
+   * 如果是负数表示无限次。
+   * 如果是 0 表示不循环，播放一次。
+   * 如果是 1 表示循环一次，播放两次。
+   * @supported alipay
+   * @default 0
+   */
+  repeatCount?: number
+
+  /** 是否自动回播。
+   * @supported alipay
+   * @default false
+   */
+  autoReverse?: boolean
+
+  /** 资源地址。"/" 表明是小程序根目录。
+   * @supported alipay
+   */
+  assetsPath?: string
+
+  /** 兜底图或者降级图地址。
+   *
+   * 1. 支持本地资源，案例：'/image/lottie/lottie2_default.png'。
+   * 支持 http 的 cdn 地址、近端地址。
+   * 小程序场景不支持 djangoId。
+   * @supported alipay
+   */
+  placeholder?: string
+
+  /** 在线资源的 md5 校验。
+   * djangoId=https://b.zip。
+   * 可以使用 b.zip 加密 获取 md5 值
+   * md5="77c6c86fc89ba94cc0a9271b77ae77d2"
+   * @supported alipay
+   */
+  md5?: string
+
+  /** 降级。降级是指如遇低端设备，Lottie 会降级展示为 placeholder。
+   * 当 optimize 为 true ，并且传入了 placeholder 时，在低端设备上只会展示 placeholder，不展示 Lottie。
+   * 低端设备如下所示：
+   *
+   * iOS ：小于等于 iPhone6P
+   * Android：内存容量小于 3G
+   * @supported alipay
+   * @default false
+   */
+  optimize?: boolean
+
+  /** 当数据下载+视图创建完成时触发。
+   * @supported alipay
+   */
+  onDataReady?: CommonEventFunction
+
+  /** 数据加载失败时触发。
+   * @supported alipay
+   */
+  onDataFailed?: CommonEventFunction
+
+  /** 动画开始时触发。
+   * @supported alipay
+   */
+  onAnimationStart?: CommonEventFunction
+
+  /** 动画结束时触发。
+   * @supported alipay
+   */
+  onAnimationEnd?: CommonEventFunction
+
+  /** 动画一次重播结束。
+   * @supported alipay
+   */
+  onAnimationRepeat?: CommonEventFunction
+
+  /** 动画取消。业务调用 Cancel 时回调。
+   * @supported alipay
+   */
+  onAnimationCancel?: CommonEventFunction
+
+  /** 参数化时，数据准备完成，等待业务传入参数化值。
+   * @supported alipay
+   */
+  onDataLoadReady?: CommonEventFunction
+}
+
+/** Lottie
+ * @classification media
+ * @supported alipay
+ * @see https://opendocs.alipay.com/mini/component/lottie
+ */
+declare const Lottie: ComponentType<LottieProps>
+export { Lottie, LottieProps }

package/types/Map.d.ts

@@ -155,6 +155,65 @@ interface MapProps extends StandardProps {
         [key: string]: number | string | any
       }
 
+  /** 视野在地图 padding 范围内展示
+   * @supported alipay
+   */
+  includePadding?: { [key in 'left' | 'right' | 'top' | 'bottom']: number | string }
+
+  /** 覆盖物，自定义贴图
+   * @supported alipay
+   */
+  groundOverlays?: any[]
+
+  /** 覆盖物，网格贴图
+   * @supported alipay
+   */
+  tileOverlay?: any[]
+
+  /** 是否展示 POI 点
+   * @supported weapp, alipay, tt
+   */
+  enablePoi?: string
+
+  /** 是否展示建筑物
+   * @supported weapp, alipay, tt
+   */
+  enableBuilding?: string
+
+  /** 覆盖物，多边形。
+   * @supported alipay
+   */
+  polygon?: string
+
+  /** 设置地图样式。
+   *
+   * default：默认样式
+   * light：精简样式
+   * @supported alipay
+   */
+  customMapStyle?: string
+
+  /** 基于 map 高级定制渲染，设置覆盖在地图上的 view。
+   * @supported alipay
+   */
+  panels?: string
+
+  /** 否
+   * @supported jd
+   */
+  theme?: string
+
+  /** 内联样式。
+   * @supported alipay
+   */
+  optimize?: string
+
+  /** 展示3D楼块
+   * @supported weapp, swan, tt, qq
+   * @default false
+   */
+  enable3D?: boolean
+
   /** 点击地图时触发
    * @supported weapp, alipay, swan, tt, qq, jd
    */
@@ -188,42 +247,13 @@ 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
    */
   onPoiTap?: CommonEventFunction<MapProps.onPoiTapEventDetail>
 
-  /** 视野在地图 padding 范围内展示
-   * @supported alipay
-   */
-  includePadding?: {
-    [key in 'left' | 'right' | 'top' | 'bottom']: number | string
-  }
-
-  /** 覆盖物，自定义贴图
-   * @supported alipay
-   */
-  groundOverlays?: any[]
-
-  /** 覆盖物，网格贴图
-   * @supported alipay
-   */
-  tileOverlay?: any[]
-
-  /** 是否展示 POI 点
-   * @supported weapp, alipay, tt
-   */
-  enablePoi?: string
-
-  /** 是否展示建筑物
-   * @supported weapp, alipay, tt
-   */
-  enableBuilding?: string
-
   /** 点击标记点对应的气泡时触发e.detail = {markerId}
    * @supported weapp, swan, tt, jd
    */
@@ -234,49 +264,18 @@ interface MapProps extends StandardProps {
    */
   onAnchorPointTap?: CommonEventFunction
 
-  /** 覆盖物，多边形。
-   * @supported alipay
-   */
-  polygon?: string
-
-  /** 设置地图样式。
-   *
-   * default：默认样式
-   * light：精简样式
-   * @supported alipay
-   */
-  customMapStyle?: string
-
-  /** 基于 map 高级定制渲染，设置覆盖在地图上的 view。
-   * @supported alipay
-   */
-  panels?: string
-
   /** 点击 panel 时触发。
    * @supported alipay
    */
-  onPanelTap?: CommonEventFunction<{ panelId, layoutId }>
+  onPanelTap?: CommonEventFunction<{
+    panelId
+    layoutId
+  }>
 
   /** 地图初始化完成即将开始渲染第一帧时触发。
    * @supported alipay
    */
   onInitComplete?: CommonEventFunction
-
-  /** 否
-   * @supported jd
-   */
-  theme?: string
-
-  /** 内联样式。
-   * @supported alipay
-   */
-  optimize?: string
-
-  /** 展示3D楼块
-   * @supported weapp, swan, tt, qq
-   * @default false
-   */
-  enable3D?: string
 }
 declare namespace MapProps {
   /** 标记点用于在地图上显示标记的位置 */
@@ -633,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>
@@ -646,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
@@ -101,11 +97,6 @@ interface MovableViewProps extends Omit<StandardProps, 'animation'> {
    */
   onDragEnd?: CommonEventFunction
 
-  /** 触摸动作结束，事件会向父节点传递。
-   * @supported alipay
-   */
-  onDragEnd?: CommonEventFunction
-
   /** 缩放过程中触发的事件
    * @supported weapp, alipay, swan, tt, qq
    */
@@ -122,7 +113,7 @@ interface MovableViewProps extends Omit<StandardProps, 'animation'> {
   onTouchMove?: CommonEventFunction
 
   /** 手指触摸动作结束
-   * @supported h5
+   * @supported alipay, h5
    * @h5 此事件的触发顺序会因为当前事件机制引起组件内外注册的事件执行顺序不正常，外部注册的事件可能会优先于内部执行，如需保证执行顺序一致，需要在回调函数中包裹 setTimeout 临时处理
    */
   onTouchEnd?: TouchEventFunction
@@ -133,12 +124,12 @@ interface MovableViewProps extends Omit<StandardProps, 'animation'> {
   onTouchCancel?: CommonEventFunction
 
   /** 初次手指触摸后移动为横向的移动，如果 catch 此事件，则意味着 touchmove 事件也被 catch
-   * @supported swan
+   * @supported weapp, swan, tt
    */
   onHTouchMove?: TouchEventFunction
 
   /** 初次手指触摸后移动为纵向的移动，如果 catch 此事件，则意味着 touchmove 事件也被 catch
-   * @supported swan
+   * @supported weapp, swan, tt
    */
   onVTouchMove?: TouchEventFunction
 
@@ -148,7 +139,7 @@ interface MovableViewProps extends Omit<StandardProps, 'animation'> {
   catchTouchStart?: CommonEventFunction
 
   /** 触摸移动事件，事件仅作用于组件，不向父节点传递。
-   * @supported weapp, tt, alipay
+   * @supported alipay
    */
   catchTouchMove?: CommonEventFunction