@tarojs/components 3.4.0 → 3.4.3

package/types/Button.d.ts

@@ -4,48 +4,48 @@ import { StyleProp, ViewStyle } from 'react-native'
 
 interface ButtonProps extends StandardProps {
   /** 按钮的大小
-   * @supported weapp, h5, rn
+   * @supported weapp, h5, rn, alipay
    * @default default
    */
-  size?: keyof ButtonProps.size
+  size?: keyof ButtonProps.Size
 
   /** 按钮的样式类型
-   * @supported weapp, h5, rn
+   * @supported weapp, h5, rn, alipay
    * @default default
    */
-  type?: keyof ButtonProps.type
+  type?: keyof ButtonProps.Type
 
   /** 按钮是否镂空，背景色透明
-   * @supported weapp, h5, rn
+   * @supported weapp, h5, rn, alipay
    * @default false
    */
   plain?: boolean
 
   /** 是否禁用
-   * @supported weapp, h5, rn
+   * @supported weapp, h5, rn, alipay
    * @default false
    */
   disabled?: boolean
 
   /** 名称前是否带 loading 图标
-   * @supported weapp, h5, rn
+   * @supported weapp, h5, rn, alipay
    * @default false
    */
   loading?: boolean
 
   /** 用于 `<form/>` 组件，点击分别会触发 `<form/>` 组件的 submit/reset 事件
-   * @supported weapp
+   * @supported weapp, alipay
    */
-  formType?: keyof ButtonProps.formType
+  formType?: keyof ButtonProps.FormType
 
   /** 微信开放能力
    * @supported weapp, alipay, qq
    */
-  openType?: ButtonProps.openType
+  openType?: ButtonProps.OpenType
 
   /** 指定按下去的样式类。当 `hover-class="none"` 时，没有点击态效果
    * @default button-hover
-   * @supported weapp, h5
+   * @supported weapp, alipay, h5
    * @rn 支持 hoverStyle 属性，但框架未支持 hoverClass
    */
   hoverClass?: string
@@ -58,19 +58,19 @@ interface ButtonProps extends StandardProps {
 
   /** 指定是否阻止本节点的祖先节点出现点击态
    * @default false
-   * @supported weapp
+   * @supported weapp, alipay
    */
   hoverStopPropagation?: boolean
 
   /** 按住后多久出现点击态，单位毫秒
    * @default 20
-   * @supported weapp, h5, rn
+   * @supported weapp, alipay, h5, rn
    */
   hoverStartTime?: number
 
   /** 手指松开后点击态保留时间，单位毫秒
    * @default 70
-   * @supported weapp, h5, rn
+   * @supported weapp, alipay, h5, rn
    */
   hoverStayTime?: number
 
@@ -79,7 +79,7 @@ interface ButtonProps extends StandardProps {
    * 生效时机: `open-type="getUserInfo"`
    * @supported weapp
    */
-  lang?: keyof ButtonProps.lang
+  lang?: keyof ButtonProps.Lang
 
   /** 会话来源
    *
@@ -168,6 +168,13 @@ interface ButtonProps extends StandardProps {
    */
   onGetPhoneNumber?: CommonEventFunction<ButtonProps.onGetPhoneNumberEventDetail>
 
+  /** 获取头像信息
+   *
+   * 生效时机：`open-type="chooseavatar"`
+   * @supported weapp
+   */
+  onChooseAvatar?: CommonEventFunction<ButtonProps.onChooseAvatarEventDetail>
+
   /** 获取用户实名
    *
    * 生效时机：`open-type="getRealnameAuthInfo"`
@@ -199,14 +206,14 @@ interface ButtonProps extends StandardProps {
 
 declare namespace ButtonProps {
   /** size 的合法值 */
-  interface size {
+  interface Size {
     /** 默认大小 */
     default
     /** 小尺寸 */
     mini
   }
   /** type 的合法值 */
-  interface type {
+  interface Type {
     /** 绿色 */
     primary
     /** 白色 */
@@ -215,14 +222,14 @@ declare namespace ButtonProps {
     warn
   }
   /** form-type 的合法值 */
-  interface formType {
+  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,6 +245,10 @@ declare namespace ButtonProps {
        * @see https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/getPhoneNumber.html
        */
       getPhoneNumber
+      /** 获取用户头像，可以从 bindchooseavatar 回调中获取到头像信息
+       * @see https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/userProfile.html
+       */
+      chooseAvatar
       /** 获取用户信息，可以从 bindgetuserinfo 回调中获取到用户信息 */
       getUserInfo
       /** 用户实名信息授权，已经弃用 */
@@ -297,7 +308,7 @@ declare namespace ButtonProps {
     }
   }
   /** lang 的合法值 */
-  interface lang {
+  interface Lang {
     /** 英文 */
     en
     /** 简体中文 */
@@ -313,7 +324,7 @@ declare namespace ButtonProps {
       /** 头像 */
       avatarUrl: string
       /** 性别 */
-      gender: keyof gender
+      gender: keyof Gender
       /** 省份，如：`Yunnan` */
       province: string
       /** 城市，如：`Dalian` */
@@ -336,7 +347,7 @@ declare namespace ButtonProps {
   }
 
   /** 性别的合法值 */
-  interface gender {
+  interface Gender {
     /** 未知 */
     0
     /** 男 */
@@ -363,6 +374,11 @@ declare namespace ButtonProps {
     iv: string
   }
 
+  interface onChooseAvatarEventDetail {
+    /* 获取用户头像的临时链接 */
+    avatarUrl: string
+  }
+
   interface onOpenSettingEventDetail {
     /* 打开授权设置页的调用状态 */
     errMsg: string
@@ -374,7 +390,7 @@ declare namespace ButtonProps {
 /** 按钮
  * @classification forms
  * @supported weapp, h5, rn
- * @example
+ * @example_react
  * ```tsx
  * export default class PageButton extends Component {
  *   state = {
@@ -447,6 +463,79 @@ declare namespace ButtonProps {
  *   }
  * }
  * ```
+ * @example_vue
+ * ```html
+ * <template>
+ *   <view class="container">
+ *     <button
+ *       v-for="item in btn"
+ *       :size="item.size ? item.size : ''"
+ *       :type="item.type ? item.type : ''"
+ *       :loading="item.loading ? item.loading : false"
+ *       :disabled="item.disabled ? item.disabled : false"
+ *     >
+ *       {{ item.text }}
+ *     </button>
+ *     <button class="btn-max-w" :plain="true" type="primary">按钮</button>
+ *     <button class="btn-max-w" :plain="true" type="primary" :disabled="true">不可点击的按钮</button>
+ *     <button class="btn-max-w" :plain="true">按钮</button>
+ *     <button class="btn-max-w" :plain="true" :disabled="true">按钮</button>
+ *     <button size="mini" type="primary">按钮</button>
+ *     <button size="mini" >按钮</button>
+ *     <button size="mini" type="warn">按钮</button>
+ *   </view>
+ * </template>
+ *
+ * <script>
+ * export default {
+ *   data() {
+ *     return {
+ *       btn: [
+ *         {
+ *           text: '页面主操作 Normal',
+ *           size: 'default',
+ *           type: 'primary'
+ *         },
+ *         {
+ *           text: '页面主操作 Loading',
+ *           size: 'default',
+ *           type: 'primary',
+ *           loading: true,
+ *         },
+ *         {
+ *           text: '页面主操作 Disabled',
+ *           size: 'default',
+ *           type: 'primary',
+ *           disabled: true,
+ *         },
+ *         {
+ *           text: '页面次要操作 Normal',
+ *           size: 'default',
+ *           type: 'default'
+ *         },
+ *         {
+ *           text: '页面次要操作 Disabled',
+ *           size: 'default',
+ *           type: 'default',
+ *           disabled: true,
+ *         },
+ *         {
+ *           text: '警告类操作 Normal',
+ *           size: 'default',
+ *           type: 'warn'
+ *         },
+ *         {
+ *           text: '警告类操作 Disabled',
+ *           size: 'default',
+ *           type: 'warn',
+ *           disabled: true,
+ *         }
+ *       ]
+ *     }
+ *   }
+ * }
+ * </script>
+ * ```
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/button.html
  */
 declare const Button: ComponentType<ButtonProps>

package/types/Camera.d.ts

@@ -6,31 +6,31 @@ interface CameraProps extends StandardProps {
    * @default "normal"
    * @supported weapp, rn
    */
-  mode?: keyof CameraProps.mode
+  mode?: keyof CameraProps.Mode
 
   /** 分辨率，不支持动态修改
    * @default "medium"
    * @supported weapp
    */
-  resolution?: keyof CameraProps.resolution
+  resolution?: keyof CameraProps.Resolution
 
   /** 摄像头朝向
    * @default "back"
    * @supported weapp, rn
    */
-  devicePosition?: keyof CameraProps.devicePosition
+  devicePosition?: keyof CameraProps.DevicePosition
 
   /** 闪光灯
    * @default "auto"
    * @supported weapp, rn
    */
-  flash?: keyof CameraProps.flash
+  flash?: keyof CameraProps.Flash
 
   /** 指定期望的相机帧数据尺寸
    * @default "medium"
    * @supported weapp
    */
-  frameSize?: keyof CameraProps.frameSize
+  frameSize?: keyof CameraProps.FrameSize
 
   /** 扫码识别区域，格式为[x, y, w, h]，
    * x,y是相对于camera显示区域的左上角，
@@ -64,14 +64,14 @@ interface CameraProps extends StandardProps {
 
 declare namespace CameraProps {
   /** mode 的合法值 */
-  interface mode {
+  interface Mode {
     /** 相机模式 */
     normal
     /** 扫码模式 */
     scanCode
   }
   /** resolution 的合法值 */
-  interface resolution {
+  interface Resolution {
     /** 低 */
     low
     /** 中 */
@@ -80,14 +80,14 @@ declare namespace CameraProps {
     high
   }
   /** device-position 的合法值 */
-  interface devicePosition {
+  interface DevicePosition {
     /** 前置 */
     front
     /** 后置 */
     back
   }
   /** flash 的合法值 */
-  interface flash {
+  interface Flash {
     /** 自动 */
     auto
     /** 打开 */
@@ -98,7 +98,7 @@ declare namespace CameraProps {
     torch
   }
   /** frame-size 的合法值 */
-  interface frameSize {
+  interface FrameSize {
     /** 小尺寸帧数据 */
     small
     /** 中尺寸帧数据 */
@@ -115,7 +115,7 @@ declare namespace CameraProps {
 
 /** 系统相机
  * @classification media
- * @supported weapp
+ * @supported weapp, rn
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/camera.html
  */
 declare const Camera: ComponentType<CameraProps>

package/types/Canvas.d.ts

@@ -47,6 +47,11 @@ interface CanvasProps extends StandardProps<any, CanvasTouchEvent> {
    * @supported weapp
    */
   onError?: CommonEventFunction<CanvasProps.onErrorEventDetail>
+
+  /** 用于透传 `WebComponents` 上的属性到内部 H5 标签上
+   * @supported h5
+   */
+  nativeProps?: Record<string, unknown>
 }
 
 declare namespace CanvasProps {
@@ -60,16 +65,24 @@ declare namespace CanvasProps {
  * `<Canvas />` 组件的 RN 版本尚未实现。
  * @classification canvas
  * @supported weapp
- * @example
+ * @example_react
  * ```tsx
  * class App extends Components {
  *   render () {
+ *     // 如果是支付宝小程序，则要加上 id 属性，值和canvasId一致
  *     return (
  *       <Canvas style='width: 300px; height: 200px;' canvasId='canvas' />
  *     )
  *   }
  * }
  * ```
+ * @example_vue
+ * ```html
+ * <template>
+ *   <!-- 如果是支付宝小程序，则要加上 id 属性，值和canvasId一致 -->
+ *   <canvas style="width: 300px; height: 200px;" canvas-id="canvas" />
+ * </template>
+ * ```
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/canvas.html
  */
 declare const Canvas: ComponentType<CanvasProps>

package/types/Checkbox.d.ts

@@ -29,12 +29,17 @@ interface CheckboxProps extends StandardProps {
    * @supported h5, rn
    */
   onChange?: CommonEventFunction<{ value: string[] }>
+
+  /** 用于透传 `WebComponents` 上的属性到内部 H5 标签上
+   * @supported h5
+   */
+  nativeProps?: Record<string, unknown>
 }
 
 /** 多选项目
  * @classification forms
  * @supported weapp, h5, rn
- * @example
+ * @example_react
  * ```tsx
  * export default class PageCheckbox extends Component {
  *   state = {
@@ -94,6 +99,65 @@ interface CheckboxProps extends StandardProps {
  *   }
  * }
  * ```
+ * @example_vue
+ * ```html
+ * <template>
+ *   <view class="container">
+ *     <view class="page-section">
+ *       <text>默认样式</text>
+ *       <checkbox value="选中" :checked="true">选中</checkbox>
+ *       <checkbox style="margin-left: 20rpx;" value="未选中">未选中</checkbox>
+ *     </view>
+ *     <view class="page-section">
+ *       <text>推荐展示样式(Taro 团队成员):</text>
+ *       <label v-for="item in list" class="checkbox-list__label">
+ *         <checkbox class="checkbox-list__checkbox" :value="item.value" :checked="item.checked">{{ item.text }}</checkbox>
+ *       </label>
+ *     </view>
+ *   </view>
+ * </template>
+ * 
+ * <script>
+ * export default {
+ *   data() {
+ *     return {
+ *       list: [
+ *         {
+ *           value: '美国',
+ *           text: '美国',
+ *           checked: false
+ *         },
+ *         {
+ *           value: '中国',
+ *           text: '中国',
+ *           checked: true
+ *         },
+ *         {
+ *           value: '巴西',
+ *           text: '巴西',
+ *           checked: false
+ *         },
+ *         {
+ *           value: '日本',
+ *           text: '日本',
+ *           checked: false
+ *         },
+ *         {
+ *           value: '英国',
+ *           text: '英国',
+ *           checked: false
+ *         },
+ *         {
+ *           value: '法国',
+ *           text: '法国',
+ *           checked: false
+ *         }
+ *       ]
+ *     }
+ *   }
+ * }
+ * </script>
+ * ```
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/checkbox.html
  */
 declare const Checkbox: ComponentType<CheckboxProps>

package/types/CoverImage.d.ts

@@ -3,32 +3,34 @@ import { StandardProps, CommonEventFunction } from './common'
 
 interface CoverImageProps extends StandardProps {
   /** 图标路径，支持临时路径、网络地址、云文件ID。暂不支持base64格式。
-   * @supported weapp
+   * @supported weapp, h5
    */
   src: string
 
   /** 图片加载成功时触发
-   * @supported weapp
+   * @supported weapp, h5
    */
   onLoad?: CommonEventFunction
 
   /** 图片加载失败时触发
-   * @supported weapp
+   * @supported weapp, h5
    */
   onError?: CommonEventFunction
 }
 
 /** 覆盖在原生组件之上的图片视图。可覆盖的原生组件同cover-view，支持嵌套在cover-view里。
  * @classification viewContainer
- * @supported weapp, swan, alipay
- * @example
+ * @supported weapp, swan, alipay, h5
+ * @example_react
  * ```tsx
+ * // js
  * class App extends Components {
  *   render () {
  *     return (
+ *       <View className='container'>
  *       <Video id='myVideo' src='src'>
  *         <CoverView className='controls'>
- *           <CoverView className='play' onClick={() => { TODO }}>
+ *           <CoverView className='play' onClick='play'>
  *             <CoverImage className='img' src='src' />
  *           </CoverView>
  *         </CoverView>
@@ -36,6 +38,46 @@ interface CoverImageProps extends StandardProps {
  *     )
  *   }
  * }
+ * // css
+ * .container {
+ *   position: relative;
+ * }
+ * .controls {
+ *   position: absolute;
+ *   top: 50%;
+ *   left: 50%;
+ *   width: 300px;
+ *   height: 225px;
+ *   transform: translate(-50%, -50%);
+ * }
+ * ```
+ * @example_vue
+ * ```html
+ * <template>
+ *   <view class="container">
+ *     <video id='myvideo' src='https://ugccsy.qq.com/uwMROfz2r5zBIaQXGdGnC2dfDma3J1MItM3912IN4IRQvkRM/o31507f7lcd.mp4?sdtfrom=v1010&guid=aa18cf106b7fdb7e40f2d20b206f2b4f&vkey=63B0FCCC7FC3ADC342C166D86571AE02772258CD9B515B065DC68DF3919D8C288AE831D570ED5E8FE0FF3E81E170D04FF11F874BFDDACF7AAA2C0CFF2ACB39FB1A94DAD1AB859BDA53E4DD6DBCDC1217CEF789A9AC079924E2BBC599EED7A1FFDD60A727F2EB7E7B6472CE63DD4B683C9199DFC78A6A6C4D9891E05467C4B64E'>
+ *     </video>
+ *     <cover-view class='controls'>
+ *       <cover-view class='play' `@tap='play'>
+ *         <cover-image class='img' src='https://img10.360buyimg.com/ling/s345x208_jfs/t1/133501/7/9865/382161/5f5ee31fEbdd6a418/0cdc0156ffff3c23.png' />
+ *       </cover-view>
+ *     </cover-view>
+ *   </view>
+ * </template>
+ * 
+ * <style>
+ * .container {
+ *   position: relative;
+ * }
+ * .controls {
+ *   position: absolute;
+ *   top: 50%;
+ *   left: 50%;
+ *   width: 300px;
+ *   height: 225px;
+ *   transform: translate(-50%, -50%);
+ * }
+ * </style>
  * ```
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/cover-image.html
  */

package/types/CoverView.d.ts

@@ -21,22 +21,65 @@ interface CoverViewProps extends ViewProps {
 
 /** 覆盖在原生组件之上的文本视图。可覆盖的原生组件包括 map、video、canvas、camera、live-player、live-pusher 只支持嵌套 cover-view、cover-image，可在 cover-view 中使用 button。
  * @classification viewContainer
- * @supported weapp, swan, alipay
- * @example
+ * @supported weapp, swan, alipay, h5
+ * @example_react
  * ```tsx
+ * // js
  * class App extends Components {
  *   render () {
  *     return (
- *       <Video id='myVideo' src='src'>
- *         <CoverView className='controls'>
- *           <CoverView className='play' onClick={() => { TODO }}>
- *             <CoverImage className='img' src='src' />
+ *       <View className='container'>
+ *         <Video id='myVideo' src='src'>
+ *           <CoverView className='controls'>
+ *             <CoverView className='play' onClick='play'>
+ *               <CoverImage className='img' src='src' />
+ *             </CoverView>
  *           </CoverView>
- *         </CoverView>
- *       </Video>
+ *         </Video>
+ *       </View>
  *     )
  *   }
  * }
+ * // css
+ * .container {
+ *   position: relative;
+ * }
+ * .controls {
+ *   position: absolute;
+ *   top: 50%;
+ *   left: 50%;
+ *   width: 300px;
+ *   height: 225px;
+ *   transform: translate(-50%, -50%);
+ * }
+ * ```
+ * @example_vue
+ * ```html
+ * <template>
+ *   <view class="container">
+ *     <video id='myvideo' src='https://ugccsy.qq.com/uwMROfz2r5zBIaQXGdGnC2dfDma3J1MItM3912IN4IRQvkRM/o31507f7lcd.mp4?sdtfrom=v1010&guid=aa18cf106b7fdb7e40f2d20b206f2b4f&vkey=63B0FCCC7FC3ADC342C166D86571AE02772258CD9B515B065DC68DF3919D8C288AE831D570ED5E8FE0FF3E81E170D04FF11F874BFDDACF7AAA2C0CFF2ACB39FB1A94DAD1AB859BDA53E4DD6DBCDC1217CEF789A9AC079924E2BBC599EED7A1FFDD60A727F2EB7E7B6472CE63DD4B683C9199DFC78A6A6C4D9891E05467C4B64E'>
+ *     </video>
+ *     <cover-view class='controls'>
+ *       <cover-view class='play' `@tap='play'>
+ *         <cover-image class='img' src='https://img10.360buyimg.com/ling/s345x208_jfs/t1/133501/7/9865/382161/5f5ee31fEbdd6a418/0cdc0156ffff3c23.png' />
+ *       </cover-view>
+ *     </cover-view>
+ *   </view>
+ * </template>
+ * 
+ * <style>
+ * .container {
+ *   position: relative;
+ * }
+ * .controls {
+ *   position: absolute;
+ *   top: 50%;
+ *   left: 50%;
+ *   width: 300px;
+ *   height: 225px;
+ *   transform: translate(-50%, -50%);
+ * }
+ * </style>
  * ```
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/cover-view.html
  */