@tarojs/components 3.6.2-canary.1 → 3.6.2-canary.2

package/types/Canvas.d.ts

@@ -5,74 +5,60 @@ interface CanvasProps extends StandardProps<any, CanvasTouchEvent> {
    * @supported weapp, alipay, tt
    */
   type?: string
-
   /** canvas 组件的唯一标识符，若指定了 type 则无需再指定该属性
-   * @supported weapp, swan, tt, qq, jd
+   * @supported weapp, swan, tt, qq, jd, h5
    */
   canvasId?: string
-
   /** 当在 canvas 中移动时且有绑定手势事件时，禁止屏幕滚动以及下拉刷新
    * @default false
    * @supported weapp, alipay, swan, qq, jd
    */
   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
    */
   onTouchStart?: CanvasTouchEventFunction
-
   /** 手指触摸后移动
    * @supported weapp, alipay, swan, tt, qq, jd
    */
   onTouchMove?: CanvasTouchEventFunction
-
   /** 手指触摸动作结束
    * @supported weapp, alipay, swan, tt, qq, jd
    */
   onTouchEnd?: CanvasTouchEventFunction
-
   /** 手指触摸动作被打断，如来电提醒，弹窗
    * @supported weapp, alipay, swan, tt, qq, jd
    */
   onTouchCancel?: CanvasTouchEventFunction
-
   /** 手指长按 500ms 之后触发，触发了长按事件后进行移动不会触发屏幕的滚动
-   * @supported weapp, alipay, swan, qq, jd
+   * @supported weapp, alipay, swan, qq, jd, h5
    */
   onLongTap?: CommonEventFunction
-
   /** 当发生错误时触发 error 事件，detail = {errMsg: 'something wrong'}
    * @supported weapp, swan, qq, jd
    */
   onError?: CommonEventFunction<CanvasProps.onErrorEventDetail>
-
   /** 点击。
    * @supported alipay
    */
   onTap?: CommonEventFunction
-
   /** canvas 组件初始化成功触发。
    * @supported alipay
    */
@@ -83,7 +69,6 @@ declare namespace CanvasProps {
     errMsg: string
   }
 }
-
 /** 画布
  *
  * `<Canvas />` 组件的 RN 版本尚未实现。

package/types/ChannelLive.d.ts

@@ -5,13 +5,11 @@ interface ChannelLiveProps extends StandardProps {
    * @supported weapp
    */
   feedId: string
-
   /** 视频号 id，以“sph”开头的id，可在视频号助手获取。视频号必须与当前小程序相同主体。
    * @supported weapp
    */
   finderUserName: string
 }
-
 /**
  * 小程序内嵌视频号直播组件，展示视频号直播状态和封面，并无弹窗跳转至视频号。注意：使用该组件打开的视频号视频需要与小程序的主体一致。
  * @classification media

package/types/ChannelVideo.d.ts

@@ -5,7 +5,6 @@ interface ChannelVideoProps extends StandardProps {
    * @supported weapp
    */
   feedId: string
-
   /** 视频号 id，以“sph”开头的id，可在视频号助手获取。视频号必须与当前小程序相同主体。
    * @supported weapp
    */
@@ -15,31 +14,26 @@ interface ChannelVideoProps extends StandardProps {
    * @default false
    */
   loop?: boolean
-
   /** 是否静音播放
    * @supported weapp
    * @default false
    */
   muted?: boolean
-
   /** 当视频大小与 video 容器大小不一致时，视频的表现形式
    * @supported weapp
    * @default "contain"
    */
   objectFit?: 'fill' | 'contain' | 'cover'
-
   /** 是否自动播放
    * @supported weapp
    * @default false
    */
   autoplay?: boolean
-
   /** 视频播放出错时触发
    * @supported weapp
    */
   onError?: CommonEventFunction
 }
-
 /**
  * 小程序内嵌视频号视频组件，支持在小程序中播放视频号视频，并无弹窗跳转至视频号。注意：使用该组件打开的视频号视频需要与小程序相同主体或关联主体。
  * @classification media

package/types/Checkbox.d.ts

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

package/types/CheckboxGroup.d.ts

@@ -5,7 +5,6 @@ interface CheckboxGroupProps extends StandardProps, FormItemProps {
    * @supported alipay, tt, h5
    */
   name?: string
-
   /** `<CheckboxGroup/>` 中选中项发生改变是触发 change 事件
    * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
    */
@@ -13,7 +12,6 @@ interface CheckboxGroupProps extends StandardProps, FormItemProps {
     value: string[]
   }>
 }
-
 /** 多项选择器，内部由多个checkbox组成
  * @classification forms
  * @supported weapp, alipay, swan, tt, qq, jd, h5, rn, harmony

package/types/CommentDetail.d.ts

@@ -5,46 +5,43 @@ interface CommentDetailProps extends StandardProps {
    * @supported swan
    */
   commentParam: CommentDetailProps.ICommentParam
-
   /** 评论 ID
    * @supported swan
    */
   srid: string
-
   /** 滚动方式为页面滚动，若组件作为浮层使用，该参数需设为 false
    * @supported swan
    * @default true
    */
   isPageScroll?: boolean
-
   /** 是否需要底部 toolbar，若使用开发者自定义的底部 toolbar，该参数需设为 false
    * @supported swan
    * @default true
    */
   needToolbar?: boolean
-
   /** 是否需要详情顶部父级评论的点赞按钮，默认显示
    * @supported swan
    * @default true
    */
   needLikeBtn?: boolean
-
   /** 删除详情后是否返回列表项，默认一站式逻辑。若使用浮层，请设置改属性为 false
    * @supported swan
    * @default true
    */
   backListAfterDelete?: boolean
-
   /** 用于调起评论发布器发布评论
    * @supported swan
    * @default false
    */
   addComment?: boolean
-
   /** 删除整体详情内容时触发，返回数据为{status, data:{srid}}
    * @supported swan
    */
   onDelete?: CommonEventFunction
+  /** 评论发布成功时触发，返回数据为 {status, data:{srid}}
+   * @supported swan
+   */
+  onReply?: CommonEventFunction
 }
 namespace CommentDetailProps {
   interface ICommentParam {
@@ -52,17 +49,14 @@ namespace CommentDetailProps {
      * @example "20200101"
      */
     snid: string
-
     /** 文章标题 */
     title: string
-
     /** 智能小程序内页链接，最长不能超过 194 字符
      * @example "/pages/index/index"
      */
     path: string
   }
 }
-
 /** 评论详情
  * @classification open
  * @supported swan

package/types/CommentList.d.ts

@@ -5,66 +5,59 @@ interface CommentListProps extends StandardProps {
    * @supported swan
    */
   commentParam: CommentListProps.ICommentParam
-
   /** 底部 toolbar 的相关配置
    * @supported swan
    */
   toolbarConfig?: CommentListProps.IToolbarConfig
-
   /** 滚动方式为页面滚动，若组件作为浮层使用，该参数需设为 false
    * @supported swan
    * @default true
    */
   isPageScroll?: boolean
-
   /** 是否需要底部 toolbar ，若使用开发者自定义的底部 toolbar ，该参数需设为 false
    * @supported swan
    * @default true
    */
   needToolbar?: boolean
-
   /** 用于调起评论发布器发布评论，发布成功插入列表第一条，且滚动到列表顶部
    * @supported swan
    * @default false
    */
   addComment?: boolean
-
   /** 点击单条评论跳转的详情页页面 path ，若没有配置则不会发生跳转；配置的前提是列表与详情均是页面级
    * @supported swan
    */
   detailPath?: string
-
   /** 是否折叠列表，默认全展示
    * @supported swan
    * @default false
    */
   isFolded?: boolean
-
   /** 折叠后列表展示最大条数，默认 3 条，最多 10 条
    * @supported swan
    * @default 3
    */
   foldNum?: number
-
   /** 传入放置评论组件的页面路径，如'/pages/list/index'，组件内部会触发跳转逻辑
    * @supported swan
    */
   viewMorePath?: string
-
   /** 『全部 xx 条』的样式，目前只支持开发者自定义字体颜色
    * @supported swan
    */
   viewMoreStyle?: CommentListProps.IViewMoreStyle
-
   /** 绑定点击单条评论的事件，点击单条评论时触发，返回数据为{status, data:{srid}}
    * @supported swan
    */
   onClickComment?: CommonEventFunction
-
   /** 绑定点击更多事件，若除了页面跳转还需要其他操作，可通过该回调执行；若为浮层，也可使用该回调自定义交互逻辑
    * @supported swan
    */
   onViewMore?: CommonEventFunction
+  /** 评论发布成功时触发，返回数据为 {status, data:{srid}}
+   * @supported swan
+   */
+  onReply?: CommonEventFunction
 }
 namespace CommentListProps {
   interface ICommentParam {
@@ -72,15 +65,12 @@ namespace CommentListProps {
      * @example "20200101"
      */
     snid: string
-
     /** 文章标题 */
     title: string
-
     /** 智能小程序内页链接，最长不能超过 194 字符
      * @example "/pages/index/index"
      */
     path: string
-
     /** 数组第一项用于收藏功能的展示图片
      * @default ['https://b.bdstatic.com/miniapp/images/demo-dog.png']
      */
@@ -89,25 +79,20 @@ namespace CommentListProps {
   interface IToolbarConfig {
     /** 输入框提示文字 */
     placeholder?: string
-
     /** 显示的互动模块，对应默认值分别是：评论数、点赞、收藏、分享
      * @default ['comment', 'like', 'favor', 'share']
      */
     moduleList?: string
-
     /** 若 moduleList 里配置了 share 模块，该参数为必填 */
     share?: IShare
   }
   interface IShare {
     /** 分享标题 */
     title: string
-
     /** 分享内容 */
     content?: string
-
     /** 分享图标 */
     imageUrl?: string
-
     /** 页面 path ，必须是以 / 开头的完整路径，如果 path 中参数包含中文字符，需对中文字符进行编码 */
     path?: string
   }
@@ -118,7 +103,6 @@ namespace CommentListProps {
     color?: string
   }
 }
-
 /** 评论列表
  * @classification open
  * @supported swan

package/types/ContactButton.d.ts

@@ -5,35 +5,29 @@ interface ContactButtonProps extends StandardProps {
    * @supported alipay
    */
   tntInstId: string
-
   /** 必填。聊天窗编码，每个聊天窗的唯一编码。
    * @supported alipay
    */
   scene: string
-
   /** 选填。咨询按钮大小，正方形设置边长（如25*25 px）。
    * @supported alipay
    * @default 25
    */
   size?: number | string
-
   /** 选填。咨询按钮颜色，默认白底蓝色。
    * @supported alipay
    * @default "#00A3FF"
    */
   color?: string
-
   /** 选填。咨询按钮头像。
    * @supported alipay
    */
   icon?: string
-
   /** 选填。支付宝访客用户ID（2088开头）。
    * 说明： 客服回答问题时，如客户已离开咨询窗口，则通过推送消息到支付宝 card 中提醒客户。
    * @supported alipay
    */
   alipayCardNo?: string
-
   /** 选填。该属性主要用于传递一些扩展信息给组件，以实现一些高级功能。该属性值的生成方式为：encodeURIComponent({"字段名":"字段值"})， 其中，字段名和字段值要根据实际使用的功能进行替换。
    * 目前通过传入扩展信息可支持的 3 个功能：
    * 1.访客名片。需传 cinfo 和 key 两个扩展字段，代码形如在云客服中进入 设置 > 服务窗配置 > 聊天窗 URL。点击操作栏中的 聊天窗 URL ，获取 tntInstId（企业编码）和 scene（聊天窗编码）。encodeURIComponent({"cinfo":"生成的 cinfo","key":"生成的key"})，cinfo 和 key 的值说明 支付宝小程序接入访客名片；
@@ -43,7 +37,6 @@ interface ContactButtonProps extends StandardProps {
    */
   extInfo?: string
 }
-
 /** 智能客服
  * @classification open
  * @supported alipay

package/types/CoverImage.d.ts

@@ -5,58 +5,47 @@ interface CoverImageProps extends StandardProps {
    * @supported weapp, alipay, swan, qq, jd, h5
    */
   src: string
-
   /** 格式固定为 https://servicewechat.com/{appid}/{version}/page-frame.html，其中 {appid} 为小程序的 appid，{version} 为小程序的版本号，版本号为 0 表示为开发版、体验版以及审核版本，版本号为 devtools 表示为开发者工具，其余为正式版本；
    * @supported weapp
    */
   referrerPolicy?: 'origin' | 'no-referrer'
-
   /** 设置与容器顶部的固定距离，效果相当于在 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
-
   /** 图片加载成功时触发
    * @supported weapp, swan, qq, jd, h5
    */
   onLoad?: CommonEventFunction
-
   /** 图片加载失败时触发
    * @supported weapp, swan, qq, jd, h5
    */
   onError?: CommonEventFunction
-
   /** 点击事件回调。
    * @supported alipay
    */
   onTap?: CommonEventFunction
 }
-
 /** 覆盖在原生组件之上的图片视图。可覆盖的原生组件同cover-view，支持嵌套在cover-view里。
  * @classification viewContainer
  * @supported weapp, alipay, swan, qq, jd, h5, harmony

package/types/CoverView.d.ts

@@ -6,141 +6,115 @@ interface CoverViewProps extends ViewProps {
    * @supported weapp, alipay, swan, qq, jd
    */
   scrollTop?: number
-
   /** 设置与容器顶部的固定距离，效果相当于在 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
-
   /** 允许横向滚动。
    * @supported alipay
    * @default false
    */
   scrollX?: boolean
-
   /** 允许纵向滚动。
    * @supported alipay
    * @default false
    */
   scrollY?: boolean
-
   /** 距顶部/左边多远时（单位px），触发 scrolltoupper 事件。
    * @supported alipay
    * @default 50
    */
   upperThreshold?: number
-
   /** 距底部/右边多远时（单位px），触发 scrolltolower 事件。
    * @supported alipay
    * @default 50
    */
   lowerThreshold?: number
-
   /** 设置横向滚动条位置。
    * @supported alipay
    */
   scrollLeft?: number
-
   /** 滚动到子元素，值应为某子元素的 id。当滚动到该元素时，元素顶部对齐滚动区域顶部。
    * 说明：scroll-into-view 的优先级高于 scroll-top。
    * @supported alipay
    */
   scrollIntoView?: string
-
   /** 在设置滚动条位置时使用动画过渡。
    * @supported alipay
    * @default false
    */
   scrollWithAnimation?: boolean
-
   /** 当 scroll-with-animation设置为 true 时，可以设置 scroll-animation-duration 来控制动画的执行时间，单位 ms。
    * @supported alipay
    */
   scrollAnimationDuration?: number
-
   /** 当点击 iOS 顶部状态栏或者双击 Android 标题栏时，滚动条返回顶部，只支持竖向。
    * @supported alipay
    * @default false
    */
   enableBackToTop?: boolean
-
   /** 纵向滚动时，当滚动到顶部或底部时，强制禁止触发页面滚动，仍然只触发 scroll-view 自身的滚动。
    * @supported alipay
    * @default false
    */
   trapScroll?: boolean
-
   /** 发生滚动前，对滚动方向进行判断，当方向是顶部/左边时，如果值为 always 将始终禁止滚动，如果值为 out-of-bounds 且当前已经滚动到顶部/左边，禁止滚动。
    * @supported alipay
    */
   disableLowerScroll?: string
-
   /** 发生滚动前，对滚动方向进行判断，当方向是底部/右边时，如果值为 always 将始终禁止滚动，如果值为 out-of-bounds 且当前已经滚动到底部/右边，禁止滚动。
    * @supported alipay
    */
   disableUpperScroll?: string
-
   /** 滚动到顶部/左边，会触发 scrolltoupper 事件。
    * @supported alipay
    */
   onScrollToUpper?: CommonEventFunction
-
   /** 滚动到底部/右边，会触发 scrolltolower事件。
    * @supported alipay
    */
   onScrollToLower?: CommonEventFunction
-
   /** 滚动时触发，event.detail = {scrollLeft, scrollTop, scrollHeight, scrollWidth}。
    * @supported alipay
    */
   onScroll?: CommonEventFunction
-
   /** 触摸动作开始。
    * @supported alipay
    */
   onTouchStart?: CommonEventFunction
-
   /** 触摸后移动。
    * @supported alipay
    */
   onTouchMove?: CommonEventFunction
-
   /** 触摸动作结束。
    * @supported alipay
    */
   onTouchEnd?: CommonEventFunction
-
   /** 触摸动作被打断，如来电提醒、弹窗。
    * @supported alipay
    */
   onTouchCancel?: CommonEventFunction
 }
-
 /** 覆盖在原生组件之上的文本视图。可覆盖的原生组件包括 map、video、canvas、camera、live-player、live-pusher 只支持嵌套 cover-view、cover-image，可在 cover-view 中使用 button。
  * @classification viewContainer
  * @supported weapp, alipay, swan, qq, jd, h5