@tarojs/components 3.5.0-canary.1 → 3.5.0

package/types/Slot.d.ts

@@ -18,7 +18,7 @@ interface SlotProps {
  * @example
  * ```tsx
  * import { Slot, View, Text } from '@tarojs/components'
- * 
+ *
  * export default class SlotView extends Component {
  *   render () {
  *     return (
@@ -36,4 +36,4 @@ interface SlotProps {
  */
 declare const Slot: ComponentType<SlotProps>
 
-export { Slot, SlotProps }
+export { Slot, SlotProps }

package/types/Swiper.d.ts

@@ -63,13 +63,13 @@ interface SwiperProps extends StandardProps {
 
   /** 前边距，可用于露出前一项的一小部分，接受 px 和 rpx 值
    * @default "0px"
-   * @supported weapp, h5
+   * @supported weapp, h5, tt
    */
   previousMargin?: string
 
   /** 后边距，可用于露出后一项的一小部分，接受 px 和 rpx 值
    * @default "0px"
-   * @supported weapp, h5
+   * @supported weapp, h5, tt
    */
   nextMargin?: string
 
@@ -94,7 +94,7 @@ interface SwiperProps extends StandardProps {
 
   /** 指定 swiper 切换缓动动画类型
    * @default "default"
-   * @supported weapp
+   * @supported weapp, tt
    */
   easingFunction?: keyof SwiperProps.TEasingFunction
 
@@ -104,15 +104,15 @@ interface SwiperProps extends StandardProps {
   onChange?: CommonEventFunction<SwiperProps.onChangeEventDetail>
 
   /** swiper-item 的位置发生改变时会触发 transition 事件
-   * @supported weapp
+   * @supported weapp, tt
    */
   onTransition?: CommonEventFunction<SwiperProps.onTransitionEventDetail>
 
   /** 动画结束时会触发 animationfinish 事件
-   * @supported weapp, swan, h5, rn
+   * @supported weapp, swan, h5, rn, tt
    */
   onAnimationFinish?: SwiperProps['onChange']
-  
+
   /** 是否禁止用户 touch 操作
    * @default false
    * @supported alipay
@@ -151,7 +151,7 @@ declare namespace SwiperProps {
     /** 导致变更的原因 */
     source: keyof SwiperProps.TChangeSource
     /** SwiperItem的itemId参数值 */
-    currentItemId?: string 
+    currentItemId?: string
   }
 
   interface onTransitionEventDetail {

package/types/Switch.d.ts

@@ -10,7 +10,7 @@ interface SwitchProps extends StandardProps, FormItemProps {
 
   /** 是否禁用
    * @default false
-   * @supported weapp, rn
+   * @supported weapp, rn, tt
    */
   disabled?: boolean
 
@@ -27,7 +27,7 @@ interface SwitchProps extends StandardProps, FormItemProps {
   color?: string
 
   /** checked 改变时触发 change 事件
-   * @supported weapp, rn
+   * @supported weapp, rn, tt
    */
   onChange?: CommonEventFunction<SwitchProps.onChangeEventDetail>
 
@@ -51,7 +51,7 @@ declare namespace SwitchProps {
  *   constructor() {
  *     super(...arguments)
  *   }
- * 
+ *
  *   render() {
  *     return (
  *       <View className='components-page'>

package/types/Text.d.ts

@@ -94,7 +94,7 @@ declare namespace TextProps {
  *     <button class="btn-max-w button_style" :plain="true" type="default" `@tap="add">add line</button>
  *     <button class="btn-max-w button_style" :plain="true" type="default" :disabled="contentsLen ? false : true" `@tap="remove">remove line</button>
  * </template>
- * 
+ *
  * <script>
  * export default {
  *   data() {
@@ -110,7 +110,7 @@ declare namespace TextProps {
  *       this.contents = cot
  *       this.contentsLen = cot.length
  *     },
- * 
+ *
  *     remove () {
  *       const cot = this.contents.slice()
  *       cot.pop()

package/types/Textarea.d.ts

@@ -3,35 +3,35 @@ import { StandardProps, CommonEventFunction, FormItemProps } from './common'
 
 interface TextareaProps extends StandardProps, FormItemProps {
   /** 输入框的内容
-   * @supported weapp, h5, rn
+   * @supported weapp, h5, rn, tt
    */
   value?: string
 
   /** 输入框为空时占位符
-   * @supported weapp, h5, rn
+   * @supported weapp, h5, rn, tt
    */
   placeholder?: string
 
   /** 指定 placeholder 的样式
-   * @supported weapp
+   * @supported weapp, tt
    */
   placeholderStyle?: string
 
   /** 指定 placeholder 的样式类
    * @default "textarea-placeholder"
-   * @supported weapp
+   * @supported weapp, tt
    */
   placeholderClass?: string
 
   /** 是否禁用
    * @default false
-   * @supported weapp, h5, rn
+   * @supported weapp, h5, rn, tt
    */
   disabled?: boolean
 
   /** 最大输入长度，设置为 -1 的时候不限制最大长度
    * @default 140
-   * @supported weapp, h5, rn
+   * @supported weapp, h5, rn, tt
    */
   maxlength?: number
 
@@ -43,13 +43,13 @@ interface TextareaProps extends StandardProps, FormItemProps {
 
   /** 获取焦点
    * @default false
-   * @supported weapp, rn
+   * @supported weapp, rn, tt
    */
   focus?: boolean
 
   /** 是否自动增高，设置 autoHeight 时，style.height不生效
    * @default false
-   * @supported weapp, rn
+   * @supported weapp, rn, tt
    */
   autoHeight?: boolean
 
@@ -61,76 +61,76 @@ interface TextareaProps extends StandardProps, FormItemProps {
 
   /** 指定光标与键盘的距离，单位 px 。取 Textarea 距离底部的距离和 cursorSpacing 指定的距离的最小值作为光标与键盘的距离
    * @default 0
-   * @supported weapp
+   * @supported weapp, tt
    */
   cursorSpacing?: number
 
   /** 指定 focus 时的光标位置
    * @default -1
-   * @supported weapp
+   * @supported weapp, tt
    */
   cursor?: number
 
   /** 是否显示键盘上方带有”完成“按钮那一栏
    * @default true
-   * @supported weapp
+   * @supported weapp, tt
    */
   showConfirmBar?: boolean
 
   /** 光标起始位置，自动聚集时有效，需与 selectionEnd 搭配使用
    * @default -1
-   * @supported weapp, rn
+   * @supported weapp, rn, tt
    */
   selectionStart?: number
 
   /** 光标结束位置，自动聚集时有效，需与 selectionStart 搭配使用
    * @default -1
-   * @supported weapp, rn
+   * @supported weapp, rn, tt
    */
   selectionEnd?: number
 
   /** 键盘弹起时，是否自动上推页面
    * @default true
-   * @supported weapp
+   * @supported weapp, tt
    */
   adjustPosition?: boolean
 
   /** focus 时，点击页面的时候不收起键盘
    * @default false
-   * @supported weapp
+   * @supported weapp, tt
    */
   holdKeyboard?: boolean
 
   /** 是否去掉 iOS 下的默认内边距
    * @default false
-   * @supported weapp
+   * @supported weapp, tt
    */
   disableDefaultPadding?: boolean
 
   /** 输入框聚焦时触发
-   * @supported weapp, h5, rn
+   * @supported weapp, h5, rn, tt
    */
   onFocus?: CommonEventFunction<TextareaProps.onFocusEventDetail>
 
   /** 输入框失去焦点时触发
-   * @supported weapp, h5, rn
+   * @supported weapp, h5, rn, tt
    */
   onBlur?: CommonEventFunction<TextareaProps.onBlurEventDetail>
 
   /** 输入框行数变化时调用，event.detail = {height: 0, heightRpx: 0, lineCount: 0}
-   * @supported weapp, rn
+   * @supported weapp, rn, tt
    */
   onLineChange?: CommonEventFunction<TextareaProps.onLineChangeEventDetail>
 
   /** 当键盘输入时，触发 input 事件，event.detail = {value, cursor, keyCode}
    *
    * **onInput 处理函数的返回值并不会反映到 textarea 上**
-   * @supported weapp, h5, rn
+   * @supported weapp, h5, rn, tt
    */
   onInput?: CommonEventFunction<TextareaProps.onInputEventDetail>
 
   /** 点击完成时， 触发 confirm 事件，event.detail = {value: value}
-   * @supported weapp, rn
+   * @supported weapp, rn, tt
    */
   onConfirm?: CommonEventFunction<TextareaProps.onConfirmEventDetail>
 

package/types/Video.d.ts

@@ -76,21 +76,21 @@ interface VideoProps extends StandardProps {
 
   /** 若不设置，宽度大于240时才会显示
    * @default true
-   * @supported weapp, swan
+   * @supported weapp, swan, tt
    * @h5 待定
    */
   showProgress?: boolean
 
   /** 是否显示全屏按钮
    * @default true
-   * @supported weapp, swan, alipay
+   * @supported weapp, swan, alipay, tt
    * @h5 待定
    */
   showFullscreenBtn?: boolean
 
   /** 是否显示视频底部控制栏的播放按钮
    * @default true
-   * @supported weapp, swan, alipay
+   * @supported weapp, swan, alipay, tt
    * @h5 待定
    */
   showPlayBtn?: boolean
@@ -104,17 +104,17 @@ interface VideoProps extends StandardProps {
 
   /** 是否开启控制进度的手势
    * @default true
-   * @supported weapp, swan, alipay
+   * @supported weapp, swan, alipay, tt
    * @h5 待定
    */
   enableProgressGesture?: boolean
 
   /** 当视频大小与 video 容器大小不一致时，视频的表现形式
    * @default "contain"
-   * @supported weapp, swan, alipay
+   * @supported weapp, swan, alipay, tt
    * @h5 待定
    */
-  objectFit?: keyof VideoProps.objectFit
+  objectFit?: keyof VideoProps.ObjectFit
 
   /** 视频封面的图片网络资源地址，如果 controls 属性值为 false 则设置 poster 无效
    * @supported weapp, h5, swan, alipay, tt, rn
@@ -123,7 +123,7 @@ interface VideoProps extends StandardProps {
 
   /** 是否显示静音按钮
    * @default false
-   * @supported weapp
+   * @supported weapp, tt
    * @h5 待定
    */
   showMuteBtn?: boolean
@@ -139,14 +139,14 @@ interface VideoProps extends StandardProps {
    * - `center`: 视频中间
    *
    * @default 'bottom'
-   * @supported weapp
+   * @supported weapp, tt
    * @h5 待定
    */
-  playBtnPosition?: keyof VideoProps.playBtnPosition
+  playBtnPosition?: keyof VideoProps.PlayBtnPosition
 
   /** 是否开启播放手势，即双击切换播放/暂停
    * @default false
-   * @supported weapp
+   * @supported weapp, tt
    * @h5 待定
    */
   enablePlayGesture?: boolean
@@ -167,14 +167,14 @@ interface VideoProps extends StandardProps {
 
   /** 在非全屏模式下，是否开启亮度与音量调节手势（同 `page-gesture`）
    * @default false
-   * @supported weapp, swan
+   * @supported weapp, swan, tt
    * @h5 待定
    */
   vslideGesture?: boolean
 
   /** 在全屏模式下，是否开启亮度与音量调节手势
    * @default true
-   * @supported weapp
+   * @supported weapp, tt
    * @h5 待定
    */
   vslideGestureInFullscreen?: boolean
@@ -203,12 +203,12 @@ interface VideoProps extends StandardProps {
   /**
    * 是否在小窗模式下显示播放进度（目前有bug，先注释掉）
    * @supported weapp
-   * 
+   *
    * 先注释掉，原因如下：
    * 该属性超过了 wxml 属性的长度限制，实际无法使用且导致编译报错。可等微信官方修复后再放开。
    * 参考1：https://developers.weixin.qq.com/community/develop/doc/000a429beb87f0eac07acc0fc5b400
    * 参考2: https://developers.weixin.qq.com/community/develop/doc/0006883619c48054286a4308258c00?_at=vyxqpllafi
-   * 
+   *
    */
   // pictureInPictureShowProgress?: boolean
 
@@ -217,7 +217,7 @@ interface VideoProps extends StandardProps {
    * @supported weapp
    */
   enableAutoRotation?: boolean
-  
+
   /**
    * 是否显示锁屏按钮，仅在全屏时显示，锁屏后控制栏的操作
    * @supported weapp
@@ -249,7 +249,7 @@ interface VideoProps extends StandardProps {
   /** 当视频进入和退出全屏时触发
    *
    * event.detail = {fullScreen, direction}，direction取为 vertical 或 horizontal
-   * @supported weapp, swan, alipay, rn
+   * @supported weapp, swan, alipay, rn, tt
    * @h5 待定
    */
   onFullscreenChange?: CommonEventFunction<VideoProps.onFullscreenChangeEventDetail>
@@ -257,7 +257,7 @@ interface VideoProps extends StandardProps {
   /** 当视频进入和退出全屏时触发
    *
    * event.detail = {fullScreen, direction}，direction 取为 vertical 或 horizontal
-   * @supported weapp, swan
+   * @supported weapp, swan, tt
    * @h5 待定
    */
   onWaiting?: CommonEventFunction<VideoProps.onWaitingEventDetail>
@@ -273,7 +273,7 @@ interface VideoProps extends StandardProps {
   onProgress?: CommonEventFunction<VideoProps.onProgressEventDetail>
 
   /** 视频元数据加载完成时触发。event.detail = {width, height, duration}
-   * @supported weapp, rn
+   * @supported weapp, rn, tt
    */
   onLoadedMetaData?: CommonEventFunction
 
@@ -318,7 +318,7 @@ declare namespace VideoProps {
     '-90'
   }
   /** objectFit 的合法值 */
-  interface objectFit {
+  interface ObjectFit {
     /** 包含 */
     contain
     /** 填充 */
@@ -327,7 +327,7 @@ declare namespace VideoProps {
     cover
   }
   /** playBtnPosition 的合法值 */
-  interface playBtnPosition {
+  interface PlayBtnPosition {
     /** controls bar上 */
     bottom
     /** 视频中间 */
@@ -364,7 +364,7 @@ declare namespace VideoProps {
 }
 
 /** 视频。相关api：Taro.createVideoContext
- * 
+ *
  * 备注：h5上因为没有测试，所以暂时写了“待定”，需要`Video`来确认。
  * @classification media
  * @supported weapp, h5, swan, alipay, tt
@@ -374,7 +374,7 @@ declare namespace VideoProps {
  *   constructor() {
  *     super(...arguments)
  *   }
- * 
+ *
  *   render() {
  *     return (
  *       <View className='components-page'>
@@ -382,7 +382,7 @@ declare namespace VideoProps {
  *           id='video'
  *           src='https://wxsnsdy.tc.qq.com/105/20210/snsdyvideodownload?filekey=30280201010421301f0201690402534804102ca905ce620b1241b726bc41dcff44e00204012882540400&bizid=1023&hy=SH&fileparam=302c020101042530230204136ffd93020457e3c4ff02024ef202031e8d7f02030f42400204045a320a0201000400'
  *           poster='https://misc.aotu.io/booxood/mobile-video/cover_900x500.jpg'
- *           initialTime='0'
+ *           initialTime={0}
  *           controls={true}
  *           autoplay={false}
  *           loop={false}

package/types/View.d.ts

@@ -1,16 +1,16 @@
 import { ComponentType } from 'react'
-import { StandardProps } from './common'
 import { StyleProp, ViewStyle } from 'react-native'
+import { StandardProps } from './common'
 
 interface ViewProps extends StandardProps {
   /** 指定按下去的样式类。当 `hover-class="none"` 时，没有点击态效果
    * @default none
    * @supported weapp, swan, alipay, tt, h5
-   * @rn 由于 RN 不支持 Class，故 RN 端的 View 组件实现了 `hoverStyle`属性，写法和 style 类似，只不过 `hoverStyle` 的样式是指定按下去的样式。
+   * @rn 由于 RN 不支持 hoverClass，故 RN 端的 View 组件实现了 `hoverStyle`属性，写法和 style 类似，只不过 `hoverStyle` 的样式是指定按下去的样式。
    */
   hoverClass?: string
 
-  /** 由于 RN 不支持 Class，故 RN 端的 View 组件实现了 `hoverStyle`属性，写法和 style 类似，只不过 `hoverStyle` 的样式是指定按下去的样式。
+  /** 由于 RN 不支持 hoverClass，故 RN 端的 View 组件实现了 `hoverStyle`属性，写法和 style 类似，只不过 `hoverStyle` 的样式是指定按下去的样式。
    * @default none
    * @supported rn
    */
@@ -86,7 +86,7 @@ interface ViewProps extends StandardProps {
  *     </view>
  *   </view>
  * </template>
- * 
+ *
  * <style>
  * .flex-wrp { display: flex; }
  * .flex-wrp-column{ flex-direction: column; }

package/types/VoipRoom.d.ts

@@ -12,13 +12,13 @@ interface VoipRoomProps extends StandardProps {
    * @default camera
    * @supported weapp
    */
-  mode?: keyof VoipRoomProps.mode
+  mode?: keyof VoipRoomProps.Mode
 
   /** 仅在 mode 为 camera 时有效，前置或后置，值为front, back
    * @default front
    * @supported weapp
    */
-  devicePosition?: keyof VoipRoomProps.devicePosition
+  devicePosition?: keyof VoipRoomProps.DevicePosition
 
   /** 创建对话窗口失败时触发
    * @supported weapp
@@ -28,13 +28,13 @@ interface VoipRoomProps extends StandardProps {
 
 declare namespace VoipRoomProps {
   /** 对话窗口类型 */
-  interface mode {
+  interface Mode {
     camera
     video
   }
 
   /** 摄像头类型 */
-  interface devicePosition {
+  interface DevicePosition {
     front
     back
   }
@@ -42,7 +42,7 @@ declare namespace VoipRoomProps {
 
 /** 多人音视频对话
  *
- * 需用户授权 `scope.camera`、`scope.record`。相关接口： [Taro.joinVoIPChat](https://developers.weixin.qq.com/miniprogram/dev/api/media/voip/wx.joinVoIPChat.html)
+ * 需用户授权 `scope.camera`、`scope.record`。相关接口： [Taro.joinVoIPChat](/docs/apis/media/voip/joinVoIPChat)
  * 开通该组件权限后，开发者可在 joinVoIPChat 成功后，获取房间成员的 openid，传递给 voip-room 组件，以显示成员画面。
  * @classification media
  * @supported weapp

package/types/WebView.d.ts

@@ -3,22 +3,22 @@ import { StandardProps, CommonEventFunction } from './common'
 
 interface WebViewProps extends StandardProps {
   /** webview 指向网页的链接。可打开关联的公众号的文章，其它网页需登录小程序管理后台配置业务域名。
-   * @supported weapp, h5
+   * @supported weapp, h5, rn, tt
    */
   src: string
 
   /** 网页向小程序 postMessage 时，会在特定时机（小程序后退、组件销毁、分享）触发并收到消息。e.detail = { data }
-   * @supported weapp
+   * @supported weapp, tt
    */
   onMessage?: CommonEventFunction<WebViewProps.onMessageEventDetail>
 
   /** 网页加载成功时候触发此事件。e.detail = { src }
-   * @supported weapp, h5
+   * @supported weapp, h5, rn, tt
    */
   onLoad?: CommonEventFunction<WebViewProps.onLoadEventDetail>
 
   /** 网页加载失败的时候触发此事件。e.detail = { src }
-   * @supported weapp, h5
+   * @supported weapp, h5, rn, tt
    */
   onError?: CommonEventFunction<WebViewProps.onErrorEventDetail>
 }
@@ -40,12 +40,12 @@ declare namespace WebViewProps {
 
 /** web-view 组件是一个可以用来承载网页的容器，会自动铺满整个小程序页面。个人类型与海外类型的小程序暂不支持使用。
  * @classification open
- * @supported weapp, h5, rn
+ * @supported weapp, h5, rn, tt
  * @example_react
  * ```tsx
  * class App extends Component {
  *   handleMessage () {}
- *   
+ *
  *   render () {
  *     return (
  *       <WebView src='https://mp.weixin.qq.com/' onMessage={this.handleMessage} />

package/types/common.d.ts

@@ -7,6 +7,8 @@ export interface StandardProps<T = any, TouchEvent extends BaseTouchEvent<any> =
   className?: string
   /** 组件的内联样式, 可以动态设置的内联样式 */
   style?: string | CSSProperties
+  /** 子节点 */
+  children?: ReactNode
   /** 如果列表中项目的位置会动态改变或者有新的项目添加到列表中，
    * 需要使用 `wx:key` 来指定列表中项目的唯一的标识符。
    */
@@ -19,7 +21,7 @@ export interface StandardProps<T = any, TouchEvent extends BaseTouchEvent<any> =
   ref?: LegacyRef<T>
   /**
    * 渲染 HTML
-   * @see https://taro-docs.jd.com/taro/docs/html
+   * @see /docs/html
    */
   dangerouslySetInnerHTML?: {
     __html: string
@@ -147,7 +149,7 @@ export interface Target {
 export type currentTarget = Target
 
 /** 网络状态数据 */
-export interface netStatus {
+export interface NetStatus {
   /* 当前视频编/码器输出的比特率，单位 kbps */
   videoBitrate?: number
   /* 当前音频编/码器输出的比特率，单位 kbps */