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

package/types/Lottie.d.ts

@@ -0,0 +1,113 @@
+import { ComponentType } from 'react'
+import { StandardProps } from './common'
+interface LottieProps extends StandardProps {
+  /** 是否自动播放。
+   * @supported alipay
+   * @default false
+   */
+  autoplay?: boolean
+
+  /** Lottie 资源地址。包含近端（包内地址）和远端（网络）的 JSON 文件地址。
+   * 与 djangoId 二选一。
+   * @supported alipay
+   */
+  path?: string
+
+  /** 播放速度。正数为正向播放，负数负向播放。
+   * @supported alipay
+   * @default 1.0
+   */
+  speed?: number
+
+  /** 循环次数。
+   *
+   * 如果是负数表示无限次。
+   * 如果是 0 表示不循环，播放一次。
+   * 如果是 1 表示循环一次，播放两次。
+   * @supported alipay
+   * @default 0
+   */
+  repeatCount?: number
+
+  /** 是否自动回播。
+   * @supported alipay
+   * @default false
+   */
+  autoReverse?: boolean
+
+  /** 资源地址。"/" 表明是小程序根目录。
+   * @supported alipay
+   */
+  assetsPath?: string
+
+  /** 兜底图或者降级图地址。
+   *
+   * 1. 支持本地资源，案例：'/image/lottie/lottie2_default.png'。
+   * 支持 http 的 cdn 地址、近端地址。
+   * 小程序场景不支持 djangoId。
+   * @supported alipay
+   */
+  placeholder?: string
+
+  /** 在线资源的 md5 校验。
+   * djangoId=https://b.zip。
+   * 可以使用 b.zip 加密 获取 md5 值
+   * md5="77c6c86fc89ba94cc0a9271b77ae77d2"
+   * @supported alipay
+   */
+  md5?: string
+
+  /** 降级。降级是指如遇低端设备，Lottie 会降级展示为 placeholder。
+   * 当 optimize 为 true ，并且传入了 placeholder 时，在低端设备上只会展示 placeholder，不展示 Lottie。
+   * 低端设备如下所示：
+   *
+   * iOS ：小于等于 iPhone6P
+   * Android：内存容量小于 3G
+   * @supported alipay
+   * @default false
+   */
+  optimize?: boolean
+
+  /** 当数据下载+视图创建完成时触发。
+   * @supported alipay
+   */
+  onDataReady?: CommonEventFunction
+
+  /** 数据加载失败时触发。
+   * @supported alipay
+   */
+  onDataFailed?: CommonEventFunction
+
+  /** 动画开始时触发。
+   * @supported alipay
+   */
+  onAnimationStart?: CommonEventFunction
+
+  /** 动画结束时触发。
+   * @supported alipay
+   */
+  onAnimationEnd?: CommonEventFunction
+
+  /** 动画一次重播结束。
+   * @supported alipay
+   */
+  onAnimationRepeat?: CommonEventFunction
+
+  /** 动画取消。业务调用 Cancel 时回调。
+   * @supported alipay
+   */
+  onAnimationCancel?: CommonEventFunction
+
+  /** 参数化时，数据准备完成，等待业务传入参数化值。
+   * @supported alipay
+   */
+  onDataLoadReady?: CommonEventFunction
+}
+
+/** Lottie
+ * @classification media
+ * @supported alipay
+ * @see https://opendocs.alipay.com/mini/component/lottie
+ */
+declare const Lottie: ComponentType<LottieProps>
+export { Lottie, LottieProps }

package/types/Map.d.ts

@@ -212,7 +212,7 @@ interface MapProps extends StandardProps {
    * @supported weapp, swan, tt, qq
    * @default false
    */
-  enable3D?: string
+  enable3D?: boolean
 
   /** 点击地图时触发
    * @supported weapp, alipay, swan, tt, qq, jd
@@ -661,7 +661,7 @@ declare namespace MapProps {
 
 /** 地图。相关api Taro.createMapContext。
  * @classification maps
- * @supported weapp, alipay, swan
+ * @supported weapp, alipay, swan, tt, qq, jd
  * @example_react
  * ```tsx
  * class App extends Component {

package/types/MatchMedia.d.ts

@@ -39,7 +39,7 @@ interface MatchMediaProps extends StandardProps {
 
 /** media query 匹配检测节点。可以指定一组 media query 规则，满足时，这个节点才会被展示。
  * 通过这个节点可以实现“页面宽高在某个范围时才展示某个区域”这样的效果。
- * @supported weapp
+ * @supported weapp, alipay
  * @classification viewContainer
  * @example_react
  * ```tsx

package/types/MovableArea.d.ts

@@ -3,14 +3,14 @@ import { StandardProps } from './common'
 interface MovableAreaProps extends StandardProps {
   /** 当里面的 movable-view 设置为支持双指缩放时，设置此值可将缩放手势生效区域修改为整个 movable-area
    * @default false
-   * @supported weapp, alipay, swan, tt, qq
+   * @supported weapp, alipay, swan, tt, qq, h5
    */
   scaleArea?: boolean
 }
 
 /** movable-view 的可移动区域
  * @classification viewContainer
- * @supported weapp, rn
+ * @supported weapp, alipay, swan, tt, qq, h5, rn
  * @example_react
  * ```tsx
  * class App extends Components {

package/types/MovableView.d.ts

@@ -3,77 +3,77 @@ import { StandardProps, CommonEventFunction, TouchEventFunction } from './common
 interface MovableViewProps extends Omit<StandardProps, 'animation'> {
   /** movable-view 的移动方向，属性值有`all`、`vertical`、`horizontal`、`none`
    * @default none
-   * @supported weapp, alipay, swan, tt, qq, rn
+   * @supported weapp, alipay, swan, tt, qq, h5, rn
    */
   direction?: 'all' | 'vertical' | 'horizontal' | 'none'
 
   /** movable-view 是否带有惯性
    * @default false
-   * @supported weapp, alipay, swan, tt, qq
+   * @supported weapp, alipay, swan, tt, qq, h5
    */
   inertia?: boolean
 
   /** 超过可移动区域后，movable-view 是否还可以移动
    * @default false
-   * @supported weapp, alipay, swan, tt, qq
+   * @supported weapp, alipay, swan, tt, qq, h5
    */
   outOfBounds?: boolean
 
   /** 定义 x 轴方向的偏移，如果 x 的值不在可移动范围内，会自动移动到可移动范围；改变 x 的值会触发动画
-   * @supported weapp, alipay, swan, tt, qq, rn
+   * @supported weapp, alipay, swan, tt, qq, h5, rn
    */
   x?: number | string
 
   /** 定义 y 轴方向的偏移，如果 y 的值不在可移动范围内，会自动移动到可移动范围；改变 y 的值会触发动画
-   * @supported weapp, alipay, swan, tt, qq, rn
+   * @supported weapp, alipay, swan, tt, qq, h5, rn
    */
   y?: number | string
 
   /** 阻尼系数，用于控制x或y改变时的动画和过界回弹的动画，值越大移动越快
    * @default 20
-   * @supported weapp, alipay, swan, tt, qq
+   * @supported weapp, alipay, swan, tt, qq, h5
    */
   damping?: number
 
   /** 摩擦系数，用于控制惯性滑动的动画，值越大摩擦力越大，滑动越快停止；必须大于 0，否则会被设置成默认值
    * @default 2
-   * @supported weapp, alipay, swan, tt, qq
+   * @supported weapp, alipay, swan, tt, qq, h5
    */
   friction?: number
 
   /** 是否禁用
    * @default false
-   * @supported weapp, alipay, swan, tt, qq, rn
+   * @supported weapp, alipay, swan, tt, qq, h5, rn
    */
   disabled?: boolean
 
   /** 是否支持双指缩放，默认缩放手势生效区域是在 movable-view 内
    * @default false
-   * @supported weapp, alipay, swan, tt, qq
+   * @supported weapp, alipay, swan, tt, qq, h5
    */
   scale?: boolean
 
   /** 定义缩放倍数最小值
    * @default 0.5
-   * @supported weapp, alipay, swan, tt, qq
+   * @supported weapp, alipay, swan, tt, qq, h5
    */
   scaleMin?: number
 
   /** 定义缩放倍数最大值
    * @default 10
-   * @supported weapp, alipay, swan, tt, qq
+   * @supported weapp, alipay, swan, tt, qq, h5
    */
   scaleMax?: number
 
   /** 定义缩放倍数，取值范围为 0.5 - 10
    * @default 1
-   * @supported weapp, alipay, swan, tt, qq
+   * @supported weapp, alipay, swan, tt, qq, h5
    */
   scaleValue?: number
 
   /** 是否使用动画
    * @default true
-   * @supported weapp, alipay, swan, tt, qq
+   * @supported weapp, alipay, swan, tt, qq, h5
    */
   animation?: boolean
 
@@ -98,7 +98,7 @@ interface MovableViewProps extends Omit<StandardProps, 'animation'> {
   onDragEnd?: CommonEventFunction
 
   /** 缩放过程中触发的事件
-   * @supported weapp, alipay, swan, tt, qq
+   * @supported weapp, alipay, swan, tt, qq, h5
    */
   onScale?: CommonEventFunction<MovableViewProps.onScaleEventDetail>
 
@@ -124,12 +124,12 @@ interface MovableViewProps extends Omit<StandardProps, 'animation'> {
   onTouchCancel?: CommonEventFunction
 
   /** 初次手指触摸后移动为横向的移动，如果 catch 此事件，则意味着 touchmove 事件也被 catch
-   * @supported weapp, swan, tt
+   * @supported weapp, swan, tt, h5
    */
   onHTouchMove?: TouchEventFunction
 
   /** 初次手指触摸后移动为纵向的移动，如果 catch 此事件，则意味着 touchmove 事件也被 catch
-   * @supported weapp, swan, tt
+   * @supported weapp, swan, tt, h5
    */
   onVTouchMove?: TouchEventFunction
 
@@ -190,7 +190,7 @@ declare namespace MovableViewProps {
 
 /** 可移动的视图容器，在页面中可以拖拽滑动。movable-view 必须在 movable-area 组件中，并且必须是直接子节点，否则不能移动。
  * @classification viewContainer
- * @supported weapp, swan, alipay, rn, tt
+ * @supported weapp, alipay, swan, tt, qq, h5, rn
  * @example_react
  * ```tsx
  * class App extends Components {

package/types/NativeSlot.d.ts

@@ -0,0 +1,33 @@
+import { ComponentType } from 'react'
+
+interface NativeSlotProps {
+  /** 指定插入的 slot 位置
+   * @default none
+   * @supported weapp, swan, alipay, tt, jd, qq
+   */
+  name?: string
+}
+
+/** 编译的原生组件支持使用 slot 插槽
+ * @classification viewContainer
+ * @supported weapp, swan, alipay, tt, jd, qq
+ * @version 3.5.7+
+ * @example
+ * ```tsx
+ * import { NativeSlot, View } from '@tarojs/components'
+ *
+ * export default function () {
+ *   render () {
+ *     return (
+ *       <View>
+ *         <NativeSlot />
+ *       </View>
+ *     )
+ *   }
+ * }
+ * ```
+ * @see https://github.com/NervJS/taro/pull/12627
+ */
+declare const NativeSlot: ComponentType<NativeSlotProps>
+
+export { NativeSlot, NativeSlotProps }

package/types/NavigationBar.d.ts

@@ -36,7 +36,8 @@ interface NavigationBarProps extends StandardProps {
 
 /** 页面导航条配置节点，用于指定导航栏的一些属性。只能是 PageMeta 组件内的第一个节点，需要配合它一同使用。
  * 通过这个节点可以获得类似于调用 Taro.setNavigationBarTitle Taro.setNavigationBarColor 等接口调用的效果。
- * @supported weapp
+ * @classification navig
+ * @supported weapp, harmony
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/navigation-bar.html
  */
 declare const NavigationBar: ComponentType<NavigationBarProps>

package/types/Navigator.d.ts

@@ -138,7 +138,7 @@ declare namespace NavigatorProps {
 
 /** 页面链接
  * @classification navig
- * @supported weapp, swan, alipay, tt
+ * @supported weapp, alipay, swan, tt, qq, jd, harmony
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/navigator.html
  */
 declare const Navigator: ComponentType<NavigatorProps>

package/types/OpenData.d.ts

@@ -95,7 +95,7 @@ declare namespace OpenDataProps {
 
 /** 用于展示平台开放的数据
  * @classification open
- * @supported weapp, tt
+ * @supported weapp, swan, tt, qq
  * @example_react
  * ```tsx
  * class App extends Component {

package/types/PageContainer.d.ts

@@ -3,90 +3,100 @@ import { StandardProps, CommonEventFunction } from './common'
 interface PageContainerProps extends StandardProps {
   /** 是否显示容器组件
    * @default false
-   * @supported weapp, rn
+   * @supported weapp, alipay, rn
    */
   show?: boolean
 
   /** 动画时长，单位毫秒
    * @default 300
-   * @supported weapp, rn
+   * @supported weapp, alipay, rn
    */
   duration?: number
 
   /** z-index 层级
    * @default 100
-   * @supported weapp
+   * @supported weapp, alipay
    */
   zIndex?: number
 
   /** 是否显示遮罩层
    * @default true
-   * @supported weapp, rn
+   * @supported weapp, alipay, rn
    */
   overlay?: boolean
 
   /** 弹出位置，可选值为 top bottom right center
    * @default bottom
-   * @supported weapp, rn
+   * @supported weapp, alipay, rn
    */
   position?: keyof PageContainerProps.Position
 
   /** 是否显示圆角
    * @default false
-   * @supported weapp, rn
+   * @supported weapp, alipay, rn
    */
   round?: boolean
 
   /** 自定义遮罩层样式
-   * @supported weapp, rn
+   * @supported weapp, alipay, rn
    */
   overlayStyle?: string
 
   /** 自定义弹出层样式
-   * @supported weapp, rn
+   * @supported weapp, alipay, rn
    */
   customStyle?: string
 
   /** 是否在下滑一段距离后关闭
-   * @supported weapp
+   * @supported weapp, alipay
    * @default false
    */
-  closeOnSlideDown?: string
+  closeOnSlideDown?: boolean
 
   /** 进入前触发
-   * @supported weapp, rn
+   * @supported weapp, alipay, rn
    */
   onBeforeEnter?: CommonEventFunction
 
   /** 进入中触发
-   * @supported weapp, rn
+   * @supported weapp, alipay, rn
    */
   onEnter?: CommonEventFunction
 
   /** 进入后触发
-   * @supported weapp, rn
+   * @supported weapp, alipay, rn
    */
   onAfterEnter?: CommonEventFunction
 
   /** 离开前触发
-   * @supported weapp, rn
+   * @supported weapp, alipay, rn
    */
   onBeforeLeave?: CommonEventFunction
 
   /** 离开中触发
-   * @supported weapp, rn
+   * @supported weapp, alipay, rn
    */
   onLeave?: CommonEventFunction
 
   /** 离开后触发
-   * @supported weapp, rn
+   * @supported weapp, alipay, rn
    */
   onAfterLeave?: CommonEventFunction
 
   /** 点击遮罩层时触发
-   * @supported weapp
+   * @supported weapp, alipay
    */
   onClickOverlay?: CommonEventFunction
+
+  /** 进入被打断时触发（通过 a: if 打断时不会触发）。
+   * @supported alipay
+   */
+  onEnterCancelled?: CommonEventFunction
+
+  /** 离开被打断时触发（通过 a: if 打断时不会触发）。
+   * @supported alipay
+   */
+  onLeaveCancelled?: CommonEventFunction
 }
 declare namespace PageContainerProps {
   /** 弹出位置 */
@@ -114,7 +124,7 @@ declare namespace PageContainerProps {
  *   1. tip: 当前页面最多只有 1 个容器，若已存在容器的情况下，无法增加新的容器
  *   2. tip: wx.navigateBack 无法在页面栈顶调用，此时没有上一级页面
  * @classification viewContainer
- * @supported weapp, rn
+ * @supported weapp, alipay, rn
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/page-container.html
  */
 declare const PageContainer: ComponentType<PageContainerProps>

package/types/PageMeta.d.ts

@@ -96,7 +96,7 @@ declare namespace PageMetaProps {
 
 /** 页面属性配置节点，用于指定页面的一些属性、监听页面事件。只能是页面内的第一个节点。可以配合 navigation-bar 组件一同使用。
  * 通过这个节点可以获得类似于调用 Taro.setBackgroundTextStyle Taro.setBackgroundColor 等接口调用的效果。
- * @supported weapp
+ * @supported weapp, alipay
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/page-meta.html
  */
 declare const PageMeta: ComponentType<PageMetaProps>

package/types/Picker.d.ts

@@ -302,7 +302,7 @@ declare namespace PickerRegionProps {
 /**
  * 从底部弹起的滚动选择器
  * @classification forms
- * @supported weapp, h5, rn, swan, alipay, tt
+ * @supported weapp, swan, alipay, tt, h5, rn, harmony
  * @example_react
  * ```tsx
  * export default class PagePicker extends Component {

package/types/PickerView.d.ts

@@ -66,7 +66,7 @@ declare namespace PickerViewProps {
 /** 嵌入页面的滚动选择器
  * 其中只可放置 picker-view-column 组件，其它节点不会显示
  * @classification forms
- * @supported weapp, swan, alipay, tt, h5, rn
+ * @supported weapp, alipay, swan, tt, qq, jd, h5, rn, harmony
  * @example_react
  * ```tsx
  * export default class Picks extends Component {

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 }