CircleDot Cursor

A customizable cursor library that works with both React and vanilla JavaScript projects.

Installation

npm install circledot-cursor

Usage

React Usage

import CustomCursor from "circledot-cursor";

function App() {
  return (
    <div>
      <CustomCursor />
      {/* Your app content */}
    </div>
  );
}

Vanilla JavaScript Usage

Via npm

import CircleDotCursor from "circledot-cursor/dist/vanilla/circledot-cursor.js";

// Initialize the cursor
const cursor = new CircleDotCursor();

// Clean up when needed
// cursor.destroy();

Via CDN

<link
  rel="stylesheet"
  href="https://unpkg.com/circledot-cursor/dist/vanilla/circledot-cursor.css"
/>
<script src="https://unpkg.com/circledot-cursor/dist/vanilla/circledot-cursor.min.js"></script>
<script>
  const cursor = new CircleDotCursor();
</script>

Features

• Smooth cursor following
• Interactive hover effects on buttons and links
• Customizable colors and sizes
• Works with both React and vanilla JavaScript
• Zero dependencies (except React for React version)
• Lightweight and performant

License

MIT