@tarojs/components 3.6.0-canary.1 → 3.6.0-canary.11

package/types/CoverView.d.ts

@@ -3,7 +3,7 @@ import { CommonEventFunction } from './common'
 import { ViewProps } from './View'
 interface CoverViewProps extends ViewProps {
   /** 设置顶部滚动偏移量，仅在设置了 overflow-y: scroll 成为滚动元素后生效
-   * @supported weapp, swan, qq
+   * @supported weapp, alipay, swan, qq
    */
   scrollTop?: number
 
@@ -37,15 +37,113 @@ interface CoverViewProps extends ViewProps {
    */
   ariaLabel?: string
 
-  /** 点击事件回调。
+  /** 允许横向滚动。
    * @supported alipay
+   * @default false
    */
-  onTap?: CommonEventFunction
+  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, swan, alipay, h5
+ * @supported weapp, alipay, swan, qq, h5
  * @example_react
  * ```tsx
  * // js

package/types/CustomWrapper.d.ts

@@ -6,7 +6,8 @@ interface CustomWrapperProps extends StandardProps {
 
 /** custom-wrapper 自定义组件包裹器
  * 当数据更新层级较深时，可用此组件将需要更新的区域包裹起来，这样更新层级将大大减少
- * @supported weapp, swan, alipay, tt, jd, qq
+ * @classification viewContainer
+ * @supported weapp, swan, alipay, tt, jd, qq, h5
  * @example
  * ```tsx
  * import { Component } from 'react'

package/types/FollowSwan.d.ts

@@ -0,0 +1,28 @@
+import { ComponentType } from 'react'
+import { StandardProps } from './common'
+interface FollowSwanProps extends StandardProps {
+  /** 组件大小
+   * @supported swan
+   * @default "default"
+   */
+  size?: string
+
+  /** 组件样式
+   * @supported swan
+   * @default "primary"
+   */
+  type?: string
+
+  /** 关注和取消关注成功的回调，返回关注状态 {isFavor: true|false}
+   * @supported swan
+   */
+  onFavorStatusChange?: CommonEventFunction
+}
+
+/** 关注小程序
+ * @classification open
+ * @supported swan
+ * @see https://smartprogram.baidu.com/docs/develop/extended/component-content/follow-swan/
+ */
+declare const FollowSwan: ComponentType<FollowSwanProps>
+export { FollowSwan, FollowSwanProps }

package/types/Form.d.ts

@@ -66,7 +66,7 @@ declare namespace FormProps {
  *
  * 当点击 form 表单中 form-type 为 submit 的 button 组件时，会将表单组件中的 value 值进行提交，需要在表单组件中加上 name 来作为 key。
  * @classification forms
- * @supported weapp, h5, rn
+ * @supported weapp, alipay, swan, tt, qq, jd, h5, rn, harmony
  * @example_react
  * ```tsx
  * class App extends Component {

package/types/Icon.d.ts

@@ -62,7 +62,7 @@ declare namespace IconProps {
 
 /** 图标。组件属性的长度单位默认为 px
  * @classification base
- * @supported weapp, swan, alipay, tt, h5, rn
+ * @supported weapp, alipay, swan, tt, qq, jd, h5, rn, harmony
  * @example_react
  * ```tsx
  * export default class PageView extends Component {

package/types/Image.d.ts

@@ -155,7 +155,7 @@ declare namespace ImageProps {
  *
  * **Note:** 为实现小程序的 `mode` 特性，在 H5 组件中使用一个 `div` 容器来对内部的 `img` 进行展示区域的裁剪，因此请勿使用元素选择器来重置 `img` 的样式！
  * @classification media
- * @supported weapp, h5, rn, swan, alipay, tt
+ * @supported weapp, alipay, swan, tt, qq, jd, h5, rn, harmony
  * @example_react
  * ```tsx
  * export default class PageView extends Component {

package/types/InlinePaymentPanel.d.ts

@@ -0,0 +1,58 @@
+import { ComponentType } from 'react'
+import { StandardProps } from './common'
+interface InlinePaymentPanelProps extends StandardProps {
+  /** 总金额，金额单位分，tip：仅支持整数型字符串
+   * @supported swan
+   */
+  totalAmount?: string
+
+  /** 百度收银台的财务结算凭证，详见平台术语
+   * @supported swan
+   */
+  dealId?: string
+
+  /** 支付能力开通后分配的支付 appKey，详见平台术语
+   * @supported swan
+   */
+  appKey?: string
+
+  /** 平台营销信息，此处传当前订单中可使用平台券的 spuid，同时需在 支付能力中搭配使用传入该参数；注：仅与百度合作平台类目券的开发者需要填写该参数
+   * @supported swan
+   */
+  promotionTag?: string | Array<string>
+
+  /** 是否设置挽留弹窗
+   * @supported swan
+   * @default false
+   */
+  enablePageBackModal?: boolean
+
+  /** 自定义样式设置
+   * @supported swan
+   */
+  customStyle?: string
+
+  /** 自定义样式档位配置，各档位配置项包括支付渠道/优惠券条高度、渠道图标大小、支付渠道文案字体大小、营销文案字体大小、选择器图标大小
+   * @supported swan
+   * @default "default"
+   */
+  styleType?: 'tiny' | 'small' | 'default' | 'medium' | 'large'
+
+  /** 获取支付相关信息，具体信息在返回值的 detail 字段中
+   * @supported swan
+   */
+  onGetPaymentInfo?: CommonEventFunction
+
+  /** 当发生错误时触发 error 事件，具体信息在返回值的 detail 字段中，例如 {detail: {errMsg: "something is wrong"}}
+   * @supported swan
+   */
+  onError?: CommonEventFunction
+}
+
+/** 内嵌支付组件
+ * @classification open
+ * @supported swan
+ * @see https://smartprogram.baidu.com/docs/develop/component/inline_payment_panel/
+ */
+declare const InlinePaymentPanel: ComponentType<InlinePaymentPanelProps>
+export { InlinePaymentPanel, InlinePaymentPanelProps }

package/types/Input.d.ts

@@ -9,11 +9,11 @@ interface InputProps extends StandardProps, FormItemProps {
   /** input 的类型
    * @default "text"
    * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
-   * @rn 部分支持
    */
-  type?: 'text' | 'number' | 'idcard' | 'digit' | 'safe-password' | 'nickname'
+  type?: keyof InputProps.Type
 
   /** 是否是密码类型
+   * @default false
    * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
    */
   password?: boolean
@@ -30,7 +30,7 @@ interface InputProps extends StandardProps, FormItemProps {
 
   /** 指定 placeholder 的样式类
    * @default "input-placeholder"
-   * @supported weapp, alipay, swan, qq, jd
+   * @supported weapp, alipay, swan, tt, qq, jd
    */
   placeholderClass?: string
 
@@ -40,6 +40,7 @@ interface InputProps extends StandardProps, FormItemProps {
   placeholderTextColor?: string
 
   /** 是否禁用
+   * @default false
    * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
    */
   disabled?: boolean
@@ -69,15 +70,16 @@ interface InputProps extends StandardProps, FormItemProps {
    */
   focus?: boolean
 
-  /** 设置键盘右下角按钮的文字
+  /** 设置键盘右下角按钮的文字，仅在type='text'时生效
+   * @alipay confirm-type 与 enableNative 属性冲突，若希望 confirm-type 生效，enableNative 不能设定为 false，而且不能设定 always-system
    * @default done
    * @supported weapp, alipay, swan, tt, qq, jd, rn
    */
-  confirmType?: 'send' | 'search' | 'next' | 'go' | 'done'
+  confirmType?: keyof InputProps.ConfirmType
 
   /** 点击键盘右下角按钮时是否保持键盘不收起
    * @default false
-   * @supported weapp, alipay, swan, qq, jd
+   * @supported weapp, alipay, swan, tt, qq, jd
    */
   confirmHold?: boolean
 
@@ -99,14 +101,14 @@ interface InputProps extends StandardProps, FormItemProps {
   selectionEnd?: number
 
   /** 键盘弹起时，是否自动上推页面
-   * @default false
+   * @default true
    * @supported weapp, swan, tt, qq, jd
    */
   adjustPosition?: boolean
 
   /** focus 时，点击页面的时候不收起键盘
    * @default false
-   * @supported weapp
+   * @supported weapp, tt
    */
   holdKeyboard?: boolean
 
@@ -161,7 +163,9 @@ interface InputProps extends StandardProps, FormItemProps {
   randomNumber?: boolean
 
   /**
-   * 是否为受控组件
+   * 是否为受控组件。为 true 时，value 内容会完全受 setData 控制。
+   *
+   * 建议当 type 值为 text 时不要将 controlled 设置为 true,详见 [Bugs & Tips](https://opendocs.alipay.com/mini/component/input#Bug%20%26%20Tip)
    * @default false
    * @supported alipay
    */
@@ -178,9 +182,16 @@ interface InputProps extends StandardProps, FormItemProps {
   name?: string
 
   /** 是否强制使用系统键盘和 Web-view 创建的 input 元素。为 true 时，confirm-type、confirm-hold 可能失效。
+   * @default false
+   * @supported alipay
+   */
+  alwaysSystem?: boolean
+
+  /** 使用原生键盘
+   * @default true
    * @supported alipay
    */
-  alwaysSystem?: string
+  enableNative?: boolean
 
   /** 无障碍访问，（属性）元素的额外描述
    * @supported qq
@@ -214,6 +225,72 @@ interface InputProps extends StandardProps, FormItemProps {
   onKeyboardHeightChange?: CommonEventFunction<InputProps.onKeyboardHeightChangeEventDetail>
 }
 declare namespace InputProps {
+  /** Input 类型 */
+  interface Type {
+    /** 文本输入键盘
+     * @supported weapp, alipay, h5, rn
+     */
+    text
+
+    /** 数字输入键盘
+     * @supported weapp, alipay, h5, rn
+     */
+    number
+
+    /** 身份证输入键盘
+     *@supported weapp, alipay, rn
+     */
+    idcard
+
+    /** 带小数点的数字键盘
+     * @supported weapp, alipay, h5, rn
+     */
+    digit
+
+    /** 密码安全输入键盘[指引](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/safe-password.html)
+     * @supported weapp, alipay
+     */
+    'safe-password'
+
+    /** 昵称输入键盘
+     * @supported weapp, alipay
+     */
+    nickname
+
+    /** 数字输入键盘
+     * @supported alipay
+     */
+    numberpad
+
+    /** 带小数点的数字键盘
+     * @supported alipay
+     */
+    digitpad
+
+    /** 身份证输入键盘
+     * @supported alipay
+     */
+    idcardpad
+  }
+
+  /** Confirm 类型 */
+  interface ConfirmType {
+    /** 右下角按钮为“发送” */
+    send
+
+    /** 右下角按钮为“搜索” */
+    search
+
+    /** 右下角按钮为“下一个” */
+    next
+
+    /** 右下角按钮为“前往” */
+    go
+
+    /** 右下角按钮为“完成” */
+    done
+  }
+
   /** > 注意：React-Native 端 `inputEventDetail` 仅实现参数 `value`，若需实时获取光标位置则可通过 [`onSelectionChange`](https://reactnative.dev/docs/textinput#onselectionchange) 实现。 */
   interface inputEventDetail {
     /** 输入值 */
@@ -247,7 +324,7 @@ declare namespace InputProps {
 
 /** 输入框。该组件是原生组件，使用时请注意相关限制
  * @classification forms
- * @supported weapp, h5, rn
+ * @supported weapp, alipay, swan, tt, qq, jd, h5, rn, harmony
  * @example_react
  * ```tsx
  * class App extends Component {

package/types/Label.d.ts

@@ -9,7 +9,7 @@ interface LabelProps extends StandardProps {
  *
  * 使用for属性找到对应的id，或者将控件放在该标签下，当点击时，就会触发对应的控件。 for优先级高于内部控件，内部有多个控件的时候默认触发第一个控件。 目前可以绑定的控件有：button, checkbox, radio, switch。
  * @classification forms
- * @supported weapp, swan, alipay, tt, h5, rn
+ * @supported weapp, swan, alipay, tt, h5, rn, harmony
  * @example_react
  * ```tsx
  * class App extends Components {

package/types/Lifestyle.d.ts

@@ -0,0 +1,26 @@
+import { ComponentType } from 'react'
+import { StandardProps } from './common'
+interface LifestyleProps extends StandardProps {
+  /** 必填，生活号 ID（即生活号 APPID），必须是当前小程序同账号主体且已关联的生活号。
+   * @supported alipay
+   */
+  publicId?: string
+
+  /** 文案。支持商家自定义，最多展示一行。
+   * @supported alipay
+   */
+  memo?: string
+
+  /** 当用户关注生活号成功后执行。
+   * @supported alipay
+   */
+  onFollow?: CommonEventFunction
+}
+
+/** 关注生活号
+ * @classification open
+ * @supported alipay
+ * @see https://opendocs.alipay.com/mini/component/lifestyle
+ */
+declare const Lifestyle: ComponentType<LifestyleProps>
+export { Lifestyle, LifestyleProps }

package/types/Like.d.ts

@@ -0,0 +1,107 @@
+import { ComponentType } from 'react'
+import { StandardProps } from './common'
+interface LikeProps extends StandardProps {
+  /** 是否已被点赞
+   * @supported swan
+   * @default false
+   */
+  isLiked?: boolean
+
+  /** 按钮模式。icon：表示仅有图标；mixture：表示图标文字结合
+   * @supported swan
+   * @default "icon"
+   */
+  mode?: string
+
+  /** 图标类型。hand：表示手形；heart：表示心形
+   * @supported swan
+   * @default "hand"
+   */
+  iconType?: string
+
+  /** 点赞按钮上的文案。默认为赞，仅在 mode 属性值为'mixture'时有效
+   * @supported swan
+   * @default "赞"
+   */
+  likeText?: string
+
+  /** 点赞数量
+   * @supported swan
+   * @default 0
+   */
+  likeNum?: number
+
+  /** 被点赞的对象类型。0：表示对文章内容进行点赞；1：表示对评论内容进行点赞
+   * @supported swan
+   * @default 0
+   */
+  likeType?: number
+
+  /** 点赞动效形式。0：无动效；1：轻动效；2：强动效
+   * @supported swan
+   * @default 1
+   */
+  animationType?: number
+
+  /** 点赞后是否弹出 toast 提示
+   * @supported swan
+   * @default false
+   */
+  isShowToast?: boolean
+
+  /** toast 文案，默认为已点赞、已取消
+   * @supported swan
+   * @default ['已点赞', '已取消']
+   */
+  toastText?: string[]
+
+  /** 点赞服务需要的必要参数
+   * @supported swan
+   */
+  likeParam: LikeProps.ILikeParam
+
+  /** 使用 npm 方式引入点赞组件时，点击按钮时在用户未登录状态下会触发此事件；使用动态库方式引入点赞组件时，点击按钮时在用户未登录状态下不会触发此事件
+   * @supported swan
+   */
+  onError?: CommonEventFunction
+
+  /** 点击点赞按钮，在点赞服务成功后将状态返回给使用组件者
+   * @supported swan
+   */
+  onSuccess?: CommonEventFunction
+
+  /** 点击点赞按钮，在点赞服务失败后将状态返回给使用组件者
+   * @supported swan
+   */
+  onFail?: CommonEventFunction
+}
+declare namespace LikeProps {
+  interface ILikeParam {
+    /** 用户身份唯一标识 */
+    openid: string
+
+    /** 被点赞的文章的 id，与 path 参数一一对应
+     * @example "20200101"
+     */
+    snid: string
+
+    /** 被点赞的评论 id */
+    spid?: string
+
+    /** 文章标题 */
+    title: string
+
+    /** 智能小程序内页链接，最长不能超过 194 字符
+     * @example "/pages/index/index"
+     */
+    path: string
+  }
+}
+
+/** 点赞
+ * @classification open
+ * @supported swan
+ * @see https://smartprogram.baidu.com/docs/develop/extended/component-content/like/
+ */
+declare const Like: ComponentType<LikeProps>
+export { Like, LikeProps }

package/types/LivePlayer.d.ts

@@ -271,7 +271,7 @@ declare namespace LivePlayerProps {
  *
  * 需要先通过类目审核，再在小程序管理后台，“设置”-“接口设置”中自助开通该组件权限。
  * @classification media
- * @supported weapp, tt
+ * @supported weapp, swan, tt, qq, jd
  * @example_react
  * ```tsx
  * class App extends Components {

package/types/LivePusher.d.ts

@@ -365,7 +365,7 @@ declare namespace LivePusherProps {
 /** 实时音视频录制。需要用户授权 scope.camera、scope.record
  * 需要先通过类目审核，再在小程序管理后台，「开发」-「接口设置」中自助开通该组件权限。
  * @classification media
- * @supported weapp
+ * @supported weapp, qq
  * @example_react
  * ```tsx
  * class App extends Components {

package/types/Login.d.ts

@@ -0,0 +1,45 @@
+import { ComponentType } from 'react'
+import { StandardProps } from './common'
+interface LoginProps extends StandardProps {
+  /** 组件中用户授权按钮的类名，可用于自定义样式
+   * @supported swan
+   */
+  buttonClass?: string
+
+  /** 组件中用户授权勾选框选中时的颜色，同 CSS 的 color
+   * @supported swan
+   * @default "#3388FF"
+   */
+  checkedColor?: string
+
+  /** 主题颜色，设置后将应用于 “用户授权按钮背景色” 和 “用户授权勾选框选中时的颜色”
+   * 注：theme-color 的优先级低于 button-class 和 checked-color，且当 button-class 存在时，theme-color 不生效
+   * @supported swan
+   * @default "#3388FF"
+   */
+  themeColor?: string
+
+  /** 用户完成授权后，获取用户手机号：
+   * detail.errMsg 值为"getPhoneNumber:ok" 时代表用户信息获取成功；
+   * detail.errMsg 值为"getPhoneNumber:fail auth deny"时代表用户信息获取失败。
+   * 参考 用户数据的签名验证和加解密 对用户数据进行处理获得用户手机号。
+   * 用户手机号信息解密后数据示例：{"mobile":"15000000000"}
+   * 1. 非个人开发者可申请；
+   * 2. 审核通过后，进入小程序首页,在左侧导航栏单击“设置 -> 开发设置”。下拉页面，在“获取用户手机号权限申请”中单击“申请开通”
+   * @supported swan
+   */
+  onGetPhoneNumber?: CommonEventFunction
+
+  /** 组件加载失败回调
+   * @supported swan
+   */
+  onLoadError?: CommonEventFunction
+}
+
+/** 联合登录 / 手机号授权内嵌组件
+ * @classification open
+ * @supported swan
+ * @see https://smartprogram.baidu.com/docs/develop/component/login/
+ */
+declare const Login: ComponentType<LoginProps>
+export { Login, LoginProps }