hiding-header
Version:
Toggles header visibility on scroll.
21 lines (20 loc) • 786 B
TypeScript
export interface HidingHeaderOptions {
heightPropertyName?: string;
boundsHeightPropertyName?: string;
animationOffsetPropertyName?: string;
snap?: boolean;
onHeightChange?: (height: number) => void;
onVisibleHeightChange?: (height: number) => void;
onHomeChange?: (isHome: boolean) => void;
}
export declare function hidingHeader(container: HTMLElement, { heightPropertyName, boundsHeightPropertyName, animationOffsetPropertyName, snap, onHeightChange, onVisibleHeightChange, onHomeChange, }?: HidingHeaderOptions): {
run: () => void;
pause: () => void;
isPaused: () => boolean;
isHome: () => boolean;
reveal: () => void;
hide: () => void;
getHeight: () => number;
getVisibleHeight: () => number;
destroy: () => void;
};