Text reveal
motionFreeMITWords go from faint to full as the reader scrolls through a paragraph.
npx shadcn@latest add https://mikkelmanniche.dk/lab/r/text-reveal.jsonPreview
The preview could not load.
Live demo in the dark theme.
Code
Install
npx shadcn@latest add https://mikkelmanniche.dk/lab/r/text-reveal.jsonWith the registry added (components.json)
npx shadcn@latest add @manniche/text-revealUsage
text-reveal-demo.tsx
import { TextReveal } from '@/components/text-reveal'
export default function TextRevealDemo() {
return (
<TextReveal className="font-serif text-3xl leading-snug">
A good shop page answers three questions before the visitor asks them: what it costs, when it arrives, and how to send it back.
</TextReveal>
)
}Source
text-reveal.tsx
import { useEffect, useRef, useState } from 'react'
import { useReducedMotion } from '@/registry/manniche/hooks/use-reduced-motion'
import { cn } from '@/lib/utils'
export type TextRevealProps = {
/** Plain text. Each word lights up as the paragraph scrolls past. */
children: string
/** Classes for the paragraph. */
className?: string
}
/**
* Words go from half strength to full as the reader scrolls through the paragraph. The unlit words keep enough contrast to read as large text.
* The text is always in the DOM in full, so screen readers and search engines read it normally.
* Under reduced motion every word is at full strength from the start.
*/
export function TextReveal({ children, className }: TextRevealProps) {
const reduced = useReducedMotion()
const el = useRef<HTMLParagraphElement>(null)
const words = children.split(/(\s+)/)
const count = words.filter((w) => !/^\s+$/.test(w)).length
const [lit, setLit] = useState(count)
useEffect(() => {
if (reduced) {
setLit(count)
return
}
let frame = 0
const run = () => {
cancelAnimationFrame(frame)
frame = requestAnimationFrame(() => {
const p = el.current
if (!p) return
const r = p.getBoundingClientRect()
const t = Math.min(1, Math.max(0, (innerHeight * 0.85 - r.top) / (r.height + innerHeight * 0.35)))
setLit(Math.round(t * count))
})
}
run()
addEventListener('scroll', run, { passive: true })
addEventListener('resize', run)
return () => {
cancelAnimationFrame(frame)
removeEventListener('scroll', run)
removeEventListener('resize', run)
}
}, [reduced, count])
let i = 0
return (
<p ref={el} className={cn('text-pretty', className)}>
{words.map((w, j) => {
if (/^\s+$/.test(w)) return w
const on = i++ < lit
return (
<span key={j} className={cn('transition-opacity duration-200 motion-reduce:transition-none', on ? 'opacity-100' : 'opacity-50')}>
{w}
</span>
)
})}
</p>
)
}use-reduced-motion.ts
import { useSyncExternalStore } from 'react'
const QUERY = '(prefers-reduced-motion: reduce)'
function subscribe(onChange: () => void) {
const mq = window.matchMedia(QUERY)
mq.addEventListener('change', onChange)
return () => mq.removeEventListener('change', onChange)
}
/** True when the visitor has asked the system for less motion. */
export function useReducedMotion() {
return useSyncExternalStore(
subscribe,
() => window.matchMedia(QUERY).matches,
() => false,
)
}Props
TextRevealProps
| Prop | Type | Default | What it does |
|---|---|---|---|
children required | string | – | Plain text. Each word lights up as the paragraph scrolls past. |
className | string | – | Classes for the paragraph. |
A11y
Screen reader
The whole text is always in the DOM as a plain paragraph, with each word in a span, so screen readers read it normally. Nothing is hidden or relabelled.
Reduced motion
Under reduced motion every word is at full strength from the start, the colour transition is off and the scroll listener is not attached.
Other
Words that are not yet lit sit at 50% opacity, which keeps the contrast needed for large text in both the light and the dark theme. Use it on large type only.