nimiq-vitepress-theme
Version:
Nimiq UI theme for VitePress
13 lines (12 loc) • 632 B
TypeScript
/**
* Composable for handling header scroll behavior.
* Tracks scroll direction and provides reactive state for showing/hiding header.
*
* @param threshold - Minimum scroll distance before triggering hide/show (default: 10px)
* @param hideDelay - Delay in ms before hiding header when scrolling down (default: 100ms)
*/
export declare function useHeaderScroll(threshold?: number, hideDelay?: number): {
isHeaderVisible: Readonly<import("vue").Ref<boolean, boolean>>;
scrollY: Readonly<import("vue").Ref<number, number>>;
scrollDirection: Readonly<import("vue").Ref<"up" | "down" | null, "up" | "down" | null>>;
};