square-arrow-down

PreviousNext
Docs
lucide-animatedui

Preview

Loading preview…
square-arrow-down.tsx
'use client';

import type { Variants } from 'motion/react';
import type { HTMLAttributes } from 'react';
import { forwardRef, useCallback, useImperativeHandle, useRef } from 'react';
import { motion, useAnimation } from 'motion/react';

import { cn } from '@/lib/utils';

export interface SquareArrowDownIconHandle {
  startAnimation: () => void;
  stopAnimation: () => void;
}

interface SquareArrowDownIconProps extends HTMLAttributes<HTMLDivElement> {
  size?: number;
}

const SQUARE_VARIANTS: Variants = {
  normal: { transition: { duration: 0.4 } },
  animate: { transition: { duration: 0.6, ease: 'easeInOut' } },
};

const PATH_VARIANTS: Variants = {
  normal: { d: 'm8 12 4 4 4-4', translateY: 0, opacity: 1 },
  animate: {
    d: 'm8 12 4 4 4-4',
    translateY: [0, -3, 0],
    transition: { duration: 0.4 },
  },
};

const SECOND_PATH_VARIANTS: Variants = {
  normal: { d: 'M12 8v8', opacity: 1 },
  animate: {
    d: ['M12 8v8', 'M12 8v5', 'M12 8v8'],
    transition: { duration: 0.4 },
  },
};

const SquareArrowDownIcon = forwardRef<
  SquareArrowDownIconHandle,
  SquareArrowDownIconProps
>(({ onMouseEnter, onMouseLeave, className, size = 28, ...props }, ref) => {
  const controls = useAnimation();
  const isControlledRef = useRef(false);

  useImperativeHandle(ref, () => {
    isControlledRef.current = true;
    return {
      startAnimation: () => controls.start('animate'),
      stopAnimation: () => controls.start('normal'),
    };
  });

  const handleMouseEnter = useCallback(
    (e: React.MouseEvent<HTMLDivElement>) => {
      if (!isControlledRef.current) controls.start('animate');
      else onMouseEnter?.(e);
    },
    [controls, onMouseEnter]
  );

  const handleMouseLeave = useCallback(
    (e: React.MouseEvent<HTMLDivElement>) => {
      if (!isControlledRef.current) controls.start('normal');
      else onMouseLeave?.(e);
    },
    [controls, onMouseLeave]
  );

  return (
    <div
      className={cn(className)}
      onMouseEnter={handleMouseEnter}
      onMouseLeave={handleMouseLeave}
      {...props}
    >
      <svg
        xmlns="http://www.w3.org/2000/svg"
        width={size}
        height={size}
        viewBox="0 0 24 24"
        fill="none"
        stroke="currentColor"
        strokeWidth="2"
        strokeLinecap="round"
        strokeLinejoin="round"
      >
        <motion.rect
          width="18"
          height="18"
          x="3"
          y="3"
          rx="2"
          variants={SQUARE_VARIANTS}
          animate={controls}
          initial="normal"
        />
        <motion.path
          variants={PATH_VARIANTS}
          animate={controls}
          initial="normal"
          d="m8 12 4 4 4-4"
        />
        <motion.path
          variants={SECOND_PATH_VARIANTS}
          animate={controls}
          initial="normal"
          d="M12 8v8"
        />
      </svg>
    </div>
  );
});

SquareArrowDownIcon.displayName = 'SquareArrowDownIcon';

export { SquareArrowDownIcon };

Installation

npx shadcn@latest add @lucide-animated/square-arrow-down

Usage

import { SquareArrowDown } from "@/components/ui/square-arrow-down"
<SquareArrowDown />