1. Quick SERP analysis & user intent (summary)

Top results for queries around react-headroom and variants typically include: an npm package page, the GitHub README, short “getting started” blog posts/tutorials, example code sandboxes, and threads discussing customization or bugs. The dominant user intents are:

• Informational: “What is react-headroom?”, “How does hide-on-scroll work?”
• Transactional/Setup: “react-headroom installation”, “getting started”, code examples
• Implementation/How-to: tutorials, examples, custom animations, props

Competitors (docs, blog posts, GitHub readme, StackOverflow answers) vary in depth. The best pages combine concise install instructions, a runnable example, prop definitions, and a short troubleshooting section. Many tutorials copy the basic example but rarely cover edge cases (SSR, mobile bounce, overlapping content, z-index), which is an opportunity to rank higher by addressing those gaps.

Recommended page structure based on SERP patterns: short hero summary + copy-paste install + minimal runnable example + props & customization + animations & CSS + accessibility/SSR notes + FAQ & links. Keep code examples copy-ready for featured snippets and voice queries.

2. Semantic core (clustered)

Main (primary)
- react-headroom
- react-headroom installation
- react-headroom tutorial
- react-headroom example
- react-headroom setup
- react-headroom getting started

Secondary (implementation & intent)
- React auto-hiding header
- React hide on scroll
- React sticky navigation
- React navigation header
- React scroll header
- React header library

LSI / Related & long-tail
- react-headroom props
- react-headroom animations
- react-headroom customization
- react-headroom onPin onUnpin
- auto hide header react example
- react sticky navbar hide on scroll
- headroom.js vs react-headroom
- react-headroom disableInlineStyles
- react-headroom SSR issues
- npm react-headroom package
      

How to use: Use the primary keywords in H1/H2 and intro; sprinkle secondary and LSI phrases naturally inside examples, props section, and troubleshooting. Avoid stuffing—prioritize readability and code clarity.

3. Top user questions (PAA / forums)

Collected likely People Also Ask / forum questions:

• How do I install react-headroom?
• How do I hide a header on scroll in React?
• How do I customize the animation of react-headroom?
• What props control when the header hides or shows?
• How to disable inline styles in react-headroom?
• Does react-headroom work with server-side rendering?
• How to combine react-headroom with React Router navigation?
• How to keep header visible on certain routes?

For the FAQ at the end, we'll use the three most relevant: install, hide-on-scroll usage, and customization/animations.

4. Article — Practical guide & examples

What is react-headroom and when to use it?

react-headroom is a React wrapper around a simple scroll-detection mechanism that pins or unpins a header based on scroll direction and velocity. It saves screen real estate by hiding navigation while reading, then quickly revealing it on upward scroll so users can access navigation without manual scrolling.

This component is not a full-featured layout library — it focuses on a single UX pattern (hide-on-scroll) and exposes hooks and props for common needs. Use it when you want a lightweight, battle-tested solution for auto-hiding headers without reinventing scroll handling.

Benefits include a small footprint, straightforward API, and compatibility with typical React apps. Downsides to be aware of: default inline styles can clash with your design system and edge cases like mobile overscroll (rubber band) or SSR require extra handling.

Install & getting started

Install the package with your package manager of choice. The npm page is the canonical install reference but the command is simple:

npm install react-headroom --save
# or
yarn add react-headroom

Then import and wrap your header component. This minimal example is the shortest path to a working auto-hiding header:

import React from 'react';
import Headroom from 'react-headroom';

function AppHeader() {
  return (
    <Headroom>
      <header className="site-header">
        <nav>...</nav>
      </header>
    </Headroom>
  );
}

If you prefer a step-by-step tutorial, this blog post walks through the same flow with screenshots and a live demo: react-headroom tutorial. For package details and source, check the official repo: react-headroom GitHub and the npm listing: react-headroom installation.

Basic usage example (copy-paste)

Here's a slightly more complete example including simple styling and a nav. Paste this into a React app to see react-headroom in action. It uses the default behaviour: hide on scroll down, show on scroll up.

/* AppHeader.jsx */
import React from 'react';
import Headroom from 'react-headroom';
import './AppHeader.css';

export default function AppHeader() {
  return (
    <Headroom>
      <header className="site-header">
        <div className="logo">MySite</div>
        <nav className="main-nav">...</nav>
      </header>
    </Headroom>
  );
}

Add CSS transitions for smooth reveal/hide. By default react-headroom injects some inline styles; you can disable them and control everything with classes (see next section).

Note: run this with enough scrollable content below the header to observe the hide/show behaviour. If your page is short, the header won't toggle because no significant scroll occurs.

Customization & important props

Key props you'll use often:

• upTolerance / downTolerance — how many pixels constitute a meaningful scroll before the component reacts.
• pinStart — the Y-coordinate after which pin/unpin logic starts.
• disableInlineStyles — set to true to prevent the component from injecting inline styles so you can control transitions via CSS.
• onPin, onUnpin, onUnfix, onFix — callbacks for state changes which are useful to toggle classes or trigger analytics.

Example: increase sensitivity so small scrolls don't toggle the header:

<Headroom upTolerance={10} downTolerance={10} pinStart={100} />

Use disableInlineStyles when you want consistent animations under your site CSS. Then add a few CSS rules for the pinned/unpinned states. If you need to toggle classes instead of inline styles, attach to the lifecycle callbacks or wrap Headroom and set a class on your header element.

Animations, styling and disabling inline styles

By default, react-headroom provides a basic translateY transition for pin/unpin. That’s convenient, but often you'll want different easing, duration, or combined transforms (scale, blur). The recommended pattern is to disable inline styles and write CSS transitions keyed to the class names you control.

Strategy: set disableInlineStyles={true}, then in your CSS create transitions for the classes you add via callbacks, e.g. .is-pinned or .is-unpinned. Alternatively, inspect the default classNames in the DOM and override them with stricter selectors.

Example CSS (simple slide):

.site-header{transition:transform 240ms ease-in-out}
.site-header.is-unpinned{transform:translateY(-100%)}
.site-header.is-pinned{transform:translateY(0)}

Edge cases, accessibility & SSR notes

Server-side rendering: if your app renders on the server, the initial headroom state may differ between server and client (no scroll on server). Avoid layout shifts by controlling initial styles or rendering a static header until the client hydrates.

Mobile bounce (overscroll): On iOS or some Android browsers, rubber-band overscroll can create flicker. You can mitigate it by tuning tolerance props and testing on real devices; in some cases disabling hide-on-scroll on small screens improves UX.

Accessibility: hiding the header does not remove it from the accessibility tree by default. Ensure focus management works if your header contains interactive elements (e.g., search or skip-links). Consider keeping key controls statically available for keyboard users or provide an explicit show/hide toggle for screen reader users.

Troubleshooting & common pitfalls

Common issues include header overlapping content when hidden (z-index), jitter because of CSS transitions on height, or conflicts with other scroll listeners. Ensure your header has a layout that reserves space (e.g., fixed header with body padding) or uses position: sticky when appropriate.

If animations appear choppy, try GPU-accelerated transforms (translateZ(0)) and avoid animating expensive properties (width/height). Also confirm you’re not stacking multiple scroll listeners that reflow layout on each scroll event.

When things go wrong, reproduce the minimal example first (the one above). If the minimal example works but your app doesn't, progressively add your styles and scripts until you find the conflict.

5. SEO & voice search optimization

To target featured snippets and voice search: provide short, direct answers immediately after headings. For example, right under “How do I install react-headroom?” place a 1–2 sentence answer containing the install command. Use schema.org FAQ (included) and keep answers concise for voice assistants.

Meta elements are included at the top of this document. Use an H1 that matches the primary keyword (react-headroom) and several H2s for intent-focused queries: install, example, customization. Keep the first paragraph as a clear one-line definition for snippet extraction.

Suggested microcopy (for voice): “Install react-headroom with npm install react-headroom or yarn add react-headroom, then import Headroom from 'react-headroom' and wrap your header.” This exact sentence works well for featured snippets and voice responses.

6. Backlinks & authoritative anchors (suggested)

When publishing, link to authoritative resources using exact-match or partial-match anchors where appropriate:

• react-headroom GitHub — use for source code and API reference.
• react-headroom installation — use for installation instructions and version info.
• react-headroom tutorial — an approachable walkthrough for beginners.

These links support trust signals and help search engines contextualize your page around the react-headroom topic.

7. Final FAQ (3 selected PAA answers)

How do I install react-headroom?

Run npm install react-headroom --save or yarn add react-headroom. Then import via import Headroom from 'react-headroom' and wrap your header element with <Headroom>…</Headroom>.

How do I hide a React header on scroll using react-headroom?

Wrap the header in <Headroom>. By default the library hides the header when scrolling down and reveals it on scroll up. Configure sensitivity with upTolerance and downTolerance, and set pinStart to delay activation until a vertical offset.

Can I customize animations and styles in react-headroom?

Yes. Use disableInlineStyles to stop built-in inline styles, then add your own CSS transitions. Use lifecycle callbacks (onPin, onUnpin) to toggle classes for more precise control.

8. Publish-ready SEO Title & Description

Title (≤70 chars): React Headroom Guide — Auto-Hiding Header & Setup

Description (≤160 chars): Complete guide to react-headroom: install, setup, examples, customization, animations and scroll detection for auto-hiding React headers.

9. Final notes & recommendations

Put a runnable example (CodeSandbox or StackBlitz) near the top so users can interact immediately; that increases dwell time and CTR. Add a small troubleshooting block for SSR and mobile overscroll, and a copyable install snippet for featured snippets.

Keep the article updated—monitor the react-headroom repo for breaking changes and update your examples when new versions alter props or behaviours.

If you want, I can generate a ready-made CodeSandbox example, copy-ready CSS for disabling inline styles, or a shorter blog version optimized for a specific keyword (e.g., "React sticky navigation").