@tarojs/components 3.5.5 → 3.5.6-alpha.1

package/types/RichText.d.ts

@@ -1,32 +1,81 @@
 import { ComponentType } from 'react'
-import { StandardProps } from './common'
-
+import { CommonEventFunction, StandardProps } from './common'
 interface RichTextProps extends StandardProps {
   /** 文本是否可选，该属性会使节点显示为 block
    * @default false
    * @supported weapp
    */
   userSelect?: boolean
+
   /** 节点列表/ HTML String */
   nodes?: Nodes
+
   /** 显示连续空格
-   * @supported weapp, rn
+   * @supported weapp, qq, rn
    */
   space?: keyof RichTextProps.TSpace
+
+  /** 触摸。
+   * @supported alipay
+   */
+  onTap?: CommonEventFunction
+
+  /** 触摸动作开始。
+   * @supported alipay
+   */
+  onTouchstart?: CommonEventFunction
+
+  /** 触摸移动事件。
+   * @supported alipay
+   */
+  onTouchmove?: CommonEventFunction
+
+  /** 触摸动作被打断。
+   * @supported alipay
+   */
+  onTouchcancel?: CommonEventFunction
+
+  /** 触摸动作结束。
+   * @supported alipay
+   */
+  onTouchend?: CommonEventFunction
+
+  /** 触摸后，超过 500ms 再离开。
+   * @supported alipay
+   */
+  onLongtap?: CommonEventFunction
+
+  /** 富文本是否可以长按选中，可用于复制，粘贴，长按搜索等场景
+   * @default false（基础库 3.150.1 以前版本）true（基础库 3.150.1 及以后版本）
+   * @supported swan
+   */
+  selectable?: string
+
+  /** 阻止长按图片时弹起默认菜单（将该属性设置为image-menu-prevent或image-menu-prevent="true"），只在初始化时有效，不能动态变更；若不想阻止弹起默认菜单，则不需要设置此属性
+   * @default false
+   * @supported swan
+   */
+  imageMenuPrevent?: string
+
+  /** 富文本中的图片是否可点击预览。在不设置的情况下，若 rich-text 未监听点击事件，则默认开启。未显示设置 preview 时会进行点击默认预览判断，建议显示设置 preview
+   * @supported swan
+   */
+  preview?: string
 }
 
 /** 节点类型
  * > 现支持两种节点，通过type来区分，分别是元素节点和文本节点，默认是元素节点，在富文本区域里显示的HTML节点 元素节点：type = node*
  */
 type Nodes = Array<RichTextProps.Text | RichTextProps.HTMLElement> | string
-
 declare namespace RichTextProps {
   /** space 的合法值 */
   interface TSpace {
     /** 中文字符空格一半大小 */
     ensp
+
     /** 中文字符空格大小 */
     emsp
+
     /** 根据字体设置的空格大小 */
     nbsp
   }
@@ -128,5 +177,4 @@ declare namespace RichTextProps {
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/rich-text.html
  */
 declare const RichText: ComponentType<RichTextProps>
-
 export { RichText, RichTextProps }

package/types/RootPortal.d.ts

@@ -3,8 +3,9 @@ import { ComponentType } from 'react'
 /** root-portal
  * 使整个子树从页面中脱离出来，类似于在 CSS 中使用 fixed position 的效果。主要用于制作弹窗、弹出层等。
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/root-portal.html
+ * @classification viewContainer
  * @supported weapp
- * @example
+ * @example_react
  * ```tsx
  * import { useState } from 'react'
  * import { RootPortal, View, Button } from '@tarojs/components'

package/types/ScrollView.d.ts

@@ -1,62 +1,61 @@
 import { ComponentType } from 'react'
 import { StandardProps, CommonEventFunction, BaseEventOrigFunction } from './common'
-
 interface ScrollViewProps extends StandardProps {
   /** 允许横向滚动
    * @default false
-   * @supported weapp, swan, alipay, tt, h5, rn
+   * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
    * @rn 二选一
    */
   scrollX?: boolean
 
   /** 允许纵向滚动
    * @default false
-   * @supported weapp, swan, alipay, tt, h5, rn
+   * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
    * @rn 二选一
    */
   scrollY?: boolean
 
   /** 距顶部/左边多远时（单位px），触发 scrolltoupper 事件
    * @default 50
-   * @supported weapp, swan, alipay, tt, h5, rn
+   * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
    */
   upperThreshold?: number
 
   /** 距底部/右边多远时（单位px），触发 scrolltolower 事件
    * @default 50
-   * @supported weapp, swan, alipay, tt, h5, rn
+   * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
    */
   lowerThreshold?: number
 
   /** 设置竖向滚动条位置
-   * @supported weapp, swan, alipay, tt, h5, rn
+   * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
    */
   scrollTop?: number
 
   /** 设置横向滚动条位置
-   * @supported weapp, swan, alipay, tt, h5, rn
+   * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
    */
   scrollLeft?: number
 
   /** 值应为某子元素id（id不能以数字开头）。设置哪个方向可滚动，则在哪个方向滚动到该元素
-   * @supported weapp, swan, alipay, tt, h5
+   * @supported weapp, alipay, swan, tt, qq, jd, h5
    */
   scrollIntoView?: string
 
   /** 在设置滚动条位置时使用动画过渡
-   * @supported weapp, swan, alipay, tt, h5, rn
+   * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
    * @default false
    */
   scrollWithAnimation?: boolean
 
   /** iOS 点击顶部状态栏、安卓双击标题栏时，滚动条返回顶部，只支持竖向
-   * @supported weapp, alipay, rn
+   * @supported weapp, alipay, swan, qq, jd, rn
    * @default false
    */
   enableBackToTop?: boolean
 
   /** 启用 flexbox 布局。开启后，当前节点声明了 `display: flex` 就会成为 flex container，并作用于其孩子节点。
-   * @supported weapp
+   * @supported weapp, jd
    * @default false
    */
   enableFlex?: boolean
@@ -128,18 +127,17 @@ interface ScrollViewProps extends StandardProps {
   fastDeceleration?: boolean
 
   /** 滚动到顶部/左边，会触发 scrolltoupper 事件
-   * @supported weapp, swan, alipay, tt, h5, rn
+   * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
    */
   onScrollToUpper?: CommonEventFunction
 
   /** 滚动到底部/右边，会触发 scrolltolower 事件
-   * @supported weapp, swan, alipay, tt, h5, rn
+   * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
    */
   onScrollToLower?: CommonEventFunction
 
   /** 滚动时触发
-   * `event.detail = {scrollLeft, scrollTop, scrollHeight, scrollWidth, deltaX, deltaY}`
-   * @supported weapp, swan, alipay, tt, h5, rn
+   * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
    */
   onScroll?: BaseEventOrigFunction<ScrollViewProps.onScrollDetail>
 
@@ -173,20 +171,86 @@ interface ScrollViewProps extends StandardProps {
    */
   onDragging?: CommonEventFunction
 
-  /** 滑动结束事件 (同时开启 enhanced 属性后生效)
+  /** 滑动结束事件 (同时开启 enhanced 属性后生效) detail { scrollTop, scrollLeft, velocity }
    * @supported weapp
    */
-  onDragEnd?: CommonEventFunction
-}
+  onDragend?: CommonEventFunction
+
+  /** 外部样式名。
+   * @supported alipay
+   */
+  class?: string
+
+  /** 内联样式名。
+   * @supported alipay
+   */
+  style?: string
+
+  /** 当 scroll-with-animation设置为 true 时，可以设置 scroll-animation-duration 来控制动画的执行时间，单位 ms。
+   * 版本要求： 基础库 1.9.0 及以上
+   * @supported alipay
+   */
+  scrollAnimationDuration?: string
+
+  /** 纵向滚动时，当滚动到顶部或底部时，强制禁止触发页面滚动，仍然只触发 scroll-view 自身的滚动。
+   * 默认值： false
+   * 版本要求： 基础库 1.11.2 及以上
+   * @supported alipay
+   */
+  trapScroll?: string
+
+  /** 触摸动作开始。
+   * 版本要求： 基础库 1.15.0 及以上
+   * @supported alipay
+   */
+  onTouchStart?: CommonEventFunction
+
+  /** 触摸后移动。
+   * 版本要求： 基础库 1.15.0 及以上
+   * @supported alipay
+   */
+  onTouchMove?: CommonEventFunction
 
+  /** 触摸动作结束。
+   * 版本要求： 基础库 1.15.0 及以上
+   * @supported alipay
+   */
+  onTouchEnd?: CommonEventFunction
+
+  /** 触摸动作被打断，如来电提醒、弹窗。
+   * 版本要求： 基础库 1.15.0 及以上
+   * @supported alipay
+   */
+  onTouchCancel?: CommonEventFunction
+
+  /** 发生滚动前，对滚动方向进行判断，当方向是顶部/左边时，如果值为 always 将始终禁止滚动，如果值为 out-of-bounds 且当前已经滚动到顶部/左边，禁止滚动。
+   * 版本要求：基础库 2.6.2 及以上
+   * @supported alipay
+   */
+  disableLowerScroll?: string
+
+  /** 发生滚动前，对滚动方向进行判断，当方向是底部/右边时，如果值为 always 将始终禁止滚动，如果值为 out-of-bounds 且当前已经滚动到底部/右边，禁止滚动。
+   * 版本要求：基础库 2.6.2 及以上
+   * @supported alipay
+   */
+  disableUpperScroll?: string
+
+  /** 无障碍访问，（属性）元素的额外描述
+   * @supported qq
+   */
+  ariaLabel?: string
+}
 declare namespace ScrollViewProps {
   interface onScrollDetail {
     /** 横向滚动条位置 */
     scrollLeft: number
+
     /** 竖向滚动条位置 */
     scrollTop: number
+
     /** 滚动条高度 */
     scrollHeight: number
+
     /** 滚动条宽度 */
     scrollWidth: number
     deltaX: number
@@ -340,5 +404,4 @@ declare namespace ScrollViewProps {
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/scroll-view.html
  */
 declare const ScrollView: ComponentType<ScrollViewProps>
-
 export { ScrollView, ScrollViewProps }

package/types/ShareElement.d.ts

@@ -1,12 +1,6 @@
 import { ComponentType } from 'react'
 import { StandardProps, CommonEventFunction } from './common'
-
 interface ShareElementProps extends StandardProps {
-  /** 映射标记
-   * @supported weapp
-   */
-  mapkey: string
-
   /** 是否进行动画
    * @default false
    * @supported weapp
@@ -24,6 +18,11 @@ interface ShareElementProps extends StandardProps {
    * @supported weapp
    */
   easingFunction?: number
+
+  /** 映射标记
+   * @supported weapp
+   */
+  key?: string
 }
 
 /** 共享元素
@@ -228,5 +227,4 @@ interface ShareElementProps extends StandardProps {
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/share-element.html
  */
 declare const ShareElement: ComponentType<ShareElementProps>
-
 export { ShareElement, ShareElementProps }

package/types/Slider.d.ts

@@ -1,90 +1,115 @@
 import { ComponentType } from 'react'
 import { StandardProps, CommonEventFunction, FormItemProps } from './common'
-
 interface SliderProps extends StandardProps, FormItemProps {
   /** 最小值
    * @default 0
-   * @supported weapp, h5, rn, swan, alipay, tt
+   * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
    */
   min?: number
 
   /** 最大值
    * @default 100
-   * @supported weapp, h5, rn, swan, alipay, tt
+   * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
    */
   max?: number
 
   /** 步长，取值必须大于 0，并且可被(max - min)整除
    * @default 1
-   * @supported weapp, h5, rn, swan, alipay, tt
+   * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
    */
   step?: number
 
   /** 是否禁用
    * @default false
-   * @supported weapp, h5, rn, swan, alipay, tt
+   * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
    */
   disabled?: boolean
 
   /** 当前取值
    * @default 0
-   * @supported weapp, h5, rn, swan, alipay, tt
+   * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
    */
   value?: number
 
   /** 背景条的颜色（请使用 backgroundColor）
    * @default "#e9e9e9"
-   * @supported weapp, tt
+   * @supported weapp, tt, qq, jd
    */
   color?: string
 
   /** 已选择的颜色（请使用 activeColor）
    * @default "#1aad19"
-   * @supported weapp, tt
+   * @supported weapp, tt, qq, jd
    */
   selectedColor?: string
 
   /** 已选择的颜色
    * @default "#1aad19"
-   * @supported weapp, h5, rn, swan, alipay, tt
+   * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
    */
   activeColor?: string
 
   /** 背景条的颜色
    * @default "#e9e9e9"
-   * @supported weapp, h5, rn, swan, alipay, tt
+   * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
    */
   backgroundColor?: string
 
   /** 滑块的大小，取值范围为 12 - 28
    * @default 28
-   *  @supported weapp, h5, swan, alipay, tt
+   *  @supported weapp, swan, tt, qq, jd, h5
    */
   blockSize?: number
 
   /** 滑块的颜色
    * @default "#ffffff"
-   * @supported weapp, h5, rn, swan, alipay, tt
+   * @supported weapp, swan, tt, qq, jd, h5, rn
    */
   blockColor?: string
 
   /** 是否显示当前 value
    * @default false
-   * @supported weapp, h5, rn, swan, alipay, tt
+   * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
    */
   showValue?: boolean
 
   /** 完成一次拖动后触发的事件
-   * @supported weapp, h5, rn, swan, alipay, tt
+   * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
    */
   onChange?: CommonEventFunction<SliderProps.onChangeEventDetail>
 
   /** 拖动过程中触发的事件
-   * @supported weapp, h5, rn, swan, alipay, tt
+   * @supported weapp, alipay, swan, tt, qq, jd, h5, rn
    */
   onChanging?: CommonEventFunction<SliderProps.onChangeEventDetail>
-}
 
+  /** 组件名字，用于表单提交获取数据。
+   * @supported alipay
+   */
+  name?: string
+
+  /** 轨道线条高度。
+   * @default 4
+   * @supported alipay
+   */
+  trackSize?: string
+
+  /** 滑块大小。
+   * @default 22
+   * @supported alipay
+   */
+  handleSize?: string
+
+  /** 滑块填充色，同 CSS 色值。
+   * @supported alipay
+   */
+  handleColor?: string
+
+  /** 无障碍访问，（属性）元素的额外描述
+   * @supported qq
+   */
+  ariaLabel?: string
+}
 declare namespace SliderProps {
   interface onChangeEventDetail {
     value
@@ -131,5 +156,4 @@ declare namespace SliderProps {
  * @see https://developers.weixin.qq.com/miniprogram/dev/component/slider.html
  */
 declare const Slider: ComponentType<SliderProps>
-
 export { Slider, SliderProps }