import React, { CSSProperties, ReactNode } from 'react';
export interface StickyRef {
    /**
     * 最外层元素 DOM
     * @en The outermost element DOM
     */
    dom: HTMLDivElement | null;
    /**
     * 局部滚动模式下，如果容器外部还有嵌套滚动，可主动调用此方法，让 sticky 的元素主动更新 fixed 位置
     * @en In the local scrolling mode, if there is nested scrolling outside the container, this method can be actively called to make the sticky element actively update the fixed position
     */
    recalculatePosition: () => void;
    /**
     * 手动更新占位模块的高度
     * @en Manually update the height of the placeholder
     */
    updatePlaceholderLayout: () => void;
}
export interface StickyEventPayload {
    /**
     * 当前是否为吸顶/吸底状态
     * @en Whether it is currently in the top/bottom suction state
     */
    isSticky: boolean;
    /**
     * 前一个状态是否为吸顶/吸底状态
     * @en Whether the previous state is ceiling / bottom suction state
     */
    wasSticky: boolean;
    /** 当前是否为吸顶状态 */
    isTopSticky: boolean;
    /** 当前是否为吸底状态 */
    isBottomSticky: boolean;
}
export interface StickyProps {
    /**
     * 吸附位置，top 表示吸顶，bottom 表示吸底，both 表示既吸顶又吸底
     * @en Adsorption position, top means fixed top, bottom means fixed bottom, both means both top and bottom
     * @default "top"
     */
    position?: 'top' | 'bottom' | 'both';
    /**
     * 当距离容器顶部距离为该值时吸顶
     * @en Fixed top when the distance from the top of the container is this value
     * @default 0
     */
    topOffset?: number;
    /**
     * 当距离容器底部距离为该值时吸底
     * @en Fixed bottom when the distance from the bottom of the container is this value
     * @default 0
     */
    bottomOffset?: number;
    /**
     * 当sticky元素需要跟随依附容器离开视口时距离依附容器边缘的距离
     * @en The distance from the edge of the attached container when the sticky element needs to follow the attached container to leave the viewport
     * @default 0
     */
    followOffset?: number;
    /**
     * 自定义类名
     * @en Custom classname
     */
    className?: string;
    /**
     * 自定义样式
     * @en Custom stylesheet
     */
    style?: CSSProperties;
    /**
     * 组件内部内容
     * @en Children elements of the component
     */
    children?: ReactNode;
    /**
     * 层级指数，z-index的值
     * @en z-index
     * @default 100
     */
    zIndex?: number;
    /**
     * 在处于sticky状态时是否portal
     * @en Whether it is portal in sticky state
     * @default false
     */
    portalWhenSticky?: boolean;
    /**
     * 处于sticky状态时，元素固定样式。推荐用fixed，如果为absolute则需自行为滚动容器的父容器设置 position: relative
     * @en When in the sticky state, the fixed style of the element. Fixed is recommended. If absolute, need to set position: relative for the parent container of the scrolling container.
     * @default "fixed"
     */
    stickyStyle?: 'fixed' | 'absolute';
    /**
     * 处于sticky状态时的自定义样式
     * @en Custom style when in sticky state
     */
    stickyCssStyle?: CSSProperties;
    /**
     * 被portal时挂载的容器
     * @en Container mounted when being portaled
     * @default () => document.body
     */
    getPortalContainer?: () => HTMLElement;
    /**
     * 吸顶状态切换时触发
     * payload.isSticky: 当前是否为吸顶/吸底状态
     * payload.wasSticky: 前一个状态是否为吸顶/吸底状态
     * @en Triggered when the sticky state is switched
     * @en isSticky: Whether it is currently in the top/bottom state
     * @en Whether the previous state is the top/bottom state
     */
    onStickyStateChange?: (payload: StickyEventPayload) => void;
    /**
     * 滚动时top变化回调，参数为元素距离容器顶部减去topOffset的距离
     * @en The top change callback when scrolling, the parameter is the distance of the element from the top of the container minus topOffset
     */
    onTopChange?: (top: number) => void;
    /**
     * 指定sticky元素的依附容器，sticky元素不会超出容器，在容器离开视口时会跟随
     * 如果返回string则使用querySelector选取容器
     * @en Specifies the attachment container of the sticky element. The sticky element will not exceed the container and will follow when the container leaves the viewport
     * @en If a string is returned, use querySelector to select the container
     */
    getContainer?: () => HTMLElement | string;
    /**
     * 指定滚动容器；如果返回string则使用querySelector选取容器
     * @en Specifies the scrolling container. If this value is specified, the relative property is always regarded as false; if a string is input, use querySelector to select the container
     * @default () => window
     */
    getScrollContainer?: () => HTMLElement | Window | string;
}
/**
 * 粘性布局组件，元素相对于窗口或指定容器的吸顶效果。
 * @en Sticky layout component, The sticky-to-top effect of the element relative to the window or specified container
 * @type 布局
 * @type_en Layout
 * @name 粘性布局
 * @name_en Sticky
 */
declare const Sticky: React.ForwardRefExoticComponent<StickyProps & React.RefAttributes<StickyRef>>;
export default Sticky;