react-useheadroom/dist/index.d.ts

A fully-typed lightweight react custom hook that returns the state of the shown/hidden header (headroom).

type UseHeadroomProps = {
    /**
     * `onPin` callback will be invoked every time the navbar gets pinned (shown)
     */
    onPin?: (...args: Array<any>) => void;
    /**
     * `onUnPin` callback will be invoked every time the navbar gets unpinned/released (hidden)
     */
    onUnpin?: (...args: Array<any>) => void;
    /**
     * `onFix` callback will be invoked every time the navbar gets fixed at the
     * `fixAt` prop (when the viewport scroll is smaller than `fixAt` value)
     */
    onFix?: (...args: Array<any>) => void;
    /**
     * `onUnfix` callback will be invoked every time the navbar gets unfixed from the
     * `fixAt` value (when the viewport scroll is bigger than `fixAt` value)
     */
    onUnfix?: (...args: Array<any>) => void;
    /**
     * `fixAt` is a numeric value (in pixels) indicating the scroll position at which the navbar must be fixed at (default value: 0px)
     */
    fixAt?: number;
};

declare const useHeadroom: (props?: UseHeadroomProps) => boolean;

export { type UseHeadroomProps, useHeadroom as default };