@tarojs/components 3.4.0 → 3.4.3

package/types/Editor.d.ts

@@ -79,6 +79,63 @@ declare namespace EditorProps {
  * *编辑器内支持部分 HTML 标签和内联样式，不支持 **class** 和 **id***
  * @classification forms
  * @supported weapp
+ * @example_react
+ * ```tsx
+ * class App extends Components {
+ *   state = {
+ *     placeholder: '来，输入隔壁的名字试试...'
+ *   }
+ * 
+ *   editorReady = e => {
+ *     Taro.createSelectorQuery().select('#editor').context((res) => {
+ *       this.editorCtx = res.context
+ *     }).exec()
+ *   }
+ * 
+ *   undo = e => {
+ *     this.editorCtx.undo()
+ *   }
+ * 
+ *   render () {
+ *     return (
+ *       <View>
+ *         <Editor id='editor' className='editor' placeholder={this.state.placeholder} onReady={this.editorReady}></Editor>
+ *         <Button type='warn' onClick={this.undo}>撤销</Button>
+ *       </View>
+ *     )
+ *   }
+ * }
+ * ```
+ * @example_vue
+ * ```html
+ * <template>
+ *   <view class="container">
+ *     <editor id="editor" class="editor" :placeholder="placeholder" `@ready="editorReady"></editor>
+ *     <button type="warn" `@tap="undo">撤销</button>
+ *   </view>
+ * </template>
+ * 
+ * <script>
+ *   import Taro from '@tarojs/taro'
+ *   export default {
+ *     data() {
+ *       return {
+ *         placeholder: '来，输入隔壁的名字试试...'
+ *       }
+ *     },
+ *     methods: {
+ *       editorReady() {
+ *         Taro.createSelectorQuery().select('#editor').context((res) => {
+ *           this.editorCtx = res.context
+ *         }).exec()
+ *       },
+ *       undo() {
+ *         this.editorCtx.undo()
+ *       }
+ *     }
+ *   }
+ * </script>
+ * ```
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/editor.html
  */
 declare const Editor: ComponentType<EditorProps>

package/types/Form.d.ts

@@ -20,7 +20,7 @@ interface FormProps extends StandardProps {
 
   /** 携带 form 中的数据触发 submit 事件
    * event.detail = { value : {'name': 'value'} , formId: '' }
-   * @supported weapp
+   * @supported weapp, rn
    */
   onSubmit?: CommonEventFunction<FormProps.onSubmitEventDetail>
 
@@ -50,7 +50,7 @@ declare namespace FormProps {
  * 当点击 form 表单中 form-type 为 submit 的 button 组件时，会将表单组件中的 value 值进行提交，需要在表单组件中加上 name 来作为 key。
  * @classification forms
  * @supported weapp, h5, rn
- * @example
+ * @example_react
  * ```tsx
  * class App extends Component {
  * 
@@ -73,6 +73,37 @@ declare namespace FormProps {
  *   }
  * }
  * ```
+ * @example_vue
+ * ```html
+ * <template>
+ *   <form `@submit="formSubmit" `@reset="formReset" >
+ *       <view class="taro-example-body">
+ *         <switch name="switch" class="form-switch"></Switch>
+ *       </view>
+ *       <view class="taro-example-btns">
+ *         <button form-type="submit">Submit</button>
+ *         <button type="default" form-type="reset">Reset</button>
+ *     </view>
+ *   </form>
+ * </template>
+ * 
+ * <script>
+ * export default {
+ *   data() {
+ *     return {}
+ *   },
+ *   methods: {
+ *     formSubmit (e) {
+ *       console.log(e)
+ *     },
+ * 
+ *     formReset (e) {
+ *       console.log(e)
+ *     }
+ *   }
+ * }
+ * </script>
+ * ```
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/form.html
  */
 declare const Form: ComponentType<FormProps>

package/types/FunctionalPageNavigator.d.ts

@@ -6,12 +6,12 @@ interface FunctionalPageNavigatorProps extends StandardProps {
    * @default "release"
    * @supported weapp
    */
-  version?: keyof FunctionalPageNavigatorProps.version
+  version?: keyof FunctionalPageNavigatorProps.Version
 
   /** 要跳转到的功能页
    * @supported weapp
    */
-  name?: keyof FunctionalPageNavigatorProps.name
+  name?: keyof FunctionalPageNavigatorProps.Name
 
   /** 功能页参数，参数格式与具体功能页相关
    * @supported weapp
@@ -36,7 +36,7 @@ interface FunctionalPageNavigatorProps extends StandardProps {
 
 declare namespace FunctionalPageNavigatorProps {
   /** version 的合法值 */
-  interface version {
+  interface Version {
     /** 开发版 */
     develop
     /** 体验版 */
@@ -45,7 +45,7 @@ declare namespace FunctionalPageNavigatorProps {
     release
   }
   /** name 的合法值 */
-  interface name {
+  interface Name {
     /** [用户信息功能页](https://developers.weixin.qq.com/miniprogram/dev/framework/plugin/functional-pages/user-info.html) */
     loginAndGetUserInfo
     /** [支付功能页](https://developers.weixin.qq.com/miniprogram/dev/framework/plugin/functional-pages/request-payment.html) */

package/types/Icon.d.ts

@@ -50,7 +50,7 @@ declare namespace IconProps {
 /** 图标。组件属性的长度单位默认为 px
  * @classification base
  * @supported weapp, swan, alipay, tt, h5, rn
- * @example
+ * @example_react
  * ```tsx
  * export default class PageView extends Component {
  *   constructor() {
@@ -76,6 +76,22 @@ declare namespace IconProps {
  *   }
  * }
  * ```
+ * @example_vue
+ * <template>
+ *   <view class="components-page">
+ *     <icon size="60" type="success" />
+ *     <icon size="60" type="info" />
+ *     <icon size="60" type="warn" color="#ccc" />
+ *     <icon size="60" type="warn" />
+ *     <icon size="60" type="waiting" />
+ *     <icon size="20" type="success_no_circle" />
+ *     <icon size="20" type="warn" />
+ *     <icon size="20" type="success" />
+ *     <icon size="20" type="download" />
+ *     <icon size="20" type="clear" color="red" />
+ *     <icon size="20" type="search" />
+ *   </view>
+ * </template>
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/icon.html
  */
 declare const Icon: ComponentType<IconProps>

package/types/Image.d.ts

@@ -12,7 +12,7 @@ interface ImageProps extends StandardProps {
    * @supported weapp, h5, rn, swan, alipay, tt
    * @rn 部分支持 scaleToFill, aspectFit, aspectFill, widthFix
    */
-  mode?: keyof ImageProps.mode
+  mode?: keyof ImageProps.Mode
 
 	/** 默认不解析 webP 格式，只支持网络资源
    * @default false
@@ -28,7 +28,7 @@ interface ImageProps extends StandardProps {
 
   /** 图片懒加载。只针对 page 与 scroll-view 下的 image 有效
    * @default false
-   * @supported weapp, swan, alipay, tt
+   * @supported weapp, swan, alipay, tt, h5
    */
   lazyLoad?: boolean
 
@@ -53,11 +53,16 @@ interface ImageProps extends StandardProps {
    * @supported h5
    */
   imgProps?: ImgHTMLAttributes<HTMLImageElement>
+
+  /** 用于透传 `WebComponents` 上的属性到内部 H5 标签上
+   * @supported h5
+   */
+  nativeProps?: Record<string, unknown>
 }
 
 declare namespace ImageProps {
   /** mode 的合法值 */
-  interface mode {
+  interface Mode {
     /** 缩放模式，不保持纵横比缩放图片，使图片的宽高完全拉伸至填满 image 元素 */
     scaleToFill
     /** 缩放模式，保持纵横比缩放图片，使图片的长边能完全显示出来。也就是说，可以完整地将图片显示出来。 */
@@ -104,7 +109,7 @@ declare namespace ImageProps {
  * **Note:** 为实现小程序的 `mode` 特性，在 H5 组件中使用一个 `div` 容器来对内部的 `img` 进行展示区域的裁剪，因此请勿使用元素选择器来重置 `img` 的样式！
  * @classification media
  * @supported weapp, h5, rn, swan, alipay, tt
- * @example
+ * @example_react
  * ```tsx
  * export default class PageView extends Component {
  *   constructor() {
@@ -127,6 +132,21 @@ declare namespace ImageProps {
  *   }
  * }
  * ```
+ * @example_vue
+ * ```html
+ * <template>
+ *   <view class="components-page">
+ *     <image
+ *       style="width: 300px;height: 100px;background: #fff;"
+ *       src="nerv_logo.png"
+ *     />
+ *     <image
+ *       style="width: 300px;height: 100px;background: #fff;"
+ *       src="https://camo.githubusercontent.com/3e1b76e514b895760055987f164ce6c95935a3aa/687474703a2f2f73746f726167652e333630627579696d672e636f6d2f6d74642f686f6d652f6c6f676f2d3278313531333833373932363730372e706e67"
+ *     />
+ *   </view>
+ * </template>
+ * ```
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/image.html
  */
 declare const Image: ComponentType<ImageProps>

package/types/Input.d.ts

@@ -12,7 +12,7 @@ interface InputProps extends StandardProps, FormItemProps {
    * @supported weapp, h5, rn
    * @rn 部分支持
    */
-  type?: 'text' | 'number' | 'idcard' | 'digit'
+  type?: 'text' | 'number' | 'idcard' | 'digit' | 'safe-password' | 'nickname'
 
   /** 是否是密码类型
    * @supported weapp, h5, rn
@@ -63,7 +63,6 @@ interface InputProps extends StandardProps, FormItemProps {
    */
   focus?: boolean
 
-
   /** 设置键盘右下角按钮的文字
    * @default done
    * @supported weapp, rn
@@ -112,6 +111,41 @@ interface InputProps extends StandardProps, FormItemProps {
    */
   alwaysEmbed?: boolean
 
+  /**
+   * 安全键盘加密公钥的路径，只支持包内路径
+   * @supported weapp
+   */
+  safePasswordCertPath?: string
+
+  /**
+   * 安全键盘输入密码长度
+   * @supported weapp
+   */
+  safePasswordLength?: number
+
+  /**
+   * 安全键盘加密时间戳
+   * @supported weapp
+   */
+  safePasswordTimeStamp?: number
+
+  /**
+   * 安全键盘加密盐值
+   * @supported weapp
+   */
+  safePasswordNonce?: string
+  /**
+   * 安全键盘计算hash盐值，若指定custom-hash 则无效
+   * @supported weapp
+   */
+  safePasswordSalt?: string
+
+  /**
+   * 安全键盘计算hash的算法表达式，如 `md5(sha1('foo' + sha256(sm3(password + 'bar'))))`
+   * @supported weapp
+   */
+  safePasswordCustomHash?: string
+
   /**
    * 当 type 为 number, digit, idcard 数字键盘是否随机排列
    * @default false
@@ -147,7 +181,7 @@ interface InputProps extends StandardProps, FormItemProps {
    *
    * event.detail = {value: value}
    * @supported weapp, rn
-   * @h5 借用[Form 组件](form.html)的`onSubmit`事件来替代
+   * @h5 借用[Form 组件](./form)的`onSubmit`事件来替代
    */
   onConfirm?: CommonEventFunction<InputProps.inputValueEventDetail>
 
@@ -157,9 +191,15 @@ interface InputProps extends StandardProps, FormItemProps {
    * @supported weapp
    */
   onKeyboardHeightChange?: CommonEventFunction<InputProps.onKeyboardHeightChangeEventDetail>
+
+  /** 用于透传 `WebComponents` 上的属性到内部 H5 标签上
+   * @supported h5
+   */
+  nativeProps?: Record<string, unknown>
 }
 
 declare namespace InputProps {
+  /** > 注意：React-Native 端 `inputEventDetail` 仅实现参数 `value`，若需实时获取光标位置则可通过 [`onSelectionChange`](https://reactnative.dev/docs/textinput#onselectionchange) 实现。 */
   interface inputEventDetail {
     /** 输入值 */
     value: string
@@ -190,7 +230,7 @@ declare namespace InputProps {
 /** 输入框。该组件是原生组件，使用时请注意相关限制
  * @classification forms
  * @supported weapp, h5, rn
- * @example
+ * @example_react
  * ```tsx
  * class App extends Component {
  *
@@ -204,7 +244,7 @@ declare namespace InputProps {
  *             <Text>数字输入的 input</Text>
  *             <Input type='number' placeholder='这是一个数字输入框'/>
  *             <Text>密码输入的 input</Text>
- *             <Input type='text' password placeholder='这是一个密码输入框'/>
+ *             <Input type='password' password placeholder='这是一个密码输入框'/>
  *             <Text>带小数点的 input</Text>
  *             <Input type='digit' placeholder='带小数点的数字键盘'/>
  *             <Text>身份证输入的 input</Text>
@@ -216,6 +256,27 @@ declare namespace InputProps {
  *   }
  * }
  * ```
+ * @example_vue
+ * ```html
+ * <template>
+ *   <view class="example-body">
+ *     <text>可以自动聚焦的 input</text>
+ *     <input type="text" placeholder="将会获取焦点" :focus="true" />
+ *     <text>控制最大输入长度的 input</text>
+ *     <input type="text" placeholder="最大输入长度为 10" maxlength="10"/>
+ *     <text>数字输入的 input</text>
+ *     <input type="number" placeholder="这是一个数字输入框"/>
+ *     <text>密码输入的 input</text>
+ *     <input type="password" :password="true" placeholder="这是一个密码输入框"/>
+ *     <text>带小数点的 input</text>
+ *     <input type="digit" placeholder="带小数点的数字键盘"/>
+ *     <text>身份证输入的 input</text>
+ *     <input type="idcard" placeholder="身份证输入键盘"/>
+ *     <text>控制占位符颜色的 input</text>
+ *     <input type="text" placeholder="占位符字体是红色的" placeholder-style="color:red;"/>
+ *   </view>
+ * </template>
+ * ```
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/input.html
  */
 declare const Input: ComponentType<InputProps>

package/types/KeyboardAccessory.d.ts

@@ -1,6 +1,7 @@
 import { ComponentType } from 'react'
-import { StandardProps, CommonEventFunction } from './common'
+import { StandardProps } from './common'
 
+/** @ignore */
 type KeyboardAccessoryProps = StandardProps
 
 /** 设置 input / textarea 聚焦时键盘上方 cover-view / cover-image 工具栏视图

package/types/Label.d.ts

@@ -3,8 +3,7 @@ import { StandardProps } from './common'
 
 interface LabelProps extends StandardProps {
 
-  /** 绑定控件的 id
-   */
+  /** 绑定控件的 id */
   for?: string
 }
 
@@ -12,8 +11,8 @@ interface LabelProps extends StandardProps {
  * 
  * 使用for属性找到对应的id，或者将控件放在该标签下，当点击时，就会触发对应的控件。 for优先级高于内部控件，内部有多个控件的时候默认触发第一个控件。 目前可以绑定的控件有：button, checkbox, radio, switch。
  * @classification forms
- * @supported weapp, swan, alipay, tt, h5
- * @example
+ * @supported weapp, swan, alipay, tt, h5, rn
+ * @example_react
  * ```tsx
  * class App extends Components {
  * 
@@ -33,6 +32,21 @@ interface LabelProps extends StandardProps {
  *   }
  * }
  * ```
+ * @example_vue
+ * ```html
+ * <template>
+ *   <radio-group>
+ *     <label class="example-body__label" for="1" key="1">
+ *       <radio id="1" value="USA" />
+ *       USA
+ *     </label>
+ *     <label class="example-body__label" for="2" key="2">
+ *       <radio id="2" value="CHN" :checked="true" />
+ *       CHN
+ *     </label>
+ *   </radio-group>
+ * </template>
+ * ```
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/label.html
  */
 declare const Label: ComponentType<LabelProps>

package/types/LivePlayer.d.ts

@@ -1,5 +1,5 @@
 import { ComponentType } from 'react'
-import { StandardProps, CommonEventFunction, netStatus } from './common'
+import { StandardProps, CommonEventFunction, NetStatus } from './common'
 
 interface LivePlayerProps extends StandardProps {
   /** 音视频地址。目前仅支持 flv, rtmp 格式
@@ -11,7 +11,7 @@ interface LivePlayerProps extends StandardProps {
    * @default "live"
    * @supported weapp
    */
-  mode?: keyof LivePlayerProps.mode
+  mode?: keyof LivePlayerProps.Mode
 
   /** 自动播放
    * @default false
@@ -29,7 +29,7 @@ interface LivePlayerProps extends StandardProps {
    * @default "vertical"
    * @supported weapp
    */
-  orientation?: keyof LivePlayerProps.orientation
+  orientation?: keyof LivePlayerProps.Orientation
 
   /** 填充模式
    * @default "contain"
@@ -44,13 +44,13 @@ interface LivePlayerProps extends StandardProps {
    */
   backgroundMute?: boolean
 
-  /** 进最小缓冲区，单位s
+  /** 最小缓冲区，单位s
    * @default 1
    * @supported weapp
    */
   minCache?: number
 
-  /** 进最小缓冲区，单位s
+  /** 最大缓冲区，单位s
    * @default 3
    * @supported weapp
    */
@@ -112,14 +112,14 @@ interface LivePlayerProps extends StandardProps {
 
 declare namespace LivePlayerProps {
   /** mode 的合法值 */
-  interface mode {
+  interface Mode {
     /** 直播 */
     live
     /** 实时通话，该模式时延更低 */
     RTC
   }
   /** orientation 的合法值 */
-  interface orientation {
+  interface Orientation {
     /** 竖直 */
     vertical
     /** 水平 */
@@ -151,10 +151,10 @@ declare namespace LivePlayerProps {
     fullScreen: number | boolean
   }
   interface onNetStatusEventDetail {
-    info: netStatus
+    info: NetStatus
   }
   /** 状态码 */
-  interface status {
+  interface Status {
     /** 已经连接服务器 */
     2001
     /** 已经连接 RTMP 服务器,开始拉流 */
@@ -205,11 +205,11 @@ declare namespace LivePlayerProps {
 }
 
 /** 实时音视频播放。相关api：Taro.createLivePlayerContext
- * 
+ *
  * 需要先通过类目审核，再在小程序管理后台，“设置”-“接口设置”中自助开通该组件权限。
  * @classification media
  * @supported weapp
- * @example
+ * @example_react
  * ```tsx
  * class App extends Components {
  *   render () {
@@ -219,6 +219,12 @@ declare namespace LivePlayerProps {
  *   }
  * }
  * ```
+ * @example_vue
+ * ```html
+ * <template>
+ *   <live-player src="url" mode="live" :autoplay="true"  />
+ * </template>
+ * ```
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/live-player.html
  */
 declare const LivePlayer: ComponentType<LivePlayerProps>

package/types/LivePusher.d.ts

@@ -1,5 +1,5 @@
 import { ComponentType } from 'react'
-import { StandardProps, CommonEventFunction, netStatus } from './common'
+import { StandardProps, CommonEventFunction, NetStatus } from './common'
 
 /** 实时音视频录制。
  * 需要用户授权 scope.camera、scope.record
@@ -46,7 +46,7 @@ interface LivePusherProps extends StandardProps {
    * @default "vertical"
    * @supported weapp
    */
-  orientation?: keyof LivePusherProps.orientation
+  orientation?: keyof LivePusherProps.Orientation
 
   /** 美颜，取值范围 0-9 ，0 表示关闭
    * @default 0
@@ -131,13 +131,13 @@ interface LivePusherProps extends StandardProps {
    * @default "auto"
    * @supported weapp
    */
-  localMirror?: keyof LivePusherProps.localMirror
+  localMirror?: keyof LivePusherProps.LocalMirror
 
   /** 音频混响类型
    * @default 0
    * @supported weapp
    */
-  audioReverbType?: keyof LivePusherProps.audioReverbType
+  audioReverbType?: keyof LivePusherProps.AudioReverbType
 
   /** 开启或关闭麦克风
    * @default true
@@ -161,7 +161,7 @@ interface LivePusherProps extends StandardProps {
    * @default "voicecall"
    * @supported weapp
    */
-  audioVolumeType?: keyof LivePusherProps.audioVolumeType
+  audioVolumeType?: keyof LivePusherProps.AudioVolumeType
 
   /** 上推的视频流的分辨率宽度
    * @default 360
@@ -179,13 +179,13 @@ interface LivePusherProps extends StandardProps {
    * @default smooth
    * @supported weapp
    */
-  beautyStyle?: keyof LivePusherProps.beautyStyleType
+  beautyStyle?: keyof LivePusherProps.BeautyStyleType
 
   /** 设置色彩滤镜
    * @default standard
    * @supported weapp
    */
-  filter?: keyof LivePusherProps.filterType
+  filter?: keyof LivePusherProps.FilterType
 
   /** 状态变化事件，detail = {code}
    * @supported weapp
@@ -225,14 +225,14 @@ interface LivePusherProps extends StandardProps {
 
 declare namespace LivePusherProps {
   /** orientation 的合法值 */
-  interface orientation {
+  interface Orientation {
     /** 竖直 */
     vertical
     /** 水平 */
     horizontal
   }
   /** localMirror 的合法值 */
-  interface localMirror {
+  interface LocalMirror {
     /** 前置摄像头镜像，后置摄像头不镜像 */
     auto
     /** 前后置摄像头均镜像 */
@@ -241,7 +241,7 @@ declare namespace LivePusherProps {
     disable
   }
   /** audioReverbType 的合法值 */
-  interface audioReverbType {
+  interface AudioReverbType {
     /** 关闭 */
     0
     /** KTV */
@@ -260,21 +260,21 @@ declare namespace LivePusherProps {
     7
   }
   /** audioVolumeType 的合法值 */
-  interface audioVolumeType {
+  interface AudioVolumeType {
     /** 媒体音量 */
     media
     /** 通话音量 */
     voicecall
   }
   /** beautyStyleType 的合法值 */
-  interface beautyStyleType {
+  interface BeautyStyleType {
     /** 光滑美颜 */
     smooth
     /** 自然美颜 */
     nature
   }
   /** filterType 的合法值 */
-  interface filterType {
+  interface FilterType {
     /** 标准 */
     standard
     /** 粉嫩 */
@@ -304,7 +304,7 @@ declare namespace LivePusherProps {
   }
   interface onNetstatusEventDetail {
     /** 网络状态 */
-    info: netStatus
+    info: NetStatus
   }
   interface onErrorEventDetail {
     /** 错误信息 */
@@ -324,7 +324,7 @@ declare namespace LivePusherProps {
  * 需要先通过类目审核，再在小程序管理后台，「开发」-「接口设置」中自助开通该组件权限。
  * @classification media
  * @supported weapp
- * @example
+ * @example_react
  * ```tsx
  * class App extends Components {
  *   render () {
@@ -334,6 +334,12 @@ declare namespace LivePusherProps {
  *   }
  * }
  * ```
+ * @example_vue
+ * ```html
+ * <template>
+ *   <live-pusher url="url" mode="RTC" :autopush="true"  />
+ * </template>
+ * ```
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/live-pusher.html
  */
 declare const LivePusher: ComponentType<LivePusherProps>