@tarojs/components 3.5.6 → 3.5.7-alpha.1

package/types/Button.d.ts

@@ -132,10 +132,74 @@ interface ButtonProps extends StandardProps {
    */
   showMessageCard?: boolean
 
+  /** 生活号 id，必须是当前小程序同主体且已关联的生活号，open-type="lifestyle" 时有效。
+   * @supported alipay, qq
+   */
+  publicId?: string
+
+  /** 发送订阅类模板消息所用的模板库标题 ID ，可通过 getTemplateLibraryList 获取
+   * 当参数类型为 Array 时，可传递 1~3 个模板库标题 ID
+   * @supported swan
+   */
+  templateId?: string | Array<string>
+
+  /** 发送订阅类模板消息时所使用的唯一标识符，内容由开发者自定义，用来标识订阅场景
+   * 注意：同一用户在同一 subscribe-id 下的多次授权不累积下发权限，只能下发一条。若要订阅多条，需要不同 subscribe-id
+   * @supported swan
+   */
+  subscribeId?: string
+
+  /** 打开群资料卡时，传递的群号
+   * @supported qq
+   */
+  groupId?: string
+
+  /** 打开频道页面时，传递的频道号
+   * @supported qq
+   */
+  guildId?: string
+
+  /** 分享类型集合，请参考下面share-type有效值说明。share-type后续将不再维护，请更新为share-mode
+   * @supported qq
+   * @default 27
+   */
+  shareType?: string
+
+  /** 分享类型集合，请参考下面share-mode有效值说明
+   * @supported qq
+   * @default ['qq', 'qzone']
+   */
+  shareMode?: string
+
+  /** 无障碍访问，（属性）元素的额外描述
+   * @supported qq
+   */
+  ariaLabel?: string
+
+  /** 添加好友时，对方的 openid
+   * @supported qq
+   */
+  openId?: string
+
+  /** 发送对象的 FriendInfo
+   * @supported qq
+   */
+  shareMessageFriendInfo?: string
+
+  /** 转发标题，不传则默认使用当前小程序的昵称。 FriendInfo
+   * @supported qq
+   */
+  shareMessageTitle?: string
+
+  /** 转发显示图片的链接，可以是网络图片路径（仅 QQ CDN 域名路径）或本地图片文件路径或相对代码包根目录的图片文件路径。显示图片长宽比是 5:4FriendInfo
+   * @supported qq
+   */
+  shareMessageImg?: string
+
   /** 用户点击该按钮时，会返回获取到的用户信息，回调的detail数据与 Taro.getUserInfo 返回的一致
    *
    * 生效时机: `open-type="getUserInfo"`
-   * @supported weapp, swan, qq, jd
+   * @supported weapp, alipay, swan, qq, jd
    */
   onGetUserInfo?: CommonEventFunction<ButtonProps.onGetUserInfoEventDetail>
 
@@ -156,7 +220,7 @@ interface ButtonProps extends StandardProps {
   /** 获取用户手机号回调
    *
    * 生效时机：`open-type="getphonenumber"`
-   * @supported weapp, swan, tt, jd
+   * @supported weapp, alipay, swan, tt, jd
    */
   onGetPhoneNumber?: CommonEventFunction<ButtonProps.onGetPhoneNumberEventDetail>
 
@@ -194,34 +258,16 @@ interface ButtonProps extends StandardProps {
    */
   onTap?: CommonEventFunction
 
-  /** 生活号 id，必须是当前小程序同主体且已关联的生活号，open-type="lifestyle" 时有效。
-   * @supported alipay, qq
-   */
-  publicId?: string
-
   /** 当 open-type 为 lifestyle 时有效。
    * 当点击按钮时触发。
    * event.detail = { followStatus }，followStatus 合法值有 1、2、3，其中 1 表示已关注。2 表示用户不允许关注。3 表示发生未知错误；
    * 已知问题：基础库 1.0，当用户在点击按钮前已关注生活号，event.detail.followStatus 的值为 true。
-   * 版本要求：基础库 1.11.0 及以上
    * @supported alipay
    */
   onFollowLifestyle?: CommonEventFunction<{
     followStatus: 1 | 2 | 3 | true
   }>
 
-  /** 发送订阅类模板消息所用的模板库标题 ID ，可通过 getTemplateLibraryList 获取
-   * 当参数类型为 Array 时，可传递 1~3 个模板库标题 ID
-   * @supported swan
-   */
-  templateId?: string | Array<string>
-
-  /** 发送订阅类模板消息时所使用的唯一标识符，内容由开发者自定义，用来标识订阅场景
-   * 注意：同一用户在同一 subscribe-id 下的多次授权不累积下发权限，只能下发一条。若要订阅多条，需要不同 subscribe-id
-   * @supported swan
-   */
-  subscribeId?: string
-
   /** 用户点击该按钮时，调起用户编辑收货地址原生界面，并在编辑完成后返回用户选择的地址，从返回参数的 detail 中获取，和 swan.chooseAddress 一样的。和 open-type 搭配使用，使用时机：open-type="chooseAddress"
    * @supported swan
    */
@@ -242,53 +288,6 @@ interface ButtonProps extends StandardProps {
    */
   onSubscribe?: CommonEventFunction
 
-  /** 打开群资料卡时，传递的群号
-   * @supported qq
-   */
-  groupId?: string
-
-  /** 打开频道页面时，传递的频道号
-   * @supported qq
-   */
-  guildId?: string
-
-  /** 分享类型集合，请参考下面share-type有效值说明。share-type后续将不再维护，请更新为share-mode
-   * @supported qq
-   * @default 27
-   */
-  shareType?: string
-
-  /** 分享类型集合，请参考下面share-mode有效值说明
-   * @supported qq
-   * @default ['qq', 'qzone']
-   */
-  shareMode?: string
-
-  /** 无障碍访问，（属性）元素的额外描述
-   * @supported qq
-   */
-  ariaLabel?: string
-
-  /** 添加好友时，对方的 openid
-   * @supported qq
-   */
-  openId?: string
-
-  /** 发送对象的 FriendInfo
-   * @supported qq
-   */
-  shareMessageFriendInfo?: string
-
-  /** 转发标题，不传则默认使用当前小程序的昵称。 FriendInfo
-   * @supported qq
-   */
-  shareMessageTitle?: string
-
-  /** 转发显示图片的链接，可以是网络图片路径（仅 QQ CDN 域名路径）或本地图片文件路径或相对代码包根目录的图片文件路径。显示图片长宽比是 5:4FriendInfo
-   * @supported qq
-   */
-  shareMessageImg?: string
-
   /** 添加好友的回调
    * @supported qq
    */
@@ -331,10 +330,7 @@ declare namespace ButtonProps {
   }
 
   /** open-type 的合法值 */
-  type OpenType =
-    | keyof openTypeKeys['weapp']
-    | keyof openTypeKeys['alipay']
-    | keyof openTypeKeys['qq']
+  type OpenType = keyof openTypeKeys['weapp'] | keyof openTypeKeys['alipay'] | keyof openTypeKeys['qq']
 
   /** open-type 的合法值 */
   interface openTypeKeys {

package/types/Camera.d.ts

@@ -3,7 +3,7 @@ import { StandardProps, CommonEventFunction } from './common'
 interface CameraProps extends StandardProps {
   /** 模式，有效值为normal, scanCode
    * @default "normal"
-   * @supported weapp, tt, qq, jd, rn
+   * @supported weapp, alipay, tt, qq, jd, rn
    */
   mode?: keyof CameraProps.Mode
 
@@ -15,30 +15,36 @@ interface CameraProps extends StandardProps {
 
   /** 摄像头朝向
    * @default "back"
-   * @supported weapp, swan, tt, qq, jd, rn
+   * @supported weapp, alipay, swan, tt, qq, jd, rn
    */
   devicePosition?: keyof CameraProps.DevicePosition
 
   /** 闪光灯
    * @default "auto"
-   * @supported weapp, swan, tt, qq, jd, rn
+   * @supported weapp, alipay, swan, tt, qq, jd, rn
    */
   flash?: keyof CameraProps.Flash
 
   /** 指定期望的相机帧数据尺寸
    * @default "medium"
-   * @supported weapp, tt
+   * @supported weapp, alipay, tt
    */
   frameSize?: keyof CameraProps.FrameSize
 
+  /** 相机拍照，录制的分辨率。
+   * @supported alipay
+   * @default "720P"
+   */
+  outputDimension?: '360P' | '540P' | '720P' | '1080P' | 'max'
+
   /** 摄像头在非正常终止时触发，
    * 如退出后台等情况
-   * @supported weapp, swan, tt, qq, jd, rn
+   * @supported weapp, alipay, swan, tt, qq, jd, rn
    */
   onStop?: CommonEventFunction
 
   /** 用户不允许使用摄像头时触发
-   * @supported weapp, swan, tt, qq, jd, rn
+   * @supported weapp, alipay, swan, tt, qq, jd, rn
    */
   onError?: CommonEventFunction
 
@@ -47,11 +53,16 @@ interface CameraProps extends StandardProps {
    */
   onInitDone?: CommonEventFunction<CameraProps.onInitDoneEventDetail>
 
+  /** 相机初始化成功时触发。
+   * @supported alipay
+   */
+  onReady?: CommonEventFunction<CameraProps.onInitDoneEventDetail>
+
   /** 在成功识别到一维码时触发，
    * 仅在 mode="scanCode" 时生效
-   * @supported weapp, tt, qq, rn
+   * @supported weapp, alipay, tt, qq, rn
    */
-  onScanCode?: CommonEventFunction
+  onScanCode?: CommonEventFunction<CameraProps.onScanCodeEventDetail>
 }
 declare namespace CameraProps {
   /** mode 的合法值 */
@@ -114,6 +125,26 @@ declare namespace CameraProps {
     /** 最大变焦 */
     maxZoom: number
   }
+  interface onScanCodeEventDetail {
+    /** 字符集 */
+    charSet: string
+
+    /** 原始数据
+     * @supported weapp
+     */
+    rawData: string
+
+    /** 码类型 */
+    type: string
+
+    /** 识别结果 */
+    result: string
+
+    /** 识别结果(完整)
+     * @supported alipay
+     */
+    fullResult: string
+  }
 }
 
 /** 系统相机

package/types/Canvas.d.ts

@@ -1,10 +1,5 @@
 import { ComponentType } from 'react'
-import {
-  StandardProps,
-  CommonEventFunction,
-  CanvasTouchEventFunction,
-  CanvasTouchEvent,
-} from './common'
+import { StandardProps, CommonEventFunction, CanvasTouchEventFunction, CanvasTouchEvent } from './common'
 interface CanvasProps extends StandardProps<any, CanvasTouchEvent> {
   /** 指定 canvas 类型，支持 2d 和 webgl
    * @supported weapp, alipay, tt
@@ -22,6 +17,27 @@ interface CanvasProps extends StandardProps<any, CanvasTouchEvent> {
    */
   disableScroll?: boolean
 
+  /** 用于透传 `WebComponents` 上的属性到内部 H5 标签上
+   * @supported h5
+   */
+  nativeProps?: Record<string, unknown>
+
+  /** 组件唯一标识符。
+   * 注意：同一页面中的 id 不可重复。
+   * @supported alipay
+   */
+  id?: string
+
+  /**
+   * @supported alipay
+   */
+  width?: string
+
+  /**
+   * @supported alipay
+   */
+  height?: string
+
   /** 手指触摸动作开始
    * @supported weapp, alipay, swan, tt, qq, jd
    */
@@ -52,44 +68,12 @@ interface CanvasProps extends StandardProps<any, CanvasTouchEvent> {
    */
   onError?: CommonEventFunction<CanvasProps.onErrorEventDetail>
 
-  /** 用于透传 `WebComponents` 上的属性到内部 H5 标签上
-   * @supported h5
-   */
-  nativeProps?: Record<string, unknown>
-
-  /** 组件唯一标识符。
-   * 注意：同一页面中的 id 不可重复。
-   * @supported alipay
-   */
-  id?: string
-
-  /** -
-   * @supported alipay
-   */
-  style?: string
-
-  /** -
-   * @supported alipay
-   */
-  class?: string
-
-  /**
-   * @supported alipay
-   */
-  width?: string
-
-  /**
-   * @supported alipay
-   */
-  height?: string
-
   /** 点击。
    * @supported alipay
    */
   onTap?: CommonEventFunction
 
   /** canvas 组件初始化成功触发。
-   * 版本要求：基础库 2.7.0 及以上
    * @supported alipay
    */
   onReady?: CommonEventFunction

package/types/Checkbox.d.ts

@@ -23,13 +23,6 @@ interface CheckboxProps extends StandardProps {
    */
   color?: string
 
-  /** 选中项发生变化时触发 change 事件，小程序无此 API
-   * @supported alipay, h5, rn
-   */
-  onChange?: CommonEventFunction<{
-    value: string[]
-  }>
-
   /** 用于透传 `WebComponents` 上的属性到内部 H5 标签上
    * @supported h5
    */
@@ -39,6 +32,13 @@ interface CheckboxProps extends StandardProps {
    * @supported qq
    */
   ariaLabel?: string
+
+  /** 选中项发生变化时触发 change 事件，小程序无此 API
+   * @supported alipay, h5, rn
+   */
+  onChange?: CommonEventFunction<{
+    value: string[]
+  }>
 }
 
 /** 多选项目

package/types/CoverImage.d.ts

@@ -6,27 +6,11 @@ interface CoverImageProps extends StandardProps {
    */
   src: string
 
-  /** 图片加载成功时触发
-   * @supported weapp, swan, qq, h5
-   */
-  onLoad?: CommonEventFunction
-
-  /** 图片加载失败时触发
-   * @supported weapp, swan, qq, h5
-   */
-  onError?: CommonEventFunction
-
   /** 格式固定为 https://servicewechat.com/{appid}/{version}/page-frame.html，其中 {appid} 为小程序的 appid，{version} 为小程序的版本号，版本号为 0 表示为开发版、体验版以及审核版本，版本号为 devtools 表示为开发者工具，其余为正式版本；
    * @supported weapp
    */
   referrerPolicy?: 'origin' | 'no-referrer'
 
-  /** 点击事件回调。
-   * 版本要求： 基础库 1.9.0 及以上
-   * @supported alipay
-   */
-  onTap?: CommonEventFunction
-
   /** 设置与容器顶部的固定距离，效果相当于在 CSS 中设置 position: fixed 和 top 值，该属性优先级高于 fixed-bottom，CSS 设置的 position、top、bottom 值
    * @supported swan
    */
@@ -56,6 +40,21 @@ interface CoverImageProps extends StandardProps {
    * @supported qq
    */
   ariaLabel?: string
+
+  /** 图片加载成功时触发
+   * @supported weapp, swan, qq, h5
+   */
+  onLoad?: CommonEventFunction
+
+  /** 图片加载失败时触发
+   * @supported weapp, swan, qq, h5
+   */
+  onError?: CommonEventFunction
+
+  /** 点击事件回调。
+   * @supported alipay
+   */
+  onTap?: CommonEventFunction
 }
 
 /** 覆盖在原生组件之上的图片视图。可覆盖的原生组件同cover-view，支持嵌套在cover-view里。

package/types/CoverView.d.ts

@@ -7,12 +7,6 @@ interface CoverViewProps extends ViewProps {
    */
   scrollTop?: number
 
-  /** 点击事件回调。
-   * 版本要求：基础库 1.9.0 及以上
-   * @supported alipay
-   */
-  onTap?: CommonEventFunction
-
   /** 设置与容器顶部的固定距离，效果相当于在 CSS 中设置 position: fixed 和 top 值，该属性优先级高于 fixed-bottom，CSS 设置的 position、top、bottom 值
    * @supported swan
    */
@@ -42,6 +36,11 @@ interface CoverViewProps extends ViewProps {
    * @supported qq
    */
   ariaLabel?: string
+
+  /** 点击事件回调。
+   * @supported alipay
+   */
+  onTap?: CommonEventFunction
 }
 
 /** 覆盖在原生组件之上的文本视图。可覆盖的原生组件包括 map、video、canvas、camera、live-player、live-pusher 只支持嵌套 cover-view、cover-image，可在 cover-view 中使用 button。

package/types/Form.d.ts

@@ -17,16 +17,6 @@ interface FormProps extends StandardProps {
    */
   reportSubmitTimeout?: number
 
-  /** 携带 form 中的数据触发 submit 事件
-   * @supported weapp, alipay, swan, tt, qq, jd, rn
-   */
-  onSubmit?: CommonEventFunction<FormProps.onSubmitEventDetail>
-
-  /** 表单重置时会触发 reset 事件
-   * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
-   */
-  onReset?: CommonEventFunction
-
   /** 模板消息的类型，report-submit 为 true 时填写有效
    * 取值：default / subscribe
    * @default 'default'
@@ -45,6 +35,16 @@ interface FormProps extends StandardProps {
    * @supported swan
    */
   subscribeId?: string
+
+  /** 携带 form 中的数据触发 submit 事件
+   * @supported weapp, alipay, swan, tt, qq, jd, rn
+   */
+  onSubmit?: CommonEventFunction<FormProps.onSubmitEventDetail>
+
+  /** 表单重置时会触发 reset 事件
+   * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
+   */
+  onReset?: CommonEventFunction
 }
 declare namespace FormProps {
   interface onSubmitEventDetail {

package/types/Image.d.ts

@@ -37,16 +37,6 @@ interface ImageProps extends StandardProps {
    */
   showMenuByLongpress?: boolean
 
-  /** 当错误发生时，发布到 AppService 的事件名，事件对象
-   * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
-   */
-  onError?: CommonEventFunction<ImageProps.onErrorEventDetail>
-
-  /** 当图片载入完毕时，发布到 AppService 的事件名，事件对象
-   * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
-   */
-  onLoad?: CommonEventFunction<ImageProps.onLoadEventDetail>
-
   /**
    * 为 img 标签额外增加的属性
    * @supported h5
@@ -58,32 +48,11 @@ interface ImageProps extends StandardProps {
    */
   nativeProps?: Record<string, unknown>
 
-  /** 外部样式。
-   * @supported alipay
-   */
-  class?: string
-
-  /** 内联样式。
-   * @supported alipay
-   */
-  style?: string
-
   /** 默认图片地址，若设置默认图片地址，会先显示默认图片，等 src 对应的图片加载成功后，再渲染对应的图片。
-   * 版本要求： 基础库 1.19.0 及以上
    * @supported alipay
    */
   defaultSource?: string
 
-  /** 点击图片时触发。
-   * @supported alipay
-   */
-  onTap?: CommonEventFunction
-
-  /** 点击图片时触发，阻止事件冒泡。
-   * @supported alipay
-   */
-  catchTap?: CommonEventFunction
-
   /** 阻止长按图片时弹起默认菜单（即将该属性设置为image-menu-prevent="true"或image-menu-prevent），只在初始化时有效，不能动态变更；若不想阻止弹起默认菜单，则不需要设置此属性。注：长按菜单后的操作暂不支持 svg 格式
    * @supported swan
    */
@@ -103,6 +72,26 @@ interface ImageProps extends StandardProps {
    * @supported qq
    */
   ariaLabel?: string
+
+  /** 当错误发生时，发布到 AppService 的事件名，事件对象
+   * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
+   */
+  onError?: CommonEventFunction<ImageProps.onErrorEventDetail>
+
+  /** 当图片载入完毕时，发布到 AppService 的事件名，事件对象
+   * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
+   */
+  onLoad?: CommonEventFunction<ImageProps.onLoadEventDetail>
+
+  /** 点击图片时触发。
+   * @supported alipay
+   */
+  onTap?: CommonEventFunction
+
+  /** 点击图片时触发，阻止事件冒泡。
+   * @supported alipay
+   */
+  catchTap?: CommonEventFunction
 }
 declare namespace ImageProps {
   /** mode 的合法值 */

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
 
@@ -165,6 +165,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,27 +210,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 可能失效。
-   * 版本要求：基础库 2.7.3 及以上
-   * @supported alipay
-   */
-  alwaysSystem?: string
-
-  /** 无障碍访问，（属性）元素的额外描述
-   * @supported qq
-   */
-  ariaLabel?: string
 }
 declare namespace InputProps {
   /** > 注意：React-Native 端 `inputEventDetail` 仅实现参数 `value`，若需实时获取光标位置则可通过 [`onSelectionChange`](https://reactnative.dev/docs/textinput#onselectionchange) 实现。 */