Docs
TextAnimate
TextAnimate
A framer motion text animation component
Roll In
Whip In
fade In
Fade In
Pop In
Pop In
Fade In Up
Fade In Up
Shift In Up
Shift In Up
Whip In Up
Whip In Up
Calm In Up
Calm In Up
Installation
Copy and paste the following code into your project.
"use client"
import { FC, useEffect, useRef } from "react"
import { HTMLMotionProps, motion, useAnimation, useInView } from "framer-motion"
type AnimationType =
| "fadeIn"
| "fadeInUp"
| "popIn"
| "shiftInUp"
| "rollIn"
| "whipIn"
| "whipInUp"
| "calmInUp"
interface Props extends HTMLMotionProps<"div"> {
text: string
type?: AnimationType
delay?: number
duration?: number
}
const animationVariants = {
fadeIn: {
container: {
hidden: { opacity: 0 },
visible: (i: number = 1) => ({
opacity: 1,
transition: { staggerChildren: 0.05, delayChildren: i * 0.3 },
}),
},
child: {
visible: {
opacity: 1,
y: [0, -10, 0],
transition: {
type: "spring",
damping: 12,
stiffness: 100,
},
},
hidden: { opacity: 0, y: 10 },
},
},
fadeInUp: {
container: {
hidden: { opacity: 0 },
visible: {
opacity: 1,
transition: { staggerChildren: 0.1, delayChildren: 0.2 },
},
},
child: {
visible: { opacity: 1, y: 0, transition: { duration: 0.5 } },
hidden: { opacity: 0, y: 20 },
},
},
popIn: {
container: {
hidden: { scale: 0 },
visible: {
scale: 1,
transition: { staggerChildren: 0.05, delayChildren: 0.2 },
},
},
child: {
visible: {
opacity: 1,
scale: 1.1,
transition: { type: "spring", damping: 15, stiffness: 400 },
},
hidden: { opacity: 0, scale: 0 },
},
},
calmInUp: {
container: {
hidden: {},
visible: (i: number = 1) => ({
transition: { staggerChildren: 0.01, delayChildren: 0.2 * i },
}),
},
child: {
hidden: {
y: "200%",
transition: { ease: [0.455, 0.03, 0.515, 0.955], duration: 0.85 },
},
visible: {
y: 0,
transition: {
ease: [0.125, 0.92, 0.69, 0.975], // Drawing attention to dynamic content or interactive elements, where the animation needs to be engaging but not abrupt
duration: 0.75,
// ease: [0.455, 0.03, 0.515, 0.955], // smooth and gradual acceleration followed by a steady deceleration towards the end of the animation
// ease: [0.115, 0.955, 0.655, 0.939], // smooth and gradual acceleration followed by a steady deceleration towards the end of the animation
// ease: [0.09, 0.88, 0.68, 0.98], // Very Gentle Onset, Swift Mid-Section, Soft Landing
// ease: [0.11, 0.97, 0.64, 0.945], // Minimal Start, Energetic Acceleration, Smooth Closure
},
},
},
},
shiftInUp: {
container: {
hidden: {},
visible: (i: number = 1) => ({
transition: { staggerChildren: 0.01, delayChildren: 0.2 * i },
}),
},
child: {
hidden: {
y: "100%", // Starting from below but not too far to ensure a dramatic but manageable shift.
transition: {
ease: [0.75, 0, 0.25, 1], // Starting quickly
duration: 0.6, // Shortened duration for a more dramatic start
},
},
visible: {
y: 0,
transition: {
duration: 0.8, // Slightly longer to accommodate the slow middle and swift end
ease: [0.22, 1, 0.36, 1], // This easing function starts quickly (dramatic shift), slows down (slow middle), and ends quickly (clean swift end)
},
},
},
},
whipInUp: {
container: {
hidden: {},
visible: (i: number = 1) => ({
transition: { staggerChildren: 0.01, delayChildren: 0.2 * i },
}),
},
child: {
hidden: {
y: "200%",
transition: { ease: [0.455, 0.03, 0.515, 0.955], duration: 0.45 },
},
visible: {
y: 0,
transition: {
ease: [0.5, -0.15, 0.25, 1.05],
duration: 0.75,
},
},
},
},
rollIn: {
container: {
hidden: {},
visible: {},
},
child: {
hidden: {
opacity: 0,
y: `0.25em`,
},
visible: {
opacity: 1,
y: `0em`,
transition: {
duration: 0.65,
ease: [0.65, 0, 0.75, 1], // Great! Swift Beginning, Prolonged Ease, Quick Finish
// ease: [0.75, 0.05, 0.85, 1], // Quick Start, Smooth Middle, Sharp End
// ease: [0.7, -0.25, 0.9, 1.25], // Fast Acceleration, Gentle Slowdown, Sudden Snap
// ease: [0.7, -0.5, 0.85, 1.5], // Quick Leap, Soft Glide, Snappy Closure
},
},
},
},
whipIn: {
container: {
hidden: {},
visible: {},
},
child: {
hidden: {
opacity: 0,
y: `0.35em`,
},
visible: {
opacity: 1,
y: `0em`,
transition: {
duration: 0.45,
// ease: [0.75, 0.05, 0.85, 1], // Quick Start, Smooth Middle, Sharp End
// ease: [0.7, -0.25, 0.9, 1.25], // Fast Acceleration, Gentle Slowdown, Sudden Snap
// ease: [0.65, 0, 0.75, 1], // Great! Swift Beginning, Prolonged Ease, Quick Finish
ease: [0.85, 0.1, 0.9, 1.2], // Rapid Initiation, Subtle Slow, Sharp Conclusion
},
},
},
},
}
const TextAnimate: FC<Props> = ({
text,
type = "whipInUp",
...props
}: Props) => {
// const { ref, inView } = useInView({
// threshold: 0.5,
// triggerOnce: true,
// });
const ref = useRef(null)
const isInView = useInView(ref, { once: true })
const letters = Array.from(text)
const { container, child } = animationVariants[type]
const ctrls = useAnimation()
// useEffect(() => {
// if (isInView) {
// ctrls.start("visible");
// }
// if (!isInView) {
// ctrls.start("hidden");
// }
// }, [ctrls, isInView]);
if (type === "rollIn" || type === "whipIn") {
return (
<h2 className="mt-10 text-3xl font-black text-black dark:text-neutral-100 py-5 pb-8 px-8 md:text-5xl">
{text.split(" ").map((word, index) => {
return (
<motion.span
ref={ref}
className="inline-block mr-[0.25em] whitespace-nowrap"
aria-hidden="true"
key={index}
initial="hidden"
animate="visible"
variants={container}
transition={{
delayChildren: index * 0.13,
// delayChildren: index * 0.35,
staggerChildren: 0.025,
// staggerChildren: 0.05,
}}
>
{word.split("").map((character, index) => {
return (
<motion.span
aria-hidden="true"
key={index}
variants={child}
className="inline-block -mr-[0.01em]"
>
{character}
</motion.span>
)
})}
</motion.span>
)
})}
</h2>
)
}
return (
<motion.h2
style={{ display: "flex", overflow: "hidden" }}
role="heading"
variants={container}
initial="hidden"
animate="visible"
className="mt-10 text-4xl font-black text-black dark:text-neutral-100 py-5 pb-8 px-8 md:text-5xl"
{...props}
>
{letters.map((letter, index) => (
<motion.span key={index} variants={child}>
{letter === " " ? "\u00A0" : letter}
</motion.span>
))}
</motion.h2>
)
}
export { TextAnimate }
export TextAnimate
Update the import paths to match your project setup.
Usage
import { TextAnimate } from "@/components/ui/text-animate"
<TextAnimate text="Roll In" type="rollIn" />