Text Reveal

Documentation Index

Fetch the complete documentation index at: /llms.txt. Use this file to discover all available pages before exploring further.

Reveal text by word or character with stagger, blur, and spring motion.

text-reveal-demo

Overview

Text Reveal introduces one or more lines in reading order. Use word splitting for headings and statements; reserve character splitting for short decorative text.

Installation

npx honestui@latest add text-reveal

Usage

import { TextReveal } from "@/components/animated/text-reveal"

<TextReveal text={["Motion with purpose.", "Details with restraint."]} as="h2" />

Accessibility

The content remains real text in document order. Reduced motion keeps a short opacity transition, and whileInView can defer the effect until the text is visible.

API Reference

PropTypeDefaultDescription
text*string | string[]One line or an ordered list of lines.
asElementType"span"Rendered element.
splitword|char"word"Animation unit.
staggernumber0.09Delay between units.
delaynumber0Delay before the first unit.
blurnumber12Starting blur in pixels.
yOffsetstring | number"40%"Starting vertical offset.
whileInViewbooleanfalseWaits for viewport entry.