Text Hover Effect
A text hover effect that animates and outlines gradient on hover, as seen on x.ai
Installation
Install dependencies
npm i motion clsx tailwind-merge
Add util file
lib/utils.ts
import { ClassValue, clsx } from "clsx";
import { twMerge } from "tailwind-merge";
export function cn(...inputs: ClassValue[]) {
return twMerge(clsx(inputs));
}
Add Tailwind CSS plugin for variable classes
tailwind.config.ts
const defaultTheme = require("tailwindcss/defaultTheme");
const colors = require("tailwindcss/colors");
const {
default: flattenColorPalette,
} = require("tailwindcss/lib/util/flattenColorPalette");
/** @type {import('tailwindcss').Config} */
module.exports = {
content: ["./src/**/*.{ts,tsx}"],
darkMode: "class",
theme: {
// rest of the code
},
plugins: [addVariablesForColors],
};
function addVariablesForColors({ addBase, theme }: any) {
let allColors = flattenColorPalette(theme("colors"));
let newVars = Object.fromEntries(
Object.entries(allColors).map(([key, val]) => [`--${key}`, val])
);
addBase({
":root": newVars,
});
}
Copy the source code
components/ui/text-hover-effect.tsx
"use client";
import React, { useRef, useEffect, useState } from "react";
import { motion } from "framer-motion";
export const TextHoverEffect = ({
text,
duration,
}: {
text: string;
duration?: number;
automatic?: boolean;
}) => {
const svgRef = useRef<SVGSVGElement>(null);
const [cursor, setCursor] = useState({ x: 0, y: 0 });
const [hovered, setHovered] = useState(false);
const [maskPosition, setMaskPosition] = useState({ cx: "50%", cy: "50%" });
useEffect(() => {
if (svgRef.current && cursor.x !== null && cursor.y !== null) {
const svgRect = svgRef.current.getBoundingClientRect();
const cxPercentage = ((cursor.x - svgRect.left) / svgRect.width) * 100;
const cyPercentage = ((cursor.y - svgRect.top) / svgRect.height) * 100;
setMaskPosition({
cx: `${cxPercentage}%`,
cy: `${cyPercentage}%`,
});
}
}, [cursor]);
return (
<svg
ref={svgRef}
width="100%"
height="100%"
viewBox="0 0 300 100"
xmlns="http://www.w3.org/2000/svg"
onMouseEnter={() => setHovered(true)}
onMouseLeave={() => setHovered(false)}
onMouseMove={(e) => setCursor({ x: e.clientX, y: e.clientY })}
className="select-none"
>
<defs>
<linearGradient
id="textGradient"
gradientUnits="userSpaceOnUse"
cx="50%"
cy="50%"
r="25%"
>
{hovered && (
<>
<stop offset="0%" stopColor={"var(--yellow-500)"} />
<stop offset="25%" stopColor={"var(--red-500)"} />
<stop offset="50%" stopColor={"var(--blue-500)"} />
<stop offset="75%" stopColor={"var(--cyan-500)"} />
<stop offset="100%" stopColor={"var(--violet-500)"} />
</>
)}
</linearGradient>
<motion.radialGradient
id="revealMask"
gradientUnits="userSpaceOnUse"
r="20%"
animate={maskPosition}
transition={{ duration: duration ?? 0, ease: "easeOut" }}
// example for a smoother animation below
// transition={{
// type: "spring",
// stiffness: 300,
// damping: 50,
// }}
>
<stop offset="0%" stopColor="white" />
<stop offset="100%" stopColor="black" />
</motion.radialGradient>
<mask id="textMask">
<rect
x="0"
y="0"
width="100%"
height="100%"
fill="url(#revealMask)"
/>
</mask>
</defs>
<text
x="50%"
y="50%"
textAnchor="middle"
dominantBaseline="middle"
strokeWidth="0.3"
className="font-[helvetica] font-bold stroke-neutral-200 dark:stroke-neutral-800 fill-transparent text-7xl "
style={{ opacity: hovered ? 0.7 : 0 }}
>
{text}
</text>
<motion.text
x="50%"
y="50%"
textAnchor="middle"
dominantBaseline="middle"
strokeWidth="0.3"
className="font-[helvetica] font-bold fill-transparent text-7xl stroke-neutral-200 dark:stroke-neutral-800"
initial={{ strokeDashoffset: 1000, strokeDasharray: 1000 }}
animate={{
strokeDashoffset: 0,
strokeDasharray: 1000,
}}
transition={{
duration: 4,
ease: "easeInOut",
}}
>
{text}
</motion.text>
<text
x="50%"
y="50%"
textAnchor="middle"
dominantBaseline="middle"
stroke="url(#textGradient)"
strokeWidth="0.3"
mask="url(#textMask)"
className="font-[helvetica] font-bold fill-transparent text-7xl "
>
{text}
</text>
</svg>
);
};
Props
Prop | Type | Default | Description |
---|---|---|---|
text | string | Required | The text to be displayed with the hover effect |
duration | number | 0 | The duration of the mask transition animation in seconds |
The initial code of this component is contributed by Sudhanshu Mishra
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.
I've been working with Manu for a couple of months now and I can't express enough how impressed I am with his talent. Manu's JavaScript/React web UI programming skills are through the roof. He's he...
Tony Pujals
Founder at Fantastic Realms, Tech Lead at Google