Skip to content

UI Library for Design Engineers. Animated components and effects you can copy and paste into your apps. Free. Open Source.

fix(ripple-button): clean up overlapping ripples independently (#1020)

xpeng5278-webefe76fc5755e
diff --git a/apps/www/public/llms-full.txt b/apps/www/public/llms-full.txt
index a86986b8..b2e6f4fd 100644
--- a/apps/www/public/llms-full.txt
+++ b/apps/www/public/llms-full.txt
@@ -16510,7 +16510,13 @@ Description: An animated button with ripple useful for user engagement.
--- file: magicui/ripple-button.tsx ---
"use client"
-import React, { useEffect, useState, type MouseEvent } from "react"
+import React, {
+ useCallback,
+ useEffect,
+ useRef,
+ useState,
+ type MouseEvent,
+} from "react"
import { cn } from "@/lib/utils"
@@ -16519,6 +16525,55 @@ interface RippleButtonProps extends React.ButtonHTMLAttributes<HTMLButtonElement
duration?: string
}
+type RippleItem = {
+ x: number
+ y: number
+ size: number
+ key: number
+}
+
+function ButtonRipple({
+ ripple,
+ duration,
+ rippleColor,
+ onDone,
+}: {
+ ripple: RippleItem
+ duration: string
+ rippleColor: string
+ onDone: (key: number) => void
+}) {
+ useEffect(() => {
+ const timeout = setTimeout(
+ () => {
+ onDone(ripple.key)
+ },
+ parseInt(duration, 10)
+ )
+
+ return () => {
+ clearTimeout(timeout)
+ }
+ }, [duration, onDone, ripple.key])
+
+ return (
+ <span
+ className="animate-rippling bg-background absolute rounded-full opacity-30"
+ style={
+ {
+ width: `${ripple.size}px`,
+ height: `${ripple.size}px`,
+ top: `${ripple.y}px`,
+ left: `${ripple.x}px`,
+ backgroundColor: rippleColor,
+ transform: `scale(0)`,
+ "--duration": duration,
+ } as React.CSSProperties
+ }
+ />
+ )
+}
+
export const RippleButton = React.forwardRef<
HTMLButtonElement,
RippleButtonProps
@@ -16534,9 +16589,14 @@ export const RippleButton = React.forwardRef<
},
ref
) => {
- const [buttonRipples, setButtonRipples] = useState<
- Array<{ x: number; y: number; size: number; key: number }>
- >([])
+ const [buttonRipples, setButtonRipples] = useState<Array<RippleItem>>([])
+ const nextKeyRef = useRef(0)
+
+ const removeRipple = useCallback((key: number) => {
+ setButtonRipples((prevRipples) =>
+ prevRipples.filter((ripple) => ripple.key !== key)
+ )
+ }, [])
const handleClick = (event: MouseEvent<HTMLButtonElement>) => {
createRipple(event)
@@ -16550,29 +16610,11 @@ export const RippleButton = React.forwardRef<
const x = event.clientX - rect.left - size / 2
const y = event.clientY - rect.top - size / 2
- const newRipple = { x, y, size, key: Date.now() }
+ nextKeyRef.current += 1
+ const newRipple = { x, y, size, key: nextKeyRef.current }
setButtonRipples((prevRipples) => [...prevRipples, newRipple])
}
- useEffect(() => {
- let timeout: ReturnType<typeof setTimeout> | null = null
-
- if (buttonRipples.length > 0) {
- const lastRipple = buttonRipples[buttonRipples.length - 1]
- timeout = setTimeout(() => {
- setButtonRipples((prevRipples) =>
- prevRipples.filter((ripple) => ripple.key !== lastRipple.key)
- )
- }, parseInt(duration))
- }
-
- return () => {
- if (timeout !== null) {
- clearTimeout(timeout)
- }
- }
- }, [buttonRipples, duration])
-
return (
<button
className={cn(
@@ -16586,20 +16628,12 @@ export const RippleButton = React.forwardRef<
<div className="relative z-10">{children}</div>
<span className="pointer-events-none absolute inset-0">
{buttonRipples.map((ripple) => (
- <span
- className="animate-rippling bg-background absolute rounded-full opacity-30"
+ <ButtonRipple
key={ripple.key}
- style={
- {
- width: `${ripple.size}px`,
- height: `${ripple.size}px`,
- top: `${ripple.y}px`,
- left: `${ripple.x}px`,
- backgroundColor: rippleColor,
- transform: `scale(0)`,
- "--duration": duration,
- } as React.CSSProperties
- }
+ duration={duration}
+ onDone={removeRipple}
+ ripple={ripple}
+ rippleColor={rippleColor}
/>
))}
</span>
diff --git a/apps/www/public/r/ripple-button.json b/apps/www/public/r/ripple-button.json
index cd88d83d..df496483 100644
--- a/apps/www/public/r/ripple-button.json
+++ b/apps/www/public/r/ripple-button.json
@@ -7,7 +7,7 @@
"files": [
{
"path": "registry/magicui/ripple-button.tsx",
- "content": "\"use client\"\n\nimport React, { useEffect, useState, type MouseEvent } from \"react\"\n\nimport { cn } from \"@/lib/utils\"\n\ninterface RippleButtonProps extends React.ButtonHTMLAttributes<HTMLButtonElement> {\n rippleColor?: string\n duration?: string\n}\n\nexport const RippleButton = React.forwardRef<\n HTMLButtonElement,\n RippleButtonProps\n>(\n (\n {\n className,\n children,\n rippleColor = \"#ffffff\",\n duration = \"600ms\",\n onClick,\n ...props\n },\n ref\n ) => {\n const [buttonRipples, setButtonRipples] = useState<\n Array<{ x: number; y: number; size: number; key: number }>\n >([])\n\n const handleClick = (event: MouseEvent<HTMLButtonElement>) => {\n createRipple(event)\n onClick?.(event)\n }\n\n const createRipple = (event: MouseEvent<HTMLButtonElement>) => {\n const button = event.currentTarget\n const rect = button.getBoundingClientRect()\n const size = Math.max(rect.width, rect.height)\n const x = event.clientX - rect.left - size / 2\n const y = event.clientY - rect.top - size / 2\n\n const newRipple = { x, y, size, key: Date.now() }\n setButtonRipples((prevRipples) => [...prevRipples, newRipple])\n }\n\n useEffect(() => {\n let timeout: ReturnType<typeof setTimeout> | null = null\n\n if (buttonRipples.length > 0) {\n const lastRipple = buttonRipples[buttonRipples.length - 1]\n timeout = setTimeout(() => {\n setButtonRipples((prevRipples) =>\n prevRipples.filter((ripple) => ripple.key !== lastRipple.key)\n )\n }, parseInt(duration))\n }\n\n return () => {\n if (timeout !== null) {\n clearTimeout(timeout)\n }\n }\n }, [buttonRipples, duration])\n\n return (\n <button\n className={cn(\n \"bg-background text-primary relative flex cursor-pointer items-center justify-center overflow-hidden rounded-lg border-2 px-4 py-2 text-center\",\n className\n )}\n onClick={handleClick}\n ref={ref}\n {...props}\n >\n <div className=\"relative z-10\">{children}</div>\n <span className=\"pointer-events-none absolute inset-0\">\n {buttonRipples.map((ripple) => (\n <span\n className=\"animate-rippling bg-background absolute rounded-full opacity-30\"\n key={ripple.key}\n style={\n {\n width: `${ripple.size}px`,\n height: `${ripple.size}px`,\n top: `${ripple.y}px`,\n left: `${ripple.x}px`,\n backgroundColor: rippleColor,\n transform: `scale(0)`,\n \"--duration\": duration,\n } as React.CSSProperties\n }\n />\n ))}\n </span>\n </button>\n )\n }\n)\n\nRippleButton.displayName = \"RippleButton\"\n",
+ "content": "\"use client\"\n\nimport React, {\n useCallback,\n useEffect,\n useRef,\n useState,\n type MouseEvent,\n} from \"react\"\n\nimport { cn } from \"@/lib/utils\"\n\ninterface RippleButtonProps extends React.ButtonHTMLAttributes<HTMLButtonElement> {\n rippleColor?: string\n duration?: string\n}\n\ntype RippleItem = {\n x: number\n y: number\n size: number\n key: number\n}\n\nfunction ButtonRipple({\n ripple,\n duration,\n rippleColor,\n onDone,\n}: {\n ripple: RippleItem\n duration: string\n rippleColor: string\n onDone: (key: number) => void\n}) {\n useEffect(() => {\n const timeout = setTimeout(\n () => {\n onDone(ripple.key)\n },\n parseInt(duration, 10)\n )\n\n return () => {\n clearTimeout(timeout)\n }\n }, [duration, onDone, ripple.key])\n\n return (\n <span\n className=\"animate-rippling bg-background absolute rounded-full opacity-30\"\n style={\n {\n width: `${ripple.size}px`,\n height: `${ripple.size}px`,\n top: `${ripple.y}px`,\n left: `${ripple.x}px`,\n backgroundColor: rippleColor,\n transform: `scale(0)`,\n \"--duration\": duration,\n } as React.CSSProperties\n }\n />\n )\n}\n\nexport const RippleButton = React.forwardRef<\n HTMLButtonElement,\n RippleButtonProps\n>(\n (\n {\n className,\n children,\n rippleColor = \"#ffffff\",\n duration = \"600ms\",\n onClick,\n ...props\n },\n ref\n ) => {\n const [buttonRipples, setButtonRipples] = useState<Array<RippleItem>>([])\n const nextKeyRef = useRef(0)\n\n const removeRipple = useCallback((key: number) => {\n setButtonRipples((prevRipples) =>\n prevRipples.filter((ripple) => ripple.key !== key)\n )\n }, [])\n\n const handleClick = (event: MouseEvent<HTMLButtonElement>) => {\n createRipple(event)\n onClick?.(event)\n }\n\n const createRipple = (event: MouseEvent<HTMLButtonElement>) => {\n const button = event.currentTarget\n const rect = button.getBoundingClientRect()\n const size = Math.max(rect.width, rect.height)\n const x = event.clientX - rect.left - size / 2\n const y = event.clientY - rect.top - size / 2\n\n nextKeyRef.current += 1\n const newRipple = { x, y, size, key: nextKeyRef.current }\n setButtonRipples((prevRipples) => [...prevRipples, newRipple])\n }\n\n return (\n <button\n className={cn(\n \"bg-background text-primary relative flex cursor-pointer items-center justify-center overflow-hidden rounded-lg border-2 px-4 py-2 text-center\",\n className\n )}\n onClick={handleClick}\n ref={ref}\n {...props}\n >\n <div className=\"relative z-10\">{children}</div>\n <span className=\"pointer-events-none absolute inset-0\">\n {buttonRipples.map((ripple) => (\n <ButtonRipple\n key={ripple.key}\n duration={duration}\n onDone={removeRipple}\n ripple={ripple}\n rippleColor={rippleColor}\n />\n ))}\n </span>\n </button>\n )\n }\n)\n\nRippleButton.displayName = \"RippleButton\"\n",
"type": "registry:ui"
}
],
diff --git a/apps/www/registry/magicui/ripple-button.tsx b/apps/www/registry/magicui/ripple-button.tsx
index 0cc571cb..efe83c8d 100644
--- a/apps/www/registry/magicui/ripple-button.tsx
+++ b/apps/www/registry/magicui/ripple-button.tsx
@@ -1,6 +1,12 @@
"use client"
-import React, { useEffect, useState, type MouseEvent } from "react"
+import React, {
+ useCallback,
+ useEffect,
+ useRef,
+ useState,
+ type MouseEvent,
+} from "react"
import { cn } from "@/lib/utils"
@@ -9,6 +15,55 @@ interface RippleButtonProps extends React.ButtonHTMLAttributes<HTMLButtonElement
duration?: string
}
+type RippleItem = {
+ x: number
+ y: number
+ size: number
+ key: number
+}
+
+function ButtonRipple({
+ ripple,
+ duration,
+ rippleColor,
+ onDone,
+}: {
+ ripple: RippleItem
+ duration: string
+ rippleColor: string
+ onDone: (key: number) => void
+}) {
+ useEffect(() => {
+ const timeout = setTimeout(
+ () => {
+ onDone(ripple.key)
+ },
+ parseInt(duration, 10)
+ )
+
+ return () => {
+ clearTimeout(timeout)
+ }
+ }, [duration, onDone, ripple.key])
+
+ return (
+ <span
+ className="animate-rippling bg-background absolute rounded-full opacity-30"
+ style={
+ {
+ width: `${ripple.size}px`,
+ height: `${ripple.size}px`,
+ top: `${ripple.y}px`,
+ left: `${ripple.x}px`,
+ backgroundColor: rippleColor,
+ transform: `scale(0)`,
+ "--duration": duration,
+ } as React.CSSProperties
+ }
+ />
+ )
+}
+
export const RippleButton = React.forwardRef<
HTMLButtonElement,
RippleButtonProps
@@ -24,9 +79,14 @@ export const RippleButton = React.forwardRef<
},
ref
) => {
- const [buttonRipples, setButtonRipples] = useState<
- Array<{ x: number; y: number; size: number; key: number }>
- >([])
+ const [buttonRipples, setButtonRipples] = useState<Array<RippleItem>>([])
+ const nextKeyRef = useRef(0)
+
+ const removeRipple = useCallback((key: number) => {
+ setButtonRipples((prevRipples) =>
+ prevRipples.filter((ripple) => ripple.key !== key)
+ )
+ }, [])
const handleClick = (event: MouseEvent<HTMLButtonElement>) => {
createRipple(event)
@@ -40,29 +100,11 @@ export const RippleButton = React.forwardRef<
const x = event.clientX - rect.left - size / 2
const y = event.clientY - rect.top - size / 2
- const newRipple = { x, y, size, key: Date.now() }
+ nextKeyRef.current += 1
+ const newRipple = { x, y, size, key: nextKeyRef.current }
setButtonRipples((prevRipples) => [...prevRipples, newRipple])
}
- useEffect(() => {
- let timeout: ReturnType<typeof setTimeout> | null = null
-
- if (buttonRipples.length > 0) {
- const lastRipple = buttonRipples[buttonRipples.length - 1]
- timeout = setTimeout(() => {
- setButtonRipples((prevRipples) =>
- prevRipples.filter((ripple) => ripple.key !== lastRipple.key)
- )
- }, parseInt(duration))
- }
-
- return () => {
- if (timeout !== null) {
- clearTimeout(timeout)
- }
- }
- }, [buttonRipples, duration])
-
return (
<button
className={cn(
@@ -76,20 +118,12 @@ export const RippleButton = React.forwardRef<
<div className="relative z-10">{children}</div>
<span className="pointer-events-none absolute inset-0">
{buttonRipples.map((ripple) => (
- <span
- className="animate-rippling bg-background absolute rounded-full opacity-30"
+ <ButtonRipple
key={ripple.key}
- style={
- {
- width: `${ripple.size}px`,
- height: `${ripple.size}px`,
- top: `${ripple.y}px`,
- left: `${ripple.x}px`,
- backgroundColor: rippleColor,
- transform: `scale(0)`,
- "--duration": duration,
- } as React.CSSProperties
- }
+ duration={duration}
+ onDone={removeRipple}
+ ripple={ripple}
+ rippleColor={rippleColor}
/>
))}
</span>