Charcoal UI

Scroll Cue

A scroll hint: a mouse outline with a dropping wheel dot, a bouncing chevron, or a label with a falling line, fading out once the reader scrolls.

  • Category: Feedback
  • Licence: Charcoal UI Pro
  • Built with: React 19, Tailwind CSS 4, Motion
  • Dependencies: motion, clsx, tailwind-merge

Examples

Scroll Cue

API reference

PropTypeDefaultDescription
variant"mouse" | "chevron" | "text""mouse"
labelstring"Scroll"
hideAfternumber40Hide once scrolled this many px.
containerRefObject<HTMLElement>—
classNamestring—

About Scroll Cue

Scroll Cue tells people there is more below: a mouse outline with a dropping wheel dot, a bouncing chevron, or a label with a falling line, fading out once they scroll.

Scroll Cue is a feedback component for React 19, styled with Tailwind CSS 4 and animated with Motion. It drops into Next.js, Vite, Remix or Astro through the shadcn CLI as a single file you own.

When to use Scroll Cue

  • Full-screen heroes.
  • Portfolio intros.
  • Story-driven landing pages.
  • Slide-style layouts.

How it works

It watches the page or a container and fades after hideAfter pixels. It is decorative and hidden from screen readers.

State changes are announced through live regions or the right ARIA roles, so screen-reader users hear what sighted users see. With prefers-reduced-motion on, it holds still or settles instantly instead of animating.

Customizing Scroll Cue

Every prop is documented in the API reference above with its type and default. The ones you will reach for first are listed here.

The Customize panel next to the preview lets you change variant, label live, and the Code tab updates to match, so the snippet you copy already carries your values.

  • variant ("mouse" | "chevron" | "text", default "mouse").
  • label (string, default "Scroll").
  • hideAfter (number, default 40): Hide once scrolled this many px.
  • container (RefObject<HTMLElement>).

Goes well with Scroll Cue

These feedback pieces share its tokens and motion language, so they sit together on one page without clashing.

  • Typing Indicator: A React typing indicator: a bubble with rippling dots that tells screen readers who is typing
  • Countdown: An animated React countdown timer whose digits roll as they tick
  • Confetti: React confetti that bursts from any point on a throwaway canvas
  • Ripple: A React press ripple that spreads from the exact point you pressed
  • Success Check: A React spinner that resolves into a drawn check or a shaking cross

Install Scroll Cue

npx shadcn@latest add @charcoal/scroll-cue

Scroll Cue is part of Charcoal UI Pro. One seat unlocks all 300 Pro components, 107 landing-page sections and 100 full templates, for every personal and client project, with updates included. Add the @charcoal registry once with your access token, then the command above copies scroll-cue.tsx into components/ui and installs clsx, tailwind-merge.

You own the file you install: no runtime package, no lock-in, nothing to keep in sync. Change it however your product needs.

See Charcoal UI Pro pricing · Pro setup

Frequently asked questions

When does the scroll cue disappear?
Once the page or container has scrolled past hideAfter pixels, so it nudges first-time visitors and then gets out of the way.
How do I install Scroll Cue?
Scroll Cue is part of Charcoal UI Pro. Add the @charcoal registry to components.json with your access token, then run npx shadcn@latest add @charcoal/scroll-cue. It copies scroll-cue.tsx into components/ui and installs motion, clsx, tailwind-merge.
Is Scroll Cue free for commercial use?
Scroll Cue needs a Charcoal UI Pro seat, monthly or a one-time lifetime price. A seat covers unlimited personal and commercial projects, including client work, and every future Pro component.
Does Scroll Cue work with Next.js?
Yes. It is a client component for React 19 styled with Tailwind CSS 4, so it works in the Next.js App Router and Pages Router, Vite, Remix and Astro.
Can an AI coding agent install Scroll Cue?
Yes. Connect the Charcoal UI MCP server (https://charcoalui.com/mcp) to Claude Code, Cursor or any MCP client; get_component returns Scroll Cue's props and get_install_command returns the exact command.

Scroll Cue as Markdown · llms.txt