@tarojs/components 3.5.7 → 3.5.9

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,11 +258,6 @@ 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 表示发生未知错误；
@@ -209,18 +268,6 @@ interface ButtonProps extends StandardProps {
     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
    */
@@ -241,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
    */
@@ -330,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 {
@@ -529,7 +526,7 @@ declare namespace ButtonProps {
 
 /** 按钮
  * @classification forms
- * @supported weapp, h5, rn, tt
+ * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
  * @example_react
  * ```tsx
  * export default class PageButton extends Component {

package/types/Camera.d.ts

@@ -3,48 +3,48 @@ import { StandardProps, CommonEventFunction } from './common'
 interface CameraProps extends StandardProps {
   /** 模式，有效值为normal, scanCode
    * @default "normal"
-   * @supported weapp, tt, qq, jd, rn, alipay
+   * @supported weapp, alipay, tt, qq, jd, rn
    */
   mode?: keyof CameraProps.Mode
 
   /** 分辨率，不支持动态修改
    * @default "medium"
-   * @supported weapp, tt, alipay
+   * @supported weapp, tt
    */
   resolution?: keyof CameraProps.Resolution
 
   /** 摄像头朝向
    * @default "back"
-   * @supported weapp, swan, tt, qq, jd, rn, alipay
+   * @supported weapp, alipay, swan, tt, qq, jd, rn
    */
   devicePosition?: keyof CameraProps.DevicePosition
 
   /** 闪光灯
    * @default "auto"
-   * @supported weapp, swan, tt, qq, jd, rn, alipay
+   * @supported weapp, alipay, swan, tt, qq, jd, rn
    */
   flash?: keyof CameraProps.Flash
 
-  /** 相机拍照，录制的分辨率。有效值为 360P、540P、720P、1080P、max
-   * @default "720P"
-   * @supported alipay
-   */
-  outputDimension?: '360P'|'540P'|'720P'|'1080P'|'max'
-
   /** 指定期望的相机帧数据尺寸
    * @default "medium"
-   * @supported weapp, tt, alipay
+   * @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, alipay
+   * @supported weapp, alipay, swan, tt, qq, jd, rn
    */
   onStop?: CommonEventFunction
 
   /** 用户不允许使用摄像头时触发
-   * @supported weapp, swan, tt, qq, jd, rn, alipay
+   * @supported weapp, alipay, swan, tt, qq, jd, rn
    */
   onError?: CommonEventFunction
 
@@ -53,14 +53,14 @@ interface CameraProps extends StandardProps {
    */
   onInitDone?: CommonEventFunction<CameraProps.onInitDoneEventDetail>
 
-  /** 相机初始化完成时触发
+  /** 相机初始化成功时触发。
    * @supported alipay
    */
   onReady?: CommonEventFunction<CameraProps.onInitDoneEventDetail>
 
   /** 在成功识别到一维码时触发，
    * 仅在 mode="scanCode" 时生效
-   * @supported weapp, tt, qq, rn, alipay
+   * @supported weapp, alipay, tt, qq, rn
    */
   onScanCode?: CommonEventFunction<CameraProps.onScanCodeEventDetail>
 }
@@ -125,7 +125,6 @@ declare namespace CameraProps {
     /** 最大变焦 */
     maxZoom: number
   }
-
   interface onScanCodeEventDetail {
     /** 字符集 */
     charSet: string
@@ -150,7 +149,7 @@ declare namespace CameraProps {
 
 /** 系统相机
  * @classification media
- * @supported weapp, rn, tt
+ * @supported weapp, alipay, swan, tt, qq, jd, rn
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/camera.html
  */
 declare const Camera: ComponentType<CameraProps>

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,27 +68,6 @@ 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
-   */
-  width?: string
-
-  /**
-   * @supported alipay
-   */
-  height?: string
-
   /** 点击。
    * @supported alipay
    */
@@ -93,7 +88,7 @@ declare namespace CanvasProps {
  *
  * `<Canvas />` 组件的 RN 版本尚未实现。
  * @classification canvas
- * @supported weapp, tt
+ * @supported weapp, alipay, swan, tt, qq, jd, h5
  * @example_react
  * ```tsx
  * class App extends Components {

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,11 +32,18 @@ interface CheckboxProps extends StandardProps {
    * @supported qq
    */
   ariaLabel?: string
+
+  /** 选中项发生变化时触发 change 事件，小程序无此 API
+   * @supported alipay, h5, rn
+   */
+  onChange?: CommonEventFunction<{
+    value: string[]
+  }>
 }
 
 /** 多选项目
  * @classification forms
- * @supported weapp, h5, rn
+ * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
  * @example_react
  * ```tsx
  * export default class PageCheckbox extends Component {

package/types/CheckboxGroup.d.ts

@@ -16,7 +16,7 @@ interface CheckboxGroupProps extends StandardProps, FormItemProps {
 
 /** 多项选择器，内部由多个checkbox组成
  * @classification forms
- * @supported weapp, h5, rn, tt
+ * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
  * @example
  * ```tsx
  * export default class PageCheckbox extends Component {

package/types/CommentDetail.d.ts

@@ -0,0 +1,72 @@
+import { ComponentType } from 'react'
+import { StandardProps } from './common'
+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
+}
+namespace CommentDetailProps {
+  interface ICommentParam {
+    /** 被点赞的文章的 id，与 path 参数一一对应
+     * @example "20200101"
+     */
+    snid: string
+
+    /** 文章标题 */
+    title: string
+
+    /** 智能小程序内页链接，最长不能超过 194 字符
+     * @example "/pages/index/index"
+     */
+    path: string
+  }
+}
+
+/** 评论详情
+ * @classification open
+ * @supported swan
+ * @see https://smartprogram.baidu.com/docs/develop/extended/component-content/comment-detail/
+ */
+declare const CommentDetail: ComponentType<CommentDetailProps>
+export { CommentDetail, CommentDetailProps }

package/types/CommentList.d.ts

@@ -0,0 +1,128 @@
+import { ComponentType } from 'react'
+import { StandardProps } from './common'
+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
+}
+namespace CommentListProps {
+  interface ICommentParam {
+    /** 被点赞的文章的 id，与 path 参数一一对应
+     * @example "20200101"
+     */
+    snid: string
+
+    /** 文章标题 */
+    title: string
+
+    /** 智能小程序内页链接，最长不能超过 194 字符
+     * @example "/pages/index/index"
+     */
+    path: string
+
+    /** 数组第一项用于收藏功能的展示图片
+     * @default ['https://b.bdstatic.com/miniapp/images/demo-dog.png']
+     */
+    images?: string[]
+  }
+  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
+  }
+  interface IViewMoreStyle {
+    /** 『全部 xx 条』的字体颜色，默认为视觉提供色号，开发者可传入自定义色号
+     * @default "#3388ff"
+     */
+    color?: string
+  }
+}
+
+/** 评论列表
+ * @classification open
+ * @supported swan
+ * @see https://smartprogram.baidu.com/docs/develop/extended/component-content/comment-list/
+ */
+declare const CommentList: ComponentType<CommentListProps>
+export { CommentList, CommentListProps }

package/types/ContactButton.d.ts

@@ -0,0 +1,53 @@
+import { ComponentType } from 'react'
+import { StandardProps } from './common'
+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 的值说明 支付宝小程序接入访客名片；
+   * 2.聊天窗默认带出用户的小程序订单数据。需传 appId 字段，代码形如encodeURIComponent({"appId":"商户小程序appid"})
+   * 3.未读客服消息同步至"我的小程序-我的"。同样需传 appId 字段，代码形如 encodeURIComponent({"appId":"商户小程序appid"})。
+   * @supported alipay
+   */
+  extInfo?: string
+}
+
+/** 智能客服
+ * @classification open
+ * @supported alipay
+ * @see https://opendocs.alipay.com/mini/component/contact-button
+ */
+declare const ContactButton: ComponentType<ContactButtonProps>
+export { ContactButton, ContactButtonProps }