@tarojs/components 3.5.5 → 3.5.6-alpha.1

package/types/Canvas.d.ts

@@ -1,50 +1,54 @@
 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
+   * @supported weapp, alipay, tt
    */
   type?: string
 
   /** canvas 组件的唯一标识符，若指定了 type 则无需再指定该属性
-   * @supported weapp
+   * @supported weapp, swan, tt, qq, jd
    */
   canvasId?: string
 
   /** 当在 canvas 中移动时且有绑定手势事件时，禁止屏幕滚动以及下拉刷新
    * @default false
-   * @supported weapp
+   * @supported weapp, alipay, swan, qq, jd
    */
   disableScroll?: boolean
 
   /** 手指触摸动作开始
-   * @supported weapp
+   * @supported weapp, alipay, swan, tt, qq, jd
    */
   onTouchStart?: CanvasTouchEventFunction
 
   /** 手指触摸后移动
-   * @supported weapp
+   * @supported weapp, alipay, swan, tt, qq, jd
    */
   onTouchMove?: CanvasTouchEventFunction
 
   /** 手指触摸动作结束
-   * @supported weapp
+   * @supported weapp, alipay, swan, tt, qq, jd
    */
   onTouchEnd?: CanvasTouchEventFunction
 
   /** 手指触摸动作被打断，如来电提醒，弹窗
-   * @supported weapp
+   * @supported weapp, alipay, swan, tt, qq, jd
    */
   onTouchCancel?: CanvasTouchEventFunction
 
   /** 手指长按 500ms 之后触发，触发了长按事件后进行移动不会触发屏幕的滚动
-   * @supported weapp
+   * @supported weapp, alipay, swan, qq, jd
    */
   onLongTap?: CommonEventFunction
 
   /** 当发生错误时触发 error 事件，detail = {errMsg: 'something wrong'}
-   * @supported weapp
+   * @supported weapp, swan, qq, jd
    */
   onError?: CommonEventFunction<CanvasProps.onErrorEventDetail>
 
@@ -52,8 +56,44 @@ interface CanvasProps extends StandardProps<any, CanvasTouchEvent> {
    * @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
+}
 declare namespace CanvasProps {
   interface onErrorEventDetail {
     errMsg: string
@@ -86,5 +126,4 @@ declare namespace CanvasProps {
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/canvas.html
  */
 declare const Canvas: ComponentType<CanvasProps>
-
 export { Canvas, CanvasProps }

package/types/Checkbox.d.ts

@@ -1,39 +1,44 @@
 import { ComponentType } from 'react'
 import { StandardProps, CommonEventFunction, FormItemProps } from './common'
-
 interface CheckboxProps extends StandardProps {
-
   /** `<Checkbox/>`标识，选中时触发`<CheckboxGroup/>`的 change 事件，并携带 `<Checkbox/>` 的 value
-   * @supported weapp, rn, tt
+   * @supported weapp, alipay, swan, tt, qq, jd, rn
    */
   value: string
 
   /** 是否禁用
-   * @supported weapp, h5, rn, tt
+   * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
    * @default false
    */
   disabled?: boolean
 
   /** 当前是否选中，可用来设置默认选中
-   * @supported weapp, h5, rn, tt
+   * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
    * @default false
    */
   checked?: boolean
 
   /** checkbox的颜色，同 css 的 color
-   * @supported weapp, h5, rn, tt
+   * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
    */
   color?: string
 
   /** 选中项发生变化时触发 change 事件，小程序无此 API
-   * @supported h5, rn
+   * @supported alipay, h5, rn
    */
-  onChange?: CommonEventFunction<{ value: string[] }>
+  onChange?: CommonEventFunction<{
+    value: string[]
+  }>
 
   /** 用于透传 `WebComponents` 上的属性到内部 H5 标签上
    * @supported h5
    */
   nativeProps?: Record<string, unknown>
+
+  /** 无障碍访问，（属性）元素的额外描述
+   * @supported qq
+   */
+  ariaLabel?: string
 }
 
 /** 多选项目
@@ -161,6 +166,4 @@ interface CheckboxProps extends StandardProps {
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/checkbox.html
  */
 declare const Checkbox: ComponentType<CheckboxProps>
-
-
 export { Checkbox, CheckboxProps }

package/types/CheckboxGroup.d.ts

@@ -1,18 +1,17 @@
 import { ComponentType } from 'react'
 import { StandardProps, CommonEventFunction, FormItemProps } from './common'
-
 interface CheckboxGroupProps extends StandardProps, FormItemProps {
   /** 表单组件中加上 name 来作为 key
-   * @supported h5, tt
+   * @supported alipay, tt, h5
    */
   name?: string
 
   /** `<CheckboxGroup/>` 中选中项发生改变是触发 change 事件
-   *
-   * event.detail = { value: [选中的checkbox的 value 的数组] }
-   * @supported weapp, h5, rn, tt
+   * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
    */
-  onChange?: CommonEventFunction<{ value: string[] }>
+  onChange?: CommonEventFunction<{
+    value: string[]
+  }>
 }
 
 /** 多项选择器，内部由多个checkbox组成
@@ -81,5 +80,4 @@ interface CheckboxGroupProps extends StandardProps, FormItemProps {
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/checkbox-group.html
  */
 declare const CheckboxGroup: ComponentType<CheckboxGroupProps>
-
 export { CheckboxGroup, CheckboxGroupProps }

package/types/CoverImage.d.ts

@@ -1,21 +1,61 @@
 import { ComponentType } from 'react'
 import { StandardProps, CommonEventFunction } from './common'
-
 interface CoverImageProps extends StandardProps {
   /** 图标路径，支持临时路径、网络地址、云文件ID。暂不支持base64格式。
-   * @supported weapp, h5
+   * @supported weapp, alipay, swan, qq, h5
    */
   src: string
 
   /** 图片加载成功时触发
-   * @supported weapp, h5
+   * @supported weapp, swan, qq, h5
    */
   onLoad?: CommonEventFunction
 
   /** 图片加载失败时触发
-   * @supported weapp, h5
+   * @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
+   */
+  fixedTop?: string
+
+  /** 设置与容器右侧的固定距离，效果相当于在 CSS 中设置 position: fixed 和 right 值，该属性优先级高于 CSS 设置的 position、left、right 值
+   * @supported swan
+   */
+  fixedRight?: string
+
+  /** 设置与容器底部的固定距离，效果相当于在 CSS 中设置 position: fixed 和 bottom 值，该属性优先级高于 CSS 设置的 position、top、bottom 值
+   * @supported swan
+   */
+  fixedBottom?: string
+
+  /** 设置与容器左侧的固定距离，效果相当于在 CSS 中设置 position: fixed 和 left 值，该属性优先级高于 fixed-right，CSS 设置的 position、left、right 值
+   * @supported swan
+   */
+  fixedLeft?: string
+
+  /** 无障碍访问，（角色）标识元素的作用
+   * @supported qq
+   */
+  ariaRole?: string
+
+  /** 无障碍访问，（属性）元素的额外描述
+   * @supported qq
+   */
+  ariaLabel?: string
 }
 
 /** 覆盖在原生组件之上的图片视图。可覆盖的原生组件同cover-view，支持嵌套在cover-view里。
@@ -82,5 +122,4 @@ interface CoverImageProps extends StandardProps {
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/cover-image.html
  */
 declare const CoverImage: ComponentType<CoverImageProps>
-
 export { CoverImage, CoverImageProps }

package/types/CoverView.d.ts

@@ -1,22 +1,47 @@
 import { ComponentType } from 'react'
+import { CommonEventFunction } from './common'
 import { ViewProps } from './View'
-
 interface CoverViewProps extends ViewProps {
   /** 设置顶部滚动偏移量，仅在设置了 overflow-y: scroll 成为滚动元素后生效
-   * @supported weapp
+   * @supported weapp, swan, qq
    */
   scrollTop?: number
 
-  /**
-   * 适用于地图组件 map 的自定义气泡 customCallout
-   * @supported weapp
+  /** 点击事件回调。
+   * 版本要求：基础库 1.9.0 及以上
+   * @supported alipay
+   */
+  onTap?: CommonEventFunction
+
+  /** 设置与容器顶部的固定距离，效果相当于在 CSS 中设置 position: fixed 和 top 值，该属性优先级高于 fixed-bottom，CSS 设置的 position、top、bottom 值
+   * @supported swan
+   */
+  fixedTop?: string
+
+  /** 设置与容器右侧的固定距离，效果相当于在 CSS 中设置 position: fixed 和 right 值，该属性优先级高于 CSS 设置的 position、left、right 值
+   * @supported swan
+   */
+  fixedRight?: string
+
+  /** 设置与容器底部的固定距离，效果相当于在 CSS 中设置 position: fixed 和 bottom 值，该属性优先级高于 CSS 设置的 position、top、bottom 值
+   * @supported swan
+   */
+  fixedBottom?: string
+
+  /** 设置与容器左侧的固定距离，效果相当于在 CSS 中设置 position: fixed 和 left 值，该属性优先级高于 fixed-right，CSS 设置的 position、left、right 值
+   * @supported swan
    */
-  markerId?: string
+  fixedLeft?: string
 
-  /**
-   * @supported weapp
+  /** 无障碍访问，（角色）标识元素的作用
+   * @supported qq
    */
-  slot?: string
+  ariaRole?: string
+
+  /** 无障碍访问，（属性）元素的额外描述
+   * @supported qq
+   */
+  ariaLabel?: string
 }
 
 /** 覆盖在原生组件之上的文本视图。可覆盖的原生组件包括 map、video、canvas、camera、live-player、live-pusher 只支持嵌套 cover-view、cover-image，可在 cover-view 中使用 button。
@@ -84,5 +109,4 @@ interface CoverViewProps extends ViewProps {
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/cover-view.html
  */
 declare const CoverView: ComponentType<CoverViewProps>
-
 export { CoverView, CoverViewProps }

package/types/Editor.d.ts

@@ -1,6 +1,5 @@
 import { ComponentType } from 'react'
 import { StandardProps, CommonEventFunction } from './common'
-
 interface EditorProps extends StandardProps {
   /** 设置编辑器为只读
    * @default false
@@ -37,7 +36,6 @@ interface EditorProps extends StandardProps {
   onReady?: CommonEventFunction
 
   /** 编辑器聚焦时触发
-   * event.detail = { html, text, delta }
    * @supported weapp
    */
   onFocus?: CommonEventFunction<EditorProps.editorEventDetail>
@@ -57,12 +55,13 @@ interface EditorProps extends StandardProps {
   /** 通过 Context 方法改变编辑器内样式时触发，返回选区已设置的样式
    * @supported weapp
    */
-  onStatuschange?: CommonEventFunction
+  onStatusChange?: CommonEventFunction
 }
-
 declare namespace EditorProps {
   interface editorEventDetail {
-    html, text, delta
+    html
+    text
+    delta
   }
 }
 
@@ -139,5 +138,4 @@ declare namespace EditorProps {
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/editor.html
  */
 declare const Editor: ComponentType<EditorProps>
-
 export { Editor, EditorProps }

package/types/Form.d.ts

@@ -1,10 +1,9 @@
 import { ComponentType } from 'react'
 import { StandardProps, CommonEventFunction } from './common'
-
 interface FormProps extends StandardProps {
   /** 是否返回 `formId` 用于发送模板消息。
    * @default false
-   * @supported weapp, h5
+   * @supported weapp, alipay, swan, qq, jd, h5
    */
   reportSubmit?: boolean
 
@@ -19,17 +18,34 @@ interface FormProps extends StandardProps {
   reportSubmitTimeout?: number
 
   /** 携带 form 中的数据触发 submit 事件
-   * event.detail = { value : {'name': 'value'} , formId: '' }
-   * @supported weapp, rn, tt
+   * @supported weapp, alipay, swan, tt, qq, jd, rn
    */
   onSubmit?: CommonEventFunction<FormProps.onSubmitEventDetail>
 
   /** 表单重置时会触发 reset 事件
-   * @supported weapp, h5, rn, tt
+   * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
    */
   onReset?: CommonEventFunction
-}
 
+  /** 模板消息的类型，report-submit 为 true 时填写有效
+   * 取值：default / subscribe
+   * @default 'default'
+   * @supported swan
+   */
+  reportType?: string
+
+  /** 发送订阅类模板消息所用的模板库标题 ID ，可通过 getTemplateLibraryList 获取
+   * 当参数类型为 Array 时，可传递 1~3 个模板库标题 ID （注：此处填写模板库id。示例：BD0001）
+   * @supported swan
+   */
+  templateId?: string | Array<string>
+
+  /** 发送订阅类模板消息时所使用的唯一标识符，内容由开发者自定义，用来标识订阅场景
+   * 注意：同一用户在同一 subscribe-id 下的多次授权不累积下发权限，只能下发一条。若要订阅多条，需要不同 subscribe-id
+   * @supported swan
+   */
+  subscribeId?: string
+}
 declare namespace FormProps {
   interface onSubmitEventDetail {
     /** 当点击 `<form>` 表单中 `form-type` 为 `submit` 的 `<button>` 组件时，
@@ -39,6 +55,7 @@ declare namespace FormProps {
     value?: {
       [formItemName: string]: any
     }
+
     /** 当 `reportSubmit` 为 `true` 时，返回 `formId` 用于发送模板消息。
      */
     formId?: string
@@ -107,5 +124,4 @@ declare namespace FormProps {
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/form.html
  */
 declare const Form: ComponentType<FormProps>
-
 export { Form, FormProps }

package/types/FunctionalPageNavigator.d.ts

@@ -1,6 +1,5 @@
 import { ComponentType } from 'react'
 import { StandardProps, CommonEventFunction } from './common'
-
 interface FunctionalPageNavigatorProps extends StandardProps {
   /** 跳转到的小程序版本，有效值 develop（开发版），trial（体验版），release（正式版）；线上版本必须设置为 release
    * @default "release"
@@ -33,23 +32,27 @@ interface FunctionalPageNavigatorProps extends StandardProps {
    */
   onCancel?: CommonEventFunction
 }
-
 declare namespace FunctionalPageNavigatorProps {
   /** version 的合法值 */
   interface Version {
     /** 开发版 */
     develop
+
     /** 体验版 */
     trial
+
     /** 正式版 */
     release
   }
+
   /** name 的合法值 */
   interface Name {
     /** [用户信息功能页](https://developers.weixin.qq.com/miniprogram/dev/framework/plugin/functional-pages/user-info.html) */
     loginAndGetUserInfo
+
     /** [支付功能页](https://developers.weixin.qq.com/miniprogram/dev/framework/plugin/functional-pages/request-payment.html) */
     requestPayment
+
     /** [收货地址功能页](https://developers.weixin.qq.com/miniprogram/dev/framework/plugin/functional-pages/choose-address.html) */
     chooseAddress
   }
@@ -61,5 +64,4 @@ declare namespace FunctionalPageNavigatorProps {
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/functional-page-navigator.html
  */
 declare const FunctionalPageNavigator: ComponentType<FunctionalPageNavigatorProps>
-
 export { FunctionalPageNavigator, FunctionalPageNavigatorProps }

package/types/Icon.d.ts

@@ -1,47 +1,60 @@
 import { ComponentType } from 'react'
 import { StandardProps } from './common'
-
 interface IconProps extends StandardProps {
   /** icon 的类型
-   * @supported weapp, swan, alipay, tt, h5, rn
+   * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
    */
   type: keyof IconProps.TIconType
 
   /** icon 的大小，单位px
    * @default 23
-   * @supported weapp, swan, alipay, tt, h5, rn
+   * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
    */
-  size?: string,
+  size?: string
 
   /** icon 的颜色，同 css 的 color
-   * @supported weapp, swan, alipay, tt, h5, rn
+   * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
    */
   color?: string
-}
 
+  /** 无障碍访问，（属性）元素的额外描述
+   * @supported qq
+   */
+  ariaLabel?: string
+}
 declare namespace IconProps {
   /** icon 的类型 */
   interface TIconType {
     /** 成功图标 */
     success
+
     /** 成功图标（不带外圈） */
     success_no_circle
+
     /** 信息图标 */
     info
+
     /** 警告图标 */
     warn
+
     /** 等待图标 */
     waiting
+
     /** 取消图标 */
     cancel
+
     /** 下载图标 */
     download
+
     /** 搜索图标 */
     search
+
     /** 清除图标 */
     clear
+
     /** 圆环图标(多选控件图标未选择)「微信文档未标注属性」 */
     circle
+
     /** 带圆环的信息图标「微信文档未标注属性」 */
     info_circle
   }
@@ -95,5 +108,4 @@ declare namespace IconProps {
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/icon.html
  */
 declare const Icon: ComponentType<IconProps>
-
 export { Icon, IconProps }