Skip to content

Commit

Permalink
Merge pull request #478 from w3bdesign/add-jsdoc
Browse files Browse the repository at this point in the history
Add Jsdoc to MatrixCursor component
  • Loading branch information
w3bdesign authored Nov 18, 2024
2 parents 59b6ff1 + 5ac1972 commit 52de495
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions src/components/Animations/MatrixCursor.component.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,12 @@ interface MatrixTrail {
char: string;
}

/**
* MatrixCursor component that renders a custom cursor with a matrix trail effect
* @param {MatrixCursorProps} props - The props for the MatrixCursor component
* @param {RefObject<HTMLElement>} props.heroRef - Reference to the hero section element
* @returns {JSX.Element | null} The rendered MatrixCursor component or null if heroRef is not available
*/
const MatrixCursor = ({ heroRef }: MatrixCursorProps) => {
const [cursorPosition, setCursorPosition] = useState({ x: 0, y: 0 });
const [isHovered, setIsHovered] = useState(false);
Expand Down

0 comments on commit 52de495

Please sign in to comment.