import Taro from '../../index' declare module '../../index' { namespace createIntersectionObserver { /** 选项 */ interface Option { /** 初始的相交比例,如果调用时检测到的相交比例与这个值不相等且达到阈值,则会触发一次监听器的回调函数。 */ initialRatio?: number /** 是否同时观测多个目标节点(而非一个),如果设为 true ,observe 的 targetSelector 将选中多个节点(注意:同时选中过多节点将影响渲染性能) */ observeAll?: boolean /** 一个数值数组,包含所有阈值。 */ thresholds?: number[] } } /** `IntersectionObserver` 对象,用于推断某些节点是否可以被用户看见、有多大比例可以被用户看见。 * @see https://developers.weixin.qq.com/miniprogram/dev/api/wxml/IntersectionObserver.html */ interface IntersectionObserver { /** 停止监听。回调函数将不再触发 * @supported weapp, tt, h5, harmony_hybrid * @see https://developers.weixin.qq.com/miniprogram/dev/api/wxml/IntersectionObserver.disconnect.html */ disconnect(): void /** 指定目标节点并开始监听相交状态变化情况 * @supported weapp, tt, h5, harmony_hybrid * @see https://developers.weixin.qq.com/miniprogram/dev/api/wxml/IntersectionObserver.observe.html */ observe( /** 选择器 */ targetSelector: string, /** 监听相交状态变化的回调函数 */ callback: IntersectionObserver.ObserveCallback, ): void /** 使用选择器指定一个节点,作为参照区域之一。 * @supported weapp, tt, h5, harmony_hybrid * @see https://developers.weixin.qq.com/miniprogram/dev/api/wxml/IntersectionObserver.relativeTo.html */ relativeTo( /** 选择器 */ selector: string, /** 用来扩展(或收缩)参照节点布局区域的边界 */ margins?: IntersectionObserver.RelativeToMargins, ): IntersectionObserver /** 指定页面显示区域作为参照区域之一 * @supported weapp, tt, h5, harmony_hybrid * @example * 下面的示例代码中,如果目标节点(用选择器 .target-class 指定)进入显示区域以下 100px 时,就会触发回调函数。 * * ```tsx * Taro.createIntersectionObserver().relativeToViewport({bottom: 100}).observe('.target-class', (res) => { * res.intersectionRatio // 相交区域占目标节点的布局区域的比例 * res.intersectionRect // 相交区域 * res.intersectionRect.left // 相交区域的左边界坐标 * res.intersectionRect.top // 相交区域的上边界坐标 * res.intersectionRect.width // 相交区域的宽度 * res.intersectionRect.height // 相交区域的高度 * }) * ``` * @see https://developers.weixin.qq.com/miniprogram/dev/api/wxml/IntersectionObserver.relativeToViewport.html */ relativeToViewport( /** 用来扩展(或收缩)参照节点布局区域的边界 */ margins?: IntersectionObserver.RelativeToViewportMargins, ): IntersectionObserver } namespace IntersectionObserver { /** 监听相交状态变化的回调函数 * @description Harmony 找不到对应元素时,回调会返回一个 Error 对象 */ type ObserveCallback = (result: ObserveCallbackResult) => void interface ObserveCallbackResult extends TaroGeneral.CallbackResult { /** 错误信息,会在找不到对应元素时返回 * @supported harmony */ errMsg?: string /** 目标边界 */ boundingClientRect?: BoundingClientRectResult /** 相交比例 */ intersectionRatio?: number /** 相交区域的边界 */ intersectionRect?: IntersectionRectResult /** 参照区域的边界 */ relativeRect?: RelativeRectResult /** 相交检测时的时间戳 */ time?: number } /** 参照区域的边界 */ interface RelativeRectResult { /** 下边界 */ bottom: number /** 左边界 */ left: number /** 右边界 */ right: number /** 上边界 */ top: number } /** 相交区域的边界 */ interface IntersectionRectResult { /** 下边界 */ bottom: number /** 高度 */ height: number /** 左边界 */ left: number /** 右边界 */ right: number /** 上边界 */ top: number /** 宽度 */ width: number } /** 目标边界 */ interface BoundingClientRectResult { /** 下边界 */ bottom: number /** 高度 */ height: number /** 左边界 */ left: number /** 右边界 */ right: number /** 上边界 */ top: number /** 宽度 */ width: number } /** 用来扩展(或收缩)参照节点布局区域的边界 */ interface RelativeToMargins { /** 节点布局区域的下边界 */ bottom?: number /** 节点布局区域的左边界 */ left?: number /** 节点布局区域的右边界 */ right?: number /** 节点布局区域的上边界 */ top?: number } /** 用来扩展(或收缩)参照节点布局区域的边界 */ interface RelativeToViewportMargins { /** 节点布局区域的下边界 */ bottom?: number /** 节点布局区域的左边界 */ left?: number /** 节点布局区域的右边界 */ right?: number /** 节点布局区域的上边界 */ top?: number } } /** `MediaQueryObserver` 对象,用于监听页面 media query 状态的变化,如界面的长宽是不是在某个指定的范围内。 */ interface MediaQueryObserver { /** 开始监听页面 media query 变化情况 */ observe(descriptor: MediaQueryObserver.descriptor, callback: MediaQueryObserver.observeCallback): void /** 停止监听。回调函数将不再触发 */ disconnect(): void } namespace MediaQueryObserver { /** media query 描述符 */ interface descriptor { /** 页面最小宽度 (单位: px) */ minWidth: number /** 页面最大宽度 (单位: px) */ maxWidth: number /** 页面宽度 (单位: px) */ width: number /** 页面最小高度 (单位: px) */ minHeight: number /** 页面最大高度(px 为单位) */ maxHeight: number /** 页面高度(px 为单位) */ height: number /** 屏幕方向 */ orientation: 'landscape' | 'portrait' } /** 监听 media query 状态变化的回调函数 */ type observeCallback = (res: { /** 页面的当前状态是否满足所指定的 media query */ matches: boolean }) => void } /** 用于获取 `WXML` 节点信息的对象 * @see https://developers.weixin.qq.com/miniprogram/dev/api/wxml/NodesRef.html */ interface NodesRef { /** 添加节点的布局位置的查询请求。相对于显示区域,以像素为单位。其功能类似于 DOM 的 `getBoundingClientRect`。返回 `NodesRef` 对应的 `SelectorQuery`。 * @supported weapp, h5, tt, harmony_hybrid * @example * ```tsx * Taro.createSelectorQuery().select('#the-id').boundingClientRect(function(rect){ * rect.id // 节点的ID * rect.dataset // 节点的dataset * rect.left // 节点的左边界坐标 * rect.right // 节点的右边界坐标 * rect.top // 节点的上边界坐标 * rect.bottom // 节点的下边界坐标 * rect.width // 节点的宽度 * rect.height // 节点的高度 * }).exec() * @example * ``` * ```tsx * Taro.createSelectorQuery().selectAll('.a-class').boundingClientRect(function(rects){ * rects.forEach(function(rect){ * rect.id // 节点的ID * rect.dataset // 节点的dataset * rect.left // 节点的左边界坐标 * rect.right // 节点的右边界坐标 * rect.top // 节点的上边界坐标 * rect.bottom // 节点的下边界坐标 * rect.width // 节点的宽度 * rect.height // 节点的高度 * }) * }).exec() * ``` * @see https://developers.weixin.qq.com/miniprogram/dev/api/wxml/NodesRef.boundingClientRect.html */ boundingClientRect( /** 回调函数,在执行 `SelectorQuery.exec` 方法后,节点信息会在 `callback` 中返回。 */ callback?: NodesRef.BoundingClientRectCallback, ): SelectorQuery /** 添加节点的 Context 对象查询请求。目前支持 [VideoContext](/docs/apis/media/video/VideoContext)、[CanvasContext](/docs/apis/canvas/CanvasContext)、[LivePlayerContext](/docs/apis/media/live/LivePlayerContext)、[EditorContext](/docs/apis/media/editor/EditorContext)和 [MapContext](/docs/apis/media/map/MapContext) 的获取。 * @supported weapp, h5, tt, harmony_hybrid * @example * ```tsx * Taro.createSelectorQuery().select('.the-video-class').context(function (res) { * console.log(res.context) // 节点对应的 Context 对象。如:选中的节点是