import React from 'react'; export interface ShowMonitorProps { /** * 自定义类名 * @en Custom classname */ className?: string; /** * 自定义样式 * @en Custom stylesheet */ style?: React.CSSProperties; /** * 滚动视口选择器 * @en Scroll viewport selector * @default () => window */ getScrollContainer?: () => HTMLElement | Window | null; /** * 节流粒度(ms) * @en Throttle granularity(ms) * @default 300 */ throttle?: number; /** * 是否监听 resize * @en Whether to monitor resize * @default true */ listenResize?: boolean; /** * 是否监听 scroll * @en Whether to monitor scroll * @default true */ listenScroll?: boolean; /** * 只监听变化一次,为 true 时仅在进入视口时触发一次 onVisibleChange * @en Only listen for changes once, if true, only trigger onVisibleChange once when entering the viewport * @default false */ once?: boolean; /** * 是否为局部滚动 * @en Whether it is a local scroll * @default false */ overflow?: boolean; /** * 元素进入视口区域触发回调比例,[0-1] * @en Threshold of callback triggered when element enters viewport area, [0-1] * @default 0 */ threshold?: number; /** * 预加载提前量 [offsetTop, offsetRight, offsetBottom, offsetLeft]。 * 如果类型为 number,等效为[number, number, number, number]; * 如果类型为 [number1, number2], 等效为[number1, 0, number2, 0]; * 支持 Intersection Observer 的浏览器需要搭配 getScrollContainer, 设置父级容器 * @en Preload advance amount [offsetTop, offsetRight, offsetBottom, offsetLeft]. * @en If the type is number, it is equivalent to [number, number, number, number]; * @en If the type is [number1, number2], it is equivalent to [number1, 0, number2, 0]; * @en Browsers that support Intersection Observer need to use getScrollContainer to set the parent container * @default 0 */ offset?: number | [number, number] | [number, number, number, number]; /** * 子节点 * @en Children nodes */ children: React.ReactNode; /** * 是否禁用监听 * @en Whether to disable monitoring * @default false */ disabled?: boolean; /** * 进入或离开视口的回调函数 * @en Callback for entering or leaving the viewport */ onVisibleChange: (visible: boolean, node: HTMLDivElement) => void; /** * 点击组件的回调事件 * @en Callback when clicked */ onClick?: (e: React.MouseEvent) => void; } export interface ShowMonitorRef { /** * 最外层元素 DOM * @en The outermost element DOM */ dom: HTMLDivElement | null; /** * 忽略元素前后状态,手动检查元素是否在视口内,触发onVisibleChange回调函数 * @en Ignore the state of the element before and after, manually check whether the element is in the viewport, trigger the onVisibleChange callback function */ checkVisible: () => boolean; /** * 重置元素初始可见态为false,并重新对元素可见度发起检测,优先级低于disabled(通常用在对ShowMonitor内部元素变化时发起的重新监听) * @en Reset the initial visible state of the element to false, and re-detect the visibility of the element, the priority is lower than 'disabled'(Usually used to re-listen when elements inside ShowMonitor change) */ flushVisibleStatus: () => void; } /** * 通过滚动事件监测 children 是否进入视口或离开视口。 * @en Use scroll events to monitor whether children enter or leave the viewport. * @type 其他 * @type_en Others * @name 滚动视口监听 * @name_en ShowMonitor */ declare const ShowMonitor: React.ForwardRefExoticComponent>; export default ShowMonitor;