useSticky

React Hook that tracks element sticky

Usage

Live Editor

function Demo() {
  const element = useRef<HTMLDivElement>(null);
  const [isSticky] = useSticky(element, {
    // header fixed height
    nav: 64,
  });

  const stickyStyle: CSSProperties = isSticky
    ? {
        position: "fixed",
        top: 64,
        zIndex: 50,
        height: 20,
      }
    : {
        height: 20,
      };

  const guardStyle: CSSProperties = {
    width: 1,
    height: 1,
  };

  return (
    <div style={{height: 300,overflow: 'scroll'}}>
      <div ref={element} style={guardStyle} />
      <button style={stickyStyle}>
        {isSticky ? "stickying" : "not sticky"}
      </button>
      <div style={{ height: "100vh" }} />
    </div>
  );
};

Result

Loading...

API

useSticky

Returns

[boolean, React.Dispatch<React.SetStateAction<boolean>>]: A tuple with the following elements:

• The current state of sticky.
• A function to update the value of sticky.

Arguments

Argument	Description	Type	DefaultValue
targetElement	dom element	BasicTarget<HTMLElement> (Required)	-
params	optional params	UseStickyParams (Required)	-
scrollElement	scroll container	BasicTarget<HTMLElement>	-

UseStickyParams

Property	Description	Type	DefaultValue
axis	axis of scroll	'x' | 'y'	y
nav	cover height or width	number (Required)	0

BasicTarget

export type BasicTarget<T extends TargetType = Element> = (() => TargetValue<T>) | TargetValue<T> | MutableRefObject<TargetValue<T>>;

TargetValue

type TargetValue<T> = T | undefined | null;

TargetType

type TargetType = HTMLElement | Element | Window | Document | EventTarget;