@tarojs/components 3.6.0-canary.2 → 3.6.0-canary.3

package/types/Like.d.ts

@@ -0,0 +1,104 @@
+import { ComponentType } from 'react'
+import { StandardProps } from './common'
+interface LikeProps extends StandardProps {
+  /** 是否已被点赞
+   * @supported swan
+   * @default false
+   */
+  isLiked?: boolean
+
+  /** 按钮模式。icon：表示仅有图标；mixture：表示图标文字结合
+   * @supported swan
+   * @default "icon"
+   */
+  mode?: string
+
+  /** 图标类型。hand：表示手形；heart：表示心形
+   * @supported swan
+   * @default "hand"
+   */
+  iconType?: string
+
+  /** 点赞按钮上的文案。默认为赞，仅在 mode 属性值为'mixture'时有效
+   * @supported swan
+   * @default "赞"
+   */
+  likeText?: string
+
+  /** 点赞数量
+   * @supported swan
+   * @default 0
+   */
+  likeNum?: number
+
+  /** 被点赞的对象类型。0：表示对文章内容进行点赞；1：表示对评论内容进行点赞
+   * @supported swan
+   * @default 0
+   */
+  likeType?: number
+
+  /** 点赞动效形式。0：无动效；1：轻动效；2：强动效
+   * @supported swan
+   * @default 1
+   */
+  animationType?: number
+
+  /** 点赞后是否弹出 toast 提示
+   * @supported swan
+   * @default false
+   */
+  isShowToast?: boolean
+
+  /** toast 文案，默认为已点赞、已取消
+   * @supported swan
+   * @default ['已点赞', '已取消']
+   */
+  toastText?: string[]
+
+  /** 点赞服务需要的必要参数
+   * @supported swan
+   */
+  likeParam: LikeProps.ILikeParam
+
+  /** 使用 npm 方式引入点赞组件时，点击按钮时在用户未登录状态下会触发此事件；使用动态库方式引入点赞组件时，点击按钮时在用户未登录状态下不会触发此事件
+   * @supported swan
+   */
+  onError?: CommonEventFunction
+
+  /** 点击点赞按钮，在点赞服务成功后将状态返回给使用组件者
+   * @supported swan
+   */
+  onSuccess?: CommonEventFunction
+
+  /** 点击点赞按钮，在点赞服务失败后将状态返回给使用组件者
+   * @supported swan
+   */
+  onFail?: CommonEventFunction
+}
+
+declare namespace LikeProps {
+  interface ILikeParam {
+    /** 用户身份唯一标识 */
+    openid: string
+    /** 被点赞的文章的 id，与 path 参数一一对应
+     * @example "20200101"
+     */
+    snid: string
+    /** 被点赞的评论 id */
+    spid?: string
+    /** 文章标题 */
+    title: string
+    /** 智能小程序内页链接，最长不能超过 194 字符
+     * @example "/pages/index/index"
+     */
+    path: string
+  }
+}
+
+/** 点赞
+ * @classification open
+ * @supported swan
+ * @see https://smartprogram.baidu.com/docs/develop/extended/component-content/like/
+ */
+declare const Like: ComponentType<LikeProps>
+export { Like, LikeProps }

package/types/Login.d.ts

@@ -0,0 +1,45 @@
+import { ComponentType } from 'react'
+import { StandardProps } from './common'
+interface LoginProps extends StandardProps {
+  /** 组件中用户授权按钮的类名，可用于自定义样式
+   * @supported swan
+   */
+  buttonClass?: string
+
+  /** 组件中用户授权勾选框选中时的颜色，同 CSS 的 color
+   * @supported swan
+   * @default "#3388FF"
+   */
+  checkedColor?: string
+
+  /** 主题颜色，设置后将应用于 “用户授权按钮背景色” 和 “用户授权勾选框选中时的颜色”
+   * 注：theme-color 的优先级低于 button-class 和 checked-color，且当 button-class 存在时，theme-color 不生效
+   * @supported swan
+   * @default "#3388FF"
+   */
+  themeColor?: string
+
+  /** 用户完成授权后，获取用户手机号：
+   * detail.errMsg 值为"getPhoneNumber:ok" 时代表用户信息获取成功；
+   * detail.errMsg 值为"getPhoneNumber:fail auth deny"时代表用户信息获取失败。
+   * 参考 用户数据的签名验证和加解密 对用户数据进行处理获得用户手机号。
+   * 用户手机号信息解密后数据示例：{"mobile":"15000000000"}
+   * 1. 非个人开发者可申请；
+   * 2. 审核通过后，进入小程序首页,在左侧导航栏单击“设置 -> 开发设置”。下拉页面，在“获取用户手机号权限申请”中单击“申请开通”
+   * @supported swan
+   */
+  onGetPhoneNumber?: CommonEventFunction
+
+  /** 组件加载失败回调
+   * @supported swan
+   */
+  onLoadError?: CommonEventFunction
+}
+
+/** 联合登录 / 手机号授权内嵌组件
+ * @classification open
+ * @supported swan
+ * @see https://smartprogram.baidu.com/docs/develop/component/login/
+ */
+declare const Login: ComponentType<LoginProps>
+export { Login, LoginProps }

package/types/Lottie.d.ts

@@ -0,0 +1,119 @@
+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
+
+  /** Lottie 在线资源。远端的 Zip 文件地址。Lottie 组件会执行 MD5 校验、解压、获取等过程，在过程中显示 placeholder 图片。
+   * 与 path 二选一
+   * @supported alipay
+   */
+  djangoId?: 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

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/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 }