@tarojs/components 3.5.5 → 3.5.6

package/types/Button.d.ts

@@ -1,51 +1,50 @@
 import { ComponentType } from 'react'
 import { StandardProps, CommonEventFunction } from './common'
 import { StyleProp, ViewStyle } from 'react-native'
-
 interface ButtonProps extends StandardProps {
   /** 按钮的大小
-   * @supported weapp, h5, rn, alipay, tt
+   * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
    * @default default
    */
   size?: keyof ButtonProps.Size
 
   /** 按钮的样式类型
-   * @supported weapp, h5, rn, alipay, tt
+   * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
    * @default default
    */
   type?: keyof ButtonProps.Type
 
   /** 按钮是否镂空，背景色透明
-   * @supported weapp, h5, rn, alipay
+   * @supported weapp, alipay, swan, qq, jd, h5, rn
    * @default false
    */
   plain?: boolean
 
   /** 是否禁用
-   * @supported weapp, h5, rn, alipay, tt
+   * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
    * @default false
    */
   disabled?: boolean
 
   /** 名称前是否带 loading 图标
-   * @supported weapp, h5, rn, alipay, tt
+   * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
    * @default false
    */
   loading?: boolean
 
   /** 用于 `<form/>` 组件，点击分别会触发 `<form/>` 组件的 submit/reset 事件
-   * @supported weapp, alipay, tt
+   * @supported weapp, alipay, swan, tt, qq, jd
    */
   formType?: keyof ButtonProps.FormType
 
   /** 微信开放能力
-   * @supported weapp, alipay, qq, tt
+   * @supported weapp, alipay, swan, tt, qq, jd
    */
   openType?: ButtonProps.OpenType
 
   /** 指定按下去的样式类。当 `hover-class="none"` 时，没有点击态效果
    * @default button-hover
-   * @supported weapp, alipay, h5, tt
+   * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
    * @rn 支持 hoverStyle 属性，但框架未支持 hoverClass
    */
   hoverClass?: string
@@ -58,26 +57,26 @@ interface ButtonProps extends StandardProps {
 
   /** 指定是否阻止本节点的祖先节点出现点击态
    * @default false
-   * @supported weapp, alipay, tt
+   * @supported weapp, alipay, swan, tt, qq, jd
    */
   hoverStopPropagation?: boolean
 
   /** 按住后多久出现点击态，单位毫秒
    * @default 20
-   * @supported weapp, alipay, h5, rn, tt
+   * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
    */
   hoverStartTime?: number
 
   /** 手指松开后点击态保留时间，单位毫秒
    * @default 70
-   * @supported weapp, alipay, h5, rn, tt
+   * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
    */
   hoverStayTime?: number
 
   /** 指定返回用户信息的语言，zh_CN 简体中文，zh_TW 繁体中文，en 英文。
    *
    * 生效时机: `open-type="getUserInfo"`
-   * @supported weapp
+   * @supported weapp, qq, jd
    */
   lang?: keyof ButtonProps.Lang
 
@@ -115,21 +114,14 @@ interface ButtonProps extends StandardProps {
   /** 打开 APP 时，向 APP 传递的参数
    *
    * 生效时机：`open-type="launchApp"`
-   * @supported weapp, qq
+   * @supported weapp, qq, jd
    */
   appParameter?: string
 
-  /** 微信小程序子商户能力中，添加 business-id 字段指向子商户
-   *
-   * 生效时机：`open-type="contact"`
-   * @supported weapp
-   */
-  businessId?: string
-
   /** 支付宝小程序 scope
    *
    * 生效时机：`open-type="getAuthorize"`
-   * @supported weapp
+   * @supported alipay
    */
   scope?: 'userInfo' | 'phoneNumber'
 
@@ -143,7 +135,7 @@ interface ButtonProps extends StandardProps {
   /** 用户点击该按钮时，会返回获取到的用户信息，回调的detail数据与 Taro.getUserInfo 返回的一致
    *
    * 生效时机: `open-type="getUserInfo"`
-   * @supported weapp
+   * @supported weapp, swan, qq, jd
    */
   onGetUserInfo?: CommonEventFunction<ButtonProps.onGetUserInfoEventDetail>
 
@@ -157,43 +149,35 @@ interface ButtonProps extends StandardProps {
   /** 客服消息回调
    *
    * 生效时机：`open-type="contact"`
-   * @supported weapp
+   * @supported weapp, swan, qq
    */
   onContact?: CommonEventFunction<ButtonProps.onContactEventDetail>
 
   /** 获取用户手机号回调
    *
    * 生效时机：`open-type="getphonenumber"`
-   * @supported weapp, tt
+   * @supported weapp, swan, tt, jd
    */
   onGetPhoneNumber?: CommonEventFunction<ButtonProps.onGetPhoneNumberEventDetail>
 
-  /** 获取用户实名
-   *
-   * 生效时机：`open-type="getRealnameAuthInfo"`
-   * @deprecated
-   * @supported weapp
-   */
-  onGetRealNameAuthInfo?: CommonEventFunction
-
   /** 当使用开放能力时，发生错误的回调
    *
    * 生效时机：`open-type="launchApp"`
-   * @supported weapp
+   * @supported weapp, alipay, qq, jd
    */
   onError?: CommonEventFunction
 
   /** 在打开授权设置页后回调
    *
    * 生效时机：`open-type="openSetting"`
-   * @supported weapp
+   * @supported weapp, swan, qq, jd
    */
   onOpenSetting?: CommonEventFunction<ButtonProps.onOpenSettingEventDetail>
 
   /** 打开 APP 成功的回调
    *
    * 生效时机：`open-type="launchApp"`
-   * @supported weapp
+   * @supported weapp, qq
    */
   onLaunchApp?: CommonEventFunction
 
@@ -203,34 +187,155 @@ interface ButtonProps extends StandardProps {
    * @supported weapp
    */
   onChooseAvatar?: CommonEventFunction
-}
 
+  /** 点击。
+   * 说明： 每点击一次会触发一次事件，建议自行使用代码防止重复点击,可以使用 js 防抖和节流实现。
+   * @supported alipay
+   */
+  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
+   */
+  onChooseAddress?: CommonEventFunction
+
+  /** 用户点击该按钮时，选择用户的发票抬头，和 swan.chooseInvoiceTitle 一样的。和 open-type 搭配使用，使用时机：open-type="chooseInvoiceTitle"
+   * @supported swan
+   */
+  onChooseInvoiceTitle?: CommonEventFunction
+
+  /** 登录回调，和 open-type 搭配使用，使用时机：open-type="login"。可以通过返回参数的 detail 判断是否登录成功，当 errMsg 为'login:ok'时即为成功。如想获取登录凭证请使用 swan.getLoginCode
+   * @supported swan
+   */
+  onLogin?: CommonEventFunction
+
+  /** 订阅消息授权回调，和 open-type 搭配使用，使用时机：open-type="subscribe"
+   * @supported swan
+   */
+  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
+   */
+  onAddFriend?: CommonEventFunction
+
+  /** 添加群应用的回调。errCode 错误码：41004（当前用户非管理员或群主，无权操作），41005（超过可添加群应用的群数量）
+   * @supported qq
+   */
+  onAddGroupApp?: CommonEventFunction
+}
 declare namespace ButtonProps {
   /** size 的合法值 */
   interface Size {
     /** 默认大小 */
     default
+
     /** 小尺寸 */
     mini
   }
+
   /** type 的合法值 */
   interface Type {
     /** 绿色 */
     primary
+
     /** 白色 */
     default
+
     /** 红色 */
     warn
   }
+
   /** form-type 的合法值 */
   interface FormType {
     /** 提交表单 */
     submit
+
     /** 重置表单 */
     reset
   }
+
   /** 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 {
     weapp: {
@@ -238,44 +343,52 @@ declare namespace ButtonProps {
        * @see https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/customer-message/customer-message.html
        */
       contact
+
       /** 触发用户转发，使用前建议先阅读使用指引
        * @see https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/share.html#%E4%BD%BF%E7%94%A8%E6%8C%87%E5%BC%95
        */
       share
+
       /** 获取用户手机号，可以从回调中获取到用户信息
        * @see https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/getPhoneNumber.html
        */
       getPhoneNumber
+
       /** 获取用户信息，可以从回调中获取到用户信息 */
       getUserInfo
-      /** 用户实名信息授权
-       * @deprecated
-       */
-      getRealNameAuthInfo
+
       /** 打开APP，可以通过 app-parameter 属性设定向APP传的参数
        * @see https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html
        */
       launchApp
+
       /** 打开授权设置页 */
       openSetting
+
       /** 打开“意见反馈”页面，用户可提交反馈内容并上传日志，开发者可以登录小程序管理后台后进入左侧菜单“客服反馈”页面获取到反馈内容 */
       feedback
+
       /** 获取用户头像，可以从回调中获得具体信息 */
       chooseAvatar
     }
+
     /** 支付宝小程序专属的 open-type 合法值
      * @see https://opendocs.alipay.com/mini/component/button
      */
     alipay: {
       /** 触发 自定义分享 */
       share
+
       /** 支持小程序授权 */
       getAuthorize
+
       /** 分享到通讯录好友 */
       contactShare
+
       /** 关注生活号 */
       lifestyle
     }
+
     /** QQ 小程序专属的 open-type 合法值
      * @see https://q.qq.com/wiki/develop/miniprogram/component/form/button.html
      */
@@ -284,65 +397,88 @@ declare namespace ButtonProps {
        * @see https://q.qq.com/wiki/develop/miniprogram/frame/open_ability/open_share.html#%E8%BD%AC%E5%8F%91-2
        */
       share
+
       /** 获取用户信息，可以从 onGetUserInfo 回调中获取到用户信息 */
       getUserInfo
+
       /** 打开APP，可以通过 app-parameter 属性设定向APP传的参数
        * @see https://q.qq.com/wiki/develop/miniprogram/frame/open_ability/open_app.html
        */
       launchApp
+
       /** 打开授权设置页 */
       openSetting
+
       /** 呼起吐个槽反馈页面，开发者可以到官网查看反馈 */
       feedback
+
       /** 呼起群资料卡页面，可以通过 group-id 属性设定需要打开的群资料卡的群号，同时 app.json 中必须配置 groupIdList（数量不超过 10 个），表明可以打开群资料卡的群号 */
       openGroupProfile
+
       /** 添加好友，对方需要通过该小程序进行授权，允许被加好友后才能调用成功[用户授权](https://q.qq.com/wiki/develop/miniprogram/frame/open_ability/open_userinfo.html#%E6%8E%88%E6%9D%83) */
       addFriend
+
       /** 添加彩签，点击后添加状态有用户提示，无回调 */
       addColorSign
+
       /** 打开公众号资料卡，可以通过 public-id 属性设定需要打开的公众号资料卡的号码，同时 app.json 中必须配置 publicIdList（目前只能配置 1 个），表明可以打开的公众号资料卡的号码 */
       openPublicProfile
+
       /** 添加群应用（只有管理员或群主有权操作，建议先调用 qq.getGroupInfo 获取当前用户是否为管理员，如果是管理员才显示该按钮），添加后给button绑定 onAddGroupApp 事件接收回调数据。 */
       addGroupApp
+
       /** 在自定义开放数据域组件中,向指定好友发起分享据 */
       shareMessageToFriend
     }
   }
+
   /** lang 的合法值 */
   interface Lang {
     /** 英文 */
     en
+
     /** 简体中文 */
     zh_CN
+
     /** 繁体中文 */
     zh_TW
   }
-
   interface onGetUserInfoEventDetail {
     userInfo: {
       /** 昵称 */
       nickName: string
+
       /** 头像 */
       avatarUrl: string
+
       /** 性别 */
       gender: keyof Gender
+
       /** 省份，如：`Yunnan` */
       province: string
+
       /** 城市，如：`Dalian` */
       city: string
+
       /** 国家，如：`China` */
       country: string
     }
+
     /** 不包括敏感信息的原始数据 `JSON` 字符串，用于计算签名 */
     rawData: string
+
     /** 使用 `sha1(rawData + sessionkey)` 得到字符串，用于校验用户信息 */
     signature: string
+
     /** 包括敏感数据在内的完整用户信息的加密数据 */
     encryptedData: string
+
     /** 加密算法的初始向量 */
     iv: string
+
     /* 用户信息的调用状态 */
     errMsg: string
+
     /** 敏感数据对应的云 ID，开通[云开发](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/basis/getting-started.html)的小程序才会返回，可通过云调用直接获取开放数据，详细见[云调用直接获取开放数据](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/signature.html#method-cloud) */
     cloudID?: string
   }
@@ -351,37 +487,42 @@ declare namespace ButtonProps {
   interface Gender {
     /** 未知 */
     0
+
     /** 男 */
     1
+
     /** 女 */
     2
   }
-
   interface onContactEventDetail {
     /* 小程序消息的调用状态 */
     errMsg: string
+
     /** 小程序消息指定的路径 */
     path: string
+
     /** 小程序消息指定的查询参数 */
     query: Record<string, any>
   }
-
   interface onGetPhoneNumberEventDetail {
     /* 获取用户手机号的调用状态 */
     errMsg: string
+
     /** 包括敏感数据在内的完整用户信息的加密数据 */
     encryptedData: string
+
     /** 加密算法的初始向量 */
     iv: string
+
     /** 动态令牌。可通过动态令牌换取用户手机号。
      * @see https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/share.html#%E4%BD%BF%E7%94%A8%E6%8C%87%E5%BC%95
      */
     code?: string
   }
-
   interface onOpenSettingEventDetail {
     /* 打开授权设置页的调用状态 */
     errMsg: string
+
     /* 用户授权结果 */
     authSetting: Record<string, boolean>
   }
@@ -539,5 +680,4 @@ declare namespace ButtonProps {
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/button.html
  */
 declare const Button: ComponentType<ButtonProps>
-
 export { Button, ButtonProps }

package/types/Camera.d.ts

@@ -1,10 +1,9 @@
 import { ComponentType } from 'react'
 import { StandardProps, CommonEventFunction } from './common'
-
 interface CameraProps extends StandardProps {
   /** 模式，有效值为normal, scanCode
    * @default "normal"
-   * @supported weapp, rn, tt
+   * @supported weapp, tt, qq, jd, rn
    */
   mode?: keyof CameraProps.Mode
 
@@ -16,13 +15,13 @@ interface CameraProps extends StandardProps {
 
   /** 摄像头朝向
    * @default "back"
-   * @supported weapp, rn, tt
+   * @supported weapp, swan, tt, qq, jd, rn
    */
   devicePosition?: keyof CameraProps.DevicePosition
 
   /** 闪光灯
    * @default "auto"
-   * @supported weapp, rn, tt
+   * @supported weapp, swan, tt, qq, jd, rn
    */
   flash?: keyof CameraProps.Flash
 
@@ -32,81 +31,85 @@ interface CameraProps extends StandardProps {
    */
   frameSize?: keyof CameraProps.FrameSize
 
-  /** 扫码识别区域，格式为[x, y, w, h]，
-   * x,y是相对于camera显示区域的左上角，
-   * w,h为区域宽度，单位px，仅在 mode="scanCode" 时生效
-   * @supported weapp
-   */
-  scanArea?: number[]
-
   /** 摄像头在非正常终止时触发，
    * 如退出后台等情况
-   * @supported weapp, rn, tt
+   * @supported weapp, swan, tt, qq, jd, rn
    */
   onStop?: CommonEventFunction
 
   /** 用户不允许使用摄像头时触发
-   * @supported weapp, rn, tt
+   * @supported weapp, swan, tt, qq, jd, rn
    */
   onError?: CommonEventFunction
 
   /** 相机初始化完成时触发
-   * @supported weapp, rn, tt
+   * @supported weapp, tt, rn
    */
   onInitDone?: CommonEventFunction<CameraProps.onInitDoneEventDetail>
 
   /** 在成功识别到一维码时触发，
    * 仅在 mode="scanCode" 时生效
-   * @supported weapp, rn, tt
+   * @supported weapp, tt, qq, rn
    */
   onScanCode?: CommonEventFunction
 }
-
 declare namespace CameraProps {
   /** mode 的合法值 */
   interface Mode {
     /** 相机模式 */
     normal
+
     /** 扫码模式 */
     scanCode
   }
+
   /** resolution 的合法值 */
   interface Resolution {
     /** 低 */
     low
+
     /** 中 */
     medium
+
     /** 高 */
     high
   }
+
   /** device-position 的合法值 */
   interface DevicePosition {
     /** 前置 */
     front
+
     /** 后置 */
     back
   }
+
   /** flash 的合法值 */
   interface Flash {
     /** 自动 */
     auto
+
     /** 打开 */
     on
+
     /** 关闭 */
     off
+
     /** 常亮 */
     torch
   }
+
   /** frame-size 的合法值 */
   interface FrameSize {
     /** 小尺寸帧数据 */
     small
+
     /** 中尺寸帧数据 */
     medium
+
     /** 大尺寸帧数据 */
     large
   }
-
   interface onInitDoneEventDetail {
     /** 最大变焦 */
     maxZoom: number
@@ -119,5 +122,4 @@ declare namespace CameraProps {
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/camera.html
  */
 declare const Camera: ComponentType<CameraProps>
-
 export { Camera, CameraProps }