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

package/types/PickerViewColumn.d.ts

@@ -5,7 +5,7 @@ type PickerViewColumnProps = StandardProps
 /** 滚动选择器子项
  * 仅可放置于 `<PickerView />` 中，其孩子节点的高度会自动设置成与 picker-view 的选中框的高度一致
  * @classification forms
- * @supported weapp, swan, alipay, tt, h5, rn
+ * @supported weapp, swan, alipay, tt, h5, rn, harmony
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/picker-view-column.html
  */
 declare const PickerViewColumn: ComponentType<StandardProps>

package/types/Progress.d.ts

@@ -81,7 +81,7 @@ interface ProgressProps extends StandardProps {
 
 /** 进度条。组件属性的长度单位默认为 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/Radio.d.ts

@@ -44,7 +44,7 @@ interface RadioProps extends StandardProps {
 
 /** 单选项目
  * @classification forms
- * @supported weapp, h5, rn, tt
+ * @supported weapp, alipay, swan, tt, qq, h5, rn, harmony
  * @example_react
  * ```tsx
  * export default class PageRadio extends Component {

package/types/RadioGroup.d.ts

@@ -19,7 +19,7 @@ declare namespace RadioGroupProps {
 
 /** 单项选择器，内部由多个 Radio 组成。
  * @classification forms
- * @supported weapp, h5, rn, tt
+ * @supported weapp, alipay, swan, tt, qq, h5, rn, harmony
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/radio-group.html
  */
 declare const RadioGroup: ComponentType<RadioGroupProps>

package/types/RichText.d.ts

@@ -118,7 +118,7 @@ declare namespace RichTextProps {
 
 /** 富文本
  * @classification base
- * @supported weapp, swan, alipay, tt, h5, rn
+ * @supported weapp, swan, alipay, tt, h5, rn, harmony
  * @example_react
  * ```tsx
  * class App extends Components {

package/types/RootPortal.d.ts

@@ -1,4 +1,13 @@
 import { ComponentType } from 'react'
+import { StandardProps } from './common'
+interface RootPortalProps extends StandardProps {
+  /**
+   * 是否从页面中脱离出来
+   * @supported weapp
+   * @default true
+   */
+  enable?: boolean
+}
 
 /** root-portal
  * 使整个子树从页面中脱离出来，类似于在 CSS 中使用 fixed position 的效果。主要用于制作弹窗、弹出层等。
@@ -28,6 +37,6 @@ import { ComponentType } from 'react'
  * }
  * ```
  */
-declare const RootPortal: ComponentType
+declare const RootPortal: ComponentType<RootPortalProps>
 
-export { RootPortal }
+export { RootPortal, RootPortalProps }

package/types/RtcRoom.d.ts

@@ -0,0 +1,104 @@
+import { ComponentType } from 'react'
+import { StandardProps } from './common'
+interface RtcRoomProps extends StandardProps {
+  /** rtc-room 组件的唯一标识符
+   * @supported swan
+   */
+  id?: string
+
+  /** 是否开启摄像头
+   * @supported swan
+   * @default true
+   */
+  enableCamera?: boolean
+
+  /** 是否开启摄像头自动对焦
+   * @supported swan
+   * @default true
+   */
+  enableAutoFocus?: boolean
+
+  /** 是否支持双手滑动调整摄像头聚焦
+   * @supported swan
+   * @default false
+   */
+  enableZoom?: boolean
+
+  /** 设置前置还是后置摄像头，有效值：front、back
+   * @supported swan
+   * @default "front"
+   */
+  devicePosition?: 'front' | 'back'
+
+  /** 是否开启麦克风
+   * @supported swan
+   * @default true
+   */
+  enableMic?: boolean
+
+  /** 是否开启音频自动增益
+   * @supported swan
+   * @default false
+   */
+  enableAgc?: boolean
+
+  /** 是否开启音频噪声抑制
+   * @supported swan
+   * @default false
+   */
+  enableAns?: boolean
+
+  /** 最大码率
+   * @supported swan
+   * @default 900
+   */
+  bitrate?: number
+
+  /** 视频分辨率宽
+   * @supported swan
+   * @default 360
+   */
+  videoWidth?: number
+
+  /** 视频分辨率高
+   * @supported swan
+   * @default 640
+   */
+  videoHeight?: number
+
+  /** 设置远端看到的画面的镜像效果，该属性的变化不会影响到本地画面，仅影响远端看到的画面效果
+   * @supported swan
+   * @default false
+   */
+  enableRemoteMirror?: boolean
+
+  /** 设置本地摄像头预览画面的镜像效果，有效值：auto、enable、disable
+   * @supported swan
+   * @default "auto"
+   */
+  localMirror?: 'auto' | 'enable' | 'disable'
+
+  /** 设置声音输出方式，有效值：speaker、ear
+   * @supported swan
+   * @default "speaker"
+   */
+  soundMode?: 'speaker' | 'ear'
+
+  /** 房间状态变化事件，参考下方状态码，detail = { code, msg, userInfo }
+   * @supported swan
+   */
+  onStateChange?: CommonEventFunction
+
+  /** 错误事件。参考下方错误码，detail = { errMsg, errCode }
+   * @supported swan
+   */
+  onError?: CommonEventFunction
+}
+
+/** 实时音视频通话房间
+ * @classification media
+ * @supported swan
+ * @see https://smartprogram.baidu.com/docs/develop/component/media_rtc-room/
+ */
+declare const RtcRoom: ComponentType<RtcRoomProps>
+export { RtcRoom, RtcRoomProps }

package/types/RtcRoomItem.d.ts

@@ -0,0 +1,26 @@
+import { ComponentType } from 'react'
+import { StandardProps } from './common'
+interface RtcRoomItemProps extends StandardProps {
+  /** rtc-room-item 组件的唯一标识符
+   * @supported swan
+   */
+  id?: string
+
+  /** 指定 item 展示本地 / 远端画面，有效值：local、remote ，不可动态变更
+   * @supported swan
+   */
+  type?: string
+
+  /** item 展示画面的用户 id
+   * @supported swan
+   */
+  userId?: number
+}
+
+/** 实时音视频通话画面
+ * @classification media
+ * @supported swan
+ * @see https://smartprogram.baidu.com/docs/develop/component/media_rtc-room-item/
+ */
+declare const RtcRoomItem: ComponentType<RtcRoomItemProps>
+export { RtcRoomItem, RtcRoomItemProps }

package/types/ScrollView.d.ts

@@ -262,7 +262,7 @@ declare namespace ScrollViewProps {
  * H5 中 ScrollView 组件是通过一个高度（或宽度）固定的容器内部滚动来实现的，因此务必正确的设置容器的高度。例如: 如果 ScrollView 的高度将 body 撑开，就会同时存在两个滚动条（body 下的滚动条，以及 ScrollView 的滚动条）。
  * 微信小程序 中 ScrollView 组件如果设置 scrollX 横向滚动时，并且子元素为多个时（单个子元素时设置固定宽度则可以正常横向滚动），需要通过 WXSS 设置 `white-space: nowrap` 来保证元素不换行，并对 ScrollView 内部元素设置 `display: inline-block` 来使其能够横向滚动。
  * @classification viewContainer
- * @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/ShareElement.d.ts

@@ -1,28 +1,38 @@
 import { ComponentType } from 'react'
 import { StandardProps, CommonEventFunction } from './common'
 interface ShareElementProps extends StandardProps {
+  /** 映射标记
+   * @supported weapp
+   */
+  key?: string
+
+  /** 映射标记
+   * @supported weapp
+   */
+  mapkey?: string
+
+  /** 映射标记
+   * @supported alipay
+   */
+  name?: string
+
   /** 是否进行动画
    * @default false
-   * @supported weapp
+   * @supported weapp, alipay
    */
   transform?: boolean
 
   /** 动画时长，单位毫秒
    * @default 300
-   * @supported weapp
+   * @supported weapp, alipay
    */
   duration?: number
 
   /** css缓动函数
    * @default ease-out
-   * @supported weapp
+   * @supported weapp, alipay
    */
-  easingFunction?: number
-
-  /** 映射标记
-   * @supported weapp
-   */
-  key?: string
+  easingFunction?: string
 }
 
 /** 共享元素
@@ -30,7 +40,7 @@ interface ShareElementProps extends StandardProps {
  * 共享元素是一种动画形式，类似于 [`flutter Hero`](https://flutterchina.club/animations/hero-animations/) 动画，表现为元素像是在页面间穿越一样。该组件需与 [`PageContainer`](/docs/components/viewContainer/page-container) 组件结合使用。
  * 使用时需在当前页放置 `ShareElement` 组件，同时在 `PageContainer` 容器中放置对应的 `ShareElement` 组件，对应关系通过属性值 key 映射。当设置 `PageContainer` `显示时，transform` 属性为 `true` 的共享元素会产生动画。当前页面容器退出时，会产生返回动画。
  * @classification viewContainer
- * @supported weapp
+ * @supported weapp, alipay
  * @example_react
  * ```tsx
  * // index.js

package/types/Slider.d.ts

@@ -118,7 +118,7 @@ declare namespace SliderProps {
 
 /** 滑动选择器
  * @classification forms
- * @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/Slot.d.ts

@@ -5,7 +5,7 @@ interface SlotProps {
    * @default none
    * @supported weapp, swan, alipay, tt, jd, qq
    */
-  name?: string,
+  name?: string
   /** scoped slot 传入数据源
    * @default none
    * @supported swan
@@ -14,7 +14,8 @@ interface SlotProps {
 }
 
 /** slot 插槽
- * @supported weapp, swan, alipay, tt, jd, qq
+ * @classification viewContainer
+ * @supported weapp, swan, alipay, tt, jd, qq, harmony
  * @example
  * ```tsx
  * import { Slot, View, Text } from '@tarojs/components'

package/types/Swiper.d.ts

@@ -103,6 +103,18 @@ interface SwiperProps extends StandardProps {
    */
   disableTouch?: boolean
 
+  /** 是否启用缩放
+   * @default false
+   * @supported h5
+   */
+  zoom?: boolean
+
+  /** 是否开启全屏
+   * @default false
+   * @supported h5
+   */
+  full?: boolean
+
   /** swiper-item 可见时的 class。
    * @supported alipay
    */
@@ -235,7 +247,7 @@ declare namespace SwiperProps {
 /** 滑块视图容器。其中只可放置 swiper-item 组件，否则会导致未定义的行为。
  * > 不要为 `SwiperItem` 设置 **style** 属性，可以通过 class 设置样式。[7147](https://github.com/NervJS/taro/issues/7147)
  * @classification viewContainer
- * @supported weapp, swan, alipay, tt, h5, rn
+ * @supported weapp, alipay, swan, tt, qq, jd, h5, rn, harmony
  * @example_react
  * ```tsx
  * class App extends Component {

package/types/SwiperItem.d.ts

@@ -7,15 +7,16 @@ interface SwiperItemProps extends StandardProps {
   itemId?: string
 
   /** 是否跳过未显示的滑块布局，设为 true 可优化复杂情况下的滑动性能，但会丢失隐藏状态滑块的布局信息
+   * @default false
    * @supported weapp
    */
-  skipHiddenItemLayout?: string
+  skipHiddenItemLayout?: boolean
 }
 
 /** 仅可放置在 swiper 组件中，宽高自动设置为100%
  * > 不要为 `SwiperItem` 设置 **style** 属性，可以通过 class 设置样式。[7147](https://github.com/NervJS/taro/issues/7147)
  * @classification viewContainer
- * @supported weapp, swan, alipay, tt, h5, rn
+ * @supported weapp, alipay, swan, tt, jd, h5, rn, harmony
  * @example_react
  * ```tsx
  * class App extends Component {

package/types/Switch.d.ts

@@ -93,7 +93,7 @@ declare namespace SwitchProps {
  *   </view>
  * </template>
  * ```
- * @supported weapp, h5, rn, swan, alipay, tt
+ * @supported weapp, alipay, swan, tt, qq, jd, h5, rn, harmony
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/switch.html
  */
 declare const Switch: ComponentType<SwitchProps>

package/types/TabItem.d.ts

@@ -0,0 +1,35 @@
+import { ComponentType } from 'react'
+import { StandardProps } from './common'
+interface TabItemProps extends StandardProps {
+  /** tab-item 内显示的文字
+   * @supported swan
+   * @default 无
+   */
+  label?: string
+
+  /** tab-item 对应的 name 值
+   * @supported swan
+   * @default 无
+   */
+  name?: string
+
+  /** 徽标类型 badge-type 分为圆点“dot”和文本“text”，不设置 badge-type 则不显示徽标
+   * @supported swan
+   * @default 无
+   */
+  badgeType?: string
+
+  /** badge-type 为 text 的时候，徽标内的数字，为空时badge-type="text"不生效
+   * @supported swan
+   * @default 无
+   */
+  badgeText?: string
+}
+
+/** 标签栏子项
+ * @classification navig
+ * @supported swan
+ * @see https://smartprogram.baidu.com/docs/develop/component/tab-item/
+ */
+declare const TabItem: ComponentType<TabItemProps>
+export { TabItem, TabItemProps }

package/types/Tabs.d.ts

@@ -0,0 +1,58 @@
+import { ComponentType } from 'react'
+import { StandardProps } from './common'
+interface TabsProps extends StandardProps {
+  /** tabs 背景色,必须填写十六进制颜色
+   * @supported swan
+   * @default "#fff"
+   */
+  tabsBackgroundColor?: string
+
+  /** tabs 激活 tab-item 文字颜色
+   * @supported swan
+   * @default "#000"
+   */
+  tabsActiveTextColor?: string
+
+  /** tabs 非激活 tab-item 文字颜色
+   * @supported swan
+   * @default "#666"
+   */
+  tabsInactiveTextColor?: string
+
+  /** tabs 激活 tab-item 下划线颜色
+   * @supported swan
+   * @default "#333"
+   */
+  tabsUnderlineColor?: string
+
+  /** 仅用于普通标签栏组件，当前激活 tab-item 的对应的 name 值，须搭配 bindtabchange 一起使用。
+   * @supported swan
+   * @default 无
+   */
+  activeName?: string
+
+  /** 仅用于可寻址标签栏组件，当前 tab 所改变的 url query 中参数 key，需要通过 tabs 修改页面 url 的时候设置。
+   * @supported swan
+   * @default 无
+   */
+  urlQueryName?: string
+
+  /** 当前 tabs 视图中最多容纳的 tab-item 数量，低于此数量均分排列，超出此数量划屏。默认五个，开发者可根据业务需求调整
+   * @supported swan
+   * @default 5
+   */
+  maxTabItemAmount?: number
+
+  /** tab 被点击的回调，可以在 e.detail.name 中取到当前点击的 tab-item 对应的 name 值
+   * @supported swan
+   */
+  onTabChange?: CommonEventFunction
+}
+
+/** 标签栏
+ * @classification navig
+ * @supported swan
+ * @see https://smartprogram.baidu.com/docs/develop/component/tabs/
+ */
+declare const Tabs: ComponentType<TabsProps>
+export { Tabs, TabsProps }

package/types/Text.d.ts

@@ -45,7 +45,7 @@ declare namespace TextProps {
 
 /** 文本
  * @classification base
- * @supported weapp, swan, alipay, tt, h5, rn
+ * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
  * @example_react
  * ```tsx
  * export default class PageView extends Component {

package/types/Textarea.d.ts

@@ -136,6 +136,12 @@ interface TextareaProps extends StandardProps, FormItemProps {
    */
   controlled?: string
 
+  /** 使用原生键盘
+   * @default false
+   * @supported alipay
+   */
+  enableNative?: boolean
+
   /** 无障碍访问，（属性）元素的额外描述
    * @supported qq
    */
@@ -218,7 +224,7 @@ declare namespace TextareaProps {
 
 /** 多行输入框。该组件是原生组件，使用时请注意相关限制
  * @classification forms
- * @supported weapp, h5, rn
+ * @supported weapp, alipay, swan, tt, qq, h5, rn, harmony
  * @example_react
  * ```tsx
  * export default class PageView extends Component {

package/types/Video.d.ts

@@ -282,6 +282,12 @@ interface VideoProps extends StandardProps {
    */
   mobilenetHintType?: string
 
+  /** 使用原生
+   * @default true
+   * @supported alipay
+   */
+  enableNative?: boolean
+
   /** 浮窗设置。暂时不支持全局浮窗。
    * 可选值：
    *
@@ -636,10 +642,8 @@ declare namespace VideoProps {
 }
 
 /** 视频。相关api：Taro.createVideoContext
- *
- * 备注：h5上因为没有测试，所以暂时写了“待定”，需要`Video`来确认。
  * @classification media
- * @supported weapp, h5, swan, alipay, tt
+ * @supported weapp, alipay, swan, tt, qq, jd, h5, rn, harmony
  * @example_react
  * ```tsx
  * export default class PageView extends Component {

package/types/View.d.ts

@@ -67,12 +67,6 @@ interface ViewProps extends StandardProps {
    */
   ariaLabel?: string
 
-  /** 是否以 catch 的形式绑定 touchmove 事件
-   * @supported weapp, alipay, swan, tt, qq, jd
-   * @version 3.1.0+
-   */
-  catchMove?: boolean
-
   /** 点击。
    * @supported alipay
    */
@@ -137,11 +131,18 @@ interface ViewProps extends StandardProps {
    * @supported alipay
    */
   onFirstAppear?: CommonEventFunction
+
+  /** 是否以 catch 的形式绑定 touchmove 事件
+   * @supported weapp, alipay, swan, tt, qq, jd
+   * @version 3.1.0+
+   * @unique
+   */
+  catchMove?: boolean
 }
 
 /** 视图容器
  * @classification viewContainer
- * @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/VoipRoom.d.ts

@@ -14,7 +14,7 @@ interface VoipRoomProps extends StandardProps {
   devicePosition?: keyof VoipRoomProps.DevicePosition
 
   /** 进入房间用户的 openid
-   * @default none
+   * @default "none"
    * @supported weapp
    */
   openId?: string

package/types/WebView.d.ts

@@ -49,7 +49,7 @@ declare namespace WebViewProps {
 
 /** web-view 组件是一个可以用来承载网页的容器，会自动铺满整个小程序页面。个人类型与海外类型的小程序暂不支持使用。
  * @classification open
- * @supported weapp, h5, rn, tt
+ * @supported weapp, alipay, swan, tt, qq, jd, h5, rn, harmony
  * @example_react
  * ```tsx
  * class App extends Component {