André Barros
Aura Cursor Logo

Aura Cursor

Uma biblioteca leve e personalizável para criar cursors customizados em aplicações web modernas. Crie cursors bonitos que seguem o mouse com animações suaves e efeitos interativos de hover. Experimente os controles ao lado para ver as diferentes configurações em tempo real.

Personalizável

Controle tamanho, cor, opacidade, velocidade e muito mais através de props simples. Suporte completo a TypeScript.

Performance

Otimizado para performance com animações suaves usando requestAnimationFrame. Bundle pequeno e zero dependências.

Detecção Inteligente

Detecta automaticamente elementos interativos (links, botões, etc.) e aplica efeitos especiais de hover. Esconde automaticamente quando o mouse sai da janela.

Flexível

Múltiplos modos: outline mode, interactive-only, center dot customizável. Funciona com React, HTML/JavaScript e TypeScript.


Instalação

npm install aura-cursor

Ou usando yarn:

yarn add aura-cursor

Ou usando pnpm:

pnpm add aura-cursor

Como Usar

Exemplo básico com React:

import { AuraCursor } from "aura-cursor/react";

function App() {
  return (
    <>
      <AuraCursor
        size={30}
        color="#3b82f6"
        opacity={0.5}
        speed={0.2}
        hideDefaultCursor={true}
        hoverColor="#3c096c"
        hoverEffect={{
          scale: 1.8,
          color: "#3c096c",
          opacity: 0.5,
        }}
      />
      <YourApp />
    </>
  );
}

Ou usando o hook:

import { useAuraCursor } from "aura-cursor/react";

function App() {
  useAuraCursor({
    size: 30,
    color: "#3b82f6",
    opacity: 0.5,
    speed: 0.2
  });

  return <div>Your app content</div>;
}

Ou usando JavaScript:

import { AuraCursor } from "aura-cursor";

const cursor = new AuraCursor({
  size: 30,
  color: "#3b82f6",
  opacity: 0.5,
  speed: 0.2,
  hideDefaultCursor: true,
  hoverColor: "#3c096c",
  hoverEffect: {
    scale: 1.8,
    color: "#3c096c",
    opacity: 0.5,
  },
});

// Initialize the cursor
cursor.init();

Referência da API

Todas as props disponíveis para personalizar o Aura Cursor:

PropTipoPadrãoDescrição
sizenumber30Tamanho do cursor em pixels
colorstring"#3b82f6"Cor principal do cursor (hex, rgb, etc)
opacitynumber0.5Opacidade do cursor (0-1)
speednumber0.2Velocidade de animação (0-1)
hideDefaultCursorbooleantrueOcultar o cursor padrão do navegador
outlineModebooleanfalseHabilita o modo outline (apenas contorno)
outlineWidthnumber2Largura do outline em pixels
centerDotColorstring"#3b82f6"Cor do ponto central
centerDotSizenumber10Tamanho do ponto central em pixels
hoverColorstring"#3c096c"Cor quando hover em elementos interativos
centerDotHoverColorstring"#3c096c"Cor do ponto central no hover
hoverEffectobject-Efeitos aplicados no hover
hoverEffect.scalenumber1.8Escala do cursor no hover
hoverEffect.colorstring"#3c096c"Cor do cursor no hover
hoverEffect.opacitynumber0.5Opacidade do cursor no hover

Elementos Interativos

Passe o mouse sobre os elementos abaixo para ver os efeitos do cursor:

Link


Controles do Cursor

Básico

30
0.5
0.2

Ponto Central

10

Outline

Hover

1.8
0.5

Opções

Aura Cursor - Biblioteca React para Cursor Personalizado | André Barros