Container Text Flip
A container that flips through words, animating the width.
better
Installation
Install dependencies
npm i motion clsx tailwind-merge
Add util file
import { ClassValue, clsx } from "clsx";
import { twMerge } from "tailwind-merge";
export function cn(...inputs: ClassValue[]) {
return twMerge(clsx(inputs));
}
Copy the source code
components/ui/container-text-flip.tsx
"use client";
import React, { useState, useEffect, useId } from "react";
import "@/app/styles/prism-theme.css";
import { motion } from "motion/react";
import { cn } from "@/utils/cn";
export interface ContainerTextFlipProps {
/** Array of words to cycle through in the animation */
words?: string[];
/** Time in milliseconds between word transitions */
interval?: number;
/** Additional CSS classes to apply to the container */
className?: string;
/** Additional CSS classes to apply to the text */
textClassName?: string;
/** Duration of the transition animation in milliseconds */
animationDuration?: number;
}
export function ContainerTextFlip({
words = ["better", "modern", "beautiful", "awesome"],
interval = 3000,
className,
textClassName,
animationDuration = 700,
}: ContainerTextFlipProps) {
const id = useId();
const [currentWordIndex, setCurrentWordIndex] = useState(0);
const [width, setWidth] = useState(100);
const textRef = React.useRef(null);
const updateWidthForWord = () => {
if (textRef.current) {
// Add some padding to the text width (30px on each side)
// @ts-ignore
const textWidth = textRef.current.scrollWidth + 30;
setWidth(textWidth);
}
};
useEffect(() => {
// Update width whenever the word changes
updateWidthForWord();
}, [currentWordIndex]);
useEffect(() => {
const intervalId = setInterval(() => {
setCurrentWordIndex((prevIndex) => (prevIndex + 1) % words.length);
// Width will be updated in the effect that depends on currentWordIndex
}, interval);
return () => clearInterval(intervalId);
}, [words, interval]);
return (
<motion.p
layout
layoutId={`words-here-${id}`}
animate={{ width }}
transition={{ duration: animationDuration / 2000 }}
className={cn(
"relative inline-block rounded-lg pt-2 pb-3 text-center text-4xl font-bold text-black md:text-7xl dark:text-white",
"[background:linear-gradient(to_bottom,var(--color-gray-100),var(--color-gray-200))]",
"shadow-[inset_0_-1px_var(--color-gray-300),inset_0_0_0_1px_var(--color-gray-300),_0_4px_8px_var(--color-gray-300)]",
"dark:[background:linear-gradient(to_bottom,var(--color-neutral-700),var(--color-neutral-800))]",
"dark:shadow-[inset_0_-1px_#10171e,inset_0_0_0_1px_hsla(205,89%,46%,.24),_0_4px_8px_#00000052]",
className,
)}
key={words[currentWordIndex]}
>
<motion.div
transition={{
duration: animationDuration / 1000,
ease: "easeInOut",
}}
className={cn("inline-block", textClassName)}
ref={textRef}
layoutId={`word-div-${words[currentWordIndex]}-${id}`}
>
<motion.div className="inline-block">
{words[currentWordIndex].split("").map((letter, index) => (
<motion.span
key={index}
initial={{
opacity: 0,
filter: "blur(10px)",
}}
animate={{
opacity: 1,
filter: "blur(0px)",
}}
transition={{
delay: index * 0.02,
}}
>
{letter}
</motion.span>
))}
</motion.div>
</motion.div>
</motion.p>
);
}
Examples
Standard
better
Hero section with animation
Make your websites look 10x better
better
Props
Prop | Type | Default | Description |
---|---|---|---|
words | string[] | ["better", "modern", "beautiful", "awesome"] | Array of words to cycle through in the animation |
interval | number | 3000 | Time in milliseconds between word transitions |
className | string | - | Additional CSS classes to apply to the container |
textClassName | string | - | Additional CSS classes to apply to the text |
animationDuration | number | 700 | Duration of the transition animation in milliseconds |
Get beautiful, hand-crafted templates and components with Aceternity UI Pro
Professional, beautiful and elegant templates for your business. Get the best component packs and templates with Aceternity UI Pro.
Manu was such a pleasure to work with. Talented, communicative and fast. Highly recommend!
Jonathan Barshop
Founder at Barshop Studios