Repository: stephenscaff/react-animated-cursor Branch: master Commit: 94a3b7252f3d Files: 25 Total size: 42.2 KB Directory structure: gitextract_qw9xtc50/ ├── .eslintignore ├── .eslintrc.json ├── .gitignore ├── .npmignore ├── .parcelrc ├── .prettierrc ├── LICENSE ├── docs/ │ └── src/ │ ├── App.js │ ├── DemoContent.js │ ├── DemoCustomTest.js │ ├── DemoFooter.js │ ├── DemoHeader.js │ ├── demo-styles.css │ ├── index.html │ └── index.js ├── lib/ │ ├── AnimatedCursor.tsx │ ├── AnimatedCursor.types.ts │ ├── helpers/ │ │ └── find.ts │ ├── hooks/ │ │ ├── useEventListener.ts │ │ └── useIsTouchdevice.ts │ └── index.ts ├── package.json ├── readme.md ├── rollup.config.mjs └── tsconfig.json ================================================ FILE CONTENTS ================================================ ================================================ FILE: .eslintignore ================================================ *.json build config dist **node_modules** ./node_modules/** ================================================ FILE: .eslintrc.json ================================================ { "env": { "node": true, "browser": true, "es6": true, "commonjs": true }, "plugins": ["react", "react-hooks", "prettier"], "extends": [ "eslint:recommended", "plugin:react/recommended", "plugin:react-hooks/recommended", "plugin:prettier/recommended", "plugin:@typescript-eslint/recommended" ], "settings": { "react": { "version": "18.2.0" }, "import/resolver": { "node": { "paths": ["./"] } } }, "ignorePatterns": ["temp.js", "node_modules"], "parser": "@typescript-eslint/parser", "parserOptions": { "ecmaVersion": 9, "sourceType": "module", "requireConfigFile": false, "plugins": ["@typescript-eslint"], "ecmaFeatures": { "jsx": true, "experimentalObjectRestSpread": true, "modules": true } }, "rules": { "linebreak-style": 0, "no-underscore-dangle": 0, "no-nested-ternary": 0, "prettier/prettier": "error", "react-hooks/exhaustive-deps": "warn", "react/react-in-jsx-scope": "off", "react-hooks/rules-of-hooks": "error", "react/jsx-uses-react": "off", "react/jsx-uses-vars": "error", "react/no-unescaped-entities": 0, "react/prefer-stateless-function": 1 }, "globals": { "grecaptcha": "readonly" } } ================================================ FILE: .gitignore ================================================ node_modules .cache npm-debug.log .DS_Store .cache .tmp *.log .parcel-cache dist ================================================ FILE: .npmignore ================================================ .DS_Store .babelrc .cache .parcel-cache .tmp *.log .gitignore node_modules npm-debug.log demo docs lib src ================================================ FILE: .parcelrc ================================================ { "extends": "@parcel/config-default", "transformers": { "*.{js,mjs,jsx,cjs,ts,tsx}": [ "@parcel/transformer-js", "@parcel/transformer-react-refresh-wrap" ] } } ================================================ FILE: .prettierrc ================================================ { "printWidth": 80, "trailingComma": "none", "singleQuote": true, "tabWidth": 2, "semi": false, "jsxSingleQuote": false, "quoteProps": "as-needed", "bracketSpacing": true, "jsxBracketSameLine": false } ================================================ FILE: LICENSE ================================================ ISC License Copyright 2021 Stephen Scaff Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ================================================ FILE: docs/src/App.js ================================================ import { React, useState, useEffect } from 'react' import AnimatedCursor from '../../lib' import DemoContent from './DemoContent' import DemoCustomTest from './DemoCustomTest' import DemoHeader from './DemoHeader' import DemoFooter from './DemoFooter' import './demo-styles.css' export default function App() { const [state, setState] = useState('donut') const searchParams = new URLSearchParams(document.location.search) const cursorParam = searchParams.get('cursor') useEffect(() => { if (cursorParam) setState(cursorParam) }, [cursorParam]) return (
{state === 'default' && } {state === 'donut' && ( )} {state === 'blendmode' && ( )} {state === 'custom' && ( )} {state === 'custom' && }
) } ================================================ FILE: docs/src/DemoContent.js ================================================ import React from 'react' const s = { section: { paddingTop: '6em', width: '80%', maxWidth: '36em', margin: '0 auto 1em' }, title: { marginBottom: '1em', fontSize: '3em', fontWeight: 800, textAlign: 'center', lineHeight: 1 }, pretitle: { textAlign: 'center' }, subtitle: { textAlign: 'center' }, sep: { border: 0, margin: '2em auto', height: 2, width: '3em', backgroundColor: 'rgba(255, 255, 255, 0.5)' } } export default function Content() { return (

Demos

React Animated Cursor

A component by Stephen Scaff

React animated cursor is a React component that creates a custom cursor experience. You can craft a variety of cursor types, and animate movement, hover and clicking properties.

Hover over these links and see how that animated cursor does it's thing. Kinda nifty, right? Not applicable to most projects, but a nice move for more interactive/immersive stuff... if you're into that kinda thing? Here's another link to nowhere.

Essentially, the cursor consists:

Style props exist for in the inner and outer cursor allow you to easily create unique cursor types. Play with css variables to influence the cursor, cursor outline size, and amount of scale on target hover.

Demo Cursors

Here's a few cursor types you can create to test

Test Clickables

Here's a collection of test clickable elements to hover over:

) } ================================================ FILE: docs/src/DemoCustomTest.js ================================================ import React from 'react' const s = { section: { paddingBottom: '6em', width: '80%', maxWidth: '36em', margin: '0 auto 1em' } } export default function Content() { return (

Test custom Clickables

Here's a collection of additional elements to test custom behaviors:

) } ================================================ FILE: docs/src/DemoFooter.js ================================================ import React from 'react' const s = { footer: { position: 'relative', width: '100%', padding: '6em 0 3em', backgroundColor: '#2f2c2c', textAlign: 'center' }, footer__grid: { position: 'relative', maxWidth: '95%', margin: '0 auto' }, footer__border: { height: '1px', width: '100%', marginBottom: '4em', border: '0', backgroundColor: 'rgba(255,255,255,0.4)' }, footer__copy: { fontSize: '0.8em' }, footer__icon: { width: '2em', margin: '0 auto', textAlign: 'center' }, footer__icon_vector: { fill: '#fff' } } export default function DemoHeader() { return (

A little thing by{' '} Stephen Scaff

) } ================================================ FILE: docs/src/DemoHeader.js ================================================ import React from 'react' const s = { header: { position: 'fixed', top: 0, left: 0, width: '100%', backgroundColor: '#2f2c2c' }, header__grid: { position: 'relative', display: 'flex', justifyContent: 'space-between', alignItems: 'center', width: '100%', height: '4em', maxWidth: '95%', margin: '0 auto' }, nav: { marginLeft: 'auto' }, nav__link: { marginLeft: '1em', fontSize: '0.8em', fontWeight: '400' }, brand: { display: 'flex', alignItems: 'center' }, brand__icon_inner: { position: 'relative', right: '-5px', display: 'block', height: '10px', width: '10px', borderRadius: '100%', backgroundColor: '#fff' }, brand__icon_outer: { position: 'relative', left: '-10px', top: '-8px', display: 'block', height: '6px', width: '6px', borderRadius: '100%', backgroundColor: 'rgba(255,255,255,0.4)' } } export default function DemoHeader() { return (
) } ================================================ FILE: docs/src/demo-styles.css ================================================ /* Cursor vars if you wanna use css over css in js */ :root { --cursor-color: #fff; } html, body { background-color: #2f2c2c; color: #fff; font-family: 'Inter', sans-serif; } /* Demo Content */ a { text-decoration: none; color: #fff; font-weight: 600; border-bottom: 1px solid rgba(255, 255, 255, 0.7); transition: 0.5s ease; } a:hover { color: rgba(255, 255, 255, 0.5); border-bottom-color: rgba(255, 255, 255, 0.1); } section { line-height: 1.7; font-weight: 300; } h3 { font-size: 1.3em; margin: 2em 0 1em; } ul { margin: 2em 0 1em; padding-left: 1em; } ul li { padding-bottom: 1.25em; padding-left: 0; } ================================================ FILE: docs/src/index.html ================================================ React Animated Cursor - by Stephen Scaff
================================================ FILE: docs/src/index.js ================================================ import React from 'react' import { createRoot } from 'react-dom/client' import App from './App' const container = document.getElementById('app') const root = createRoot(container) root.render() ================================================ FILE: lib/AnimatedCursor.tsx ================================================ import { useState, useEffect, useCallback, useRef, CSSProperties, useMemo } from 'react' import { useEventListener } from './hooks/useEventListener' import type { AnimatedCursorProps, AnimatedCursorCoordinates, AnimatedCursorOptions, Clickable } from './AnimatedCursor.types' import find from './helpers/find' import useIsTouchdevice from './hooks/useIsTouchdevice' /** * Cursor Core * Replaces the native cursor with a custom animated cursor, consisting * of an inner and outer dot that scale inversely based on hover or click. * * @author Stephen Scaff (github.com/stephenscaff) * * @param {object} obj * @param {array} obj.clickables - array of clickable selectors * @param {string} obj.children - element that is shown instead of the inner dot * @param {string} obj.color - rgb color value * @param {number} obj.innerScale - inner cursor scale amount * @param {number} obj.innerSize - inner cursor size in px * @param {object} obj.innerStyle - style object for inner cursor * @param {number} obj.outerAlpha - level of alpha transparency for color * @param {number} obj.outerScale - outer cursor scale amount * @param {number} obj.outerSize - outer cursor size in px * @param {object} obj.outerStyle - style object for outer cursor * @param {bool} obj.showSystemCursor - show/hide system cursor1 * @param {number} obj.trailingSpeed - speed the outer cursor trails at */ function CursorCore({ clickables = [ 'a', 'input[type="text"]', 'input[type="email"]', 'input[type="number"]', 'input[type="submit"]', 'input[type="image"]', 'label[for]', 'select', 'textarea', 'button', '.link' ], children, color = '220, 90, 90', innerScale = 0.6, innerSize = 8, innerStyle, outerAlpha = 0.4, outerScale = 6, outerSize = 8, outerStyle, showSystemCursor = false, trailingSpeed = 8 }: AnimatedCursorProps) { const defaultOptions = useMemo( () => ({ children, color, innerScale, innerSize, innerStyle, outerAlpha, outerScale, outerSize, outerStyle }), [ children, color, innerScale, innerSize, innerStyle, outerAlpha, outerScale, outerSize, outerStyle ] ) const cursorOuterRef = useRef(null) const cursorInnerRef = useRef(null) const requestRef = useRef(null) const previousTimeRef = useRef(null) const [coords, setCoords] = useState({ x: 0, y: 0 }) const [isVisible, setIsVisible] = useState(false) const [options, setOptions] = useState(defaultOptions) const [isActive, setIsActive] = useState( false ) const [isActiveClickable, setIsActiveClickable] = useState(false) const endX = useRef(0) const endY = useRef(0) /** * Primary Mouse move event * @param {number} clientX - MouseEvent.clientX * @param {number} clientY - MouseEvent.clientY */ const onMouseMove = useCallback((event: MouseEvent) => { const { clientX, clientY } = event setCoords({ x: clientX, y: clientY }) if (cursorInnerRef.current !== null) { cursorInnerRef.current.style.top = `${clientY}px` cursorInnerRef.current.style.left = `${clientX}px` } endX.current = clientX endY.current = clientY }, []) // Outer Cursor Animation Delay const animateOuterCursor = useCallback( (time: number) => { if (previousTimeRef.current !== undefined) { coords.x += (endX.current - coords.x) / trailingSpeed coords.y += (endY.current - coords.y) / trailingSpeed if (cursorOuterRef.current !== null) { cursorOuterRef.current.style.top = `${coords.y}px` cursorOuterRef.current.style.left = `${coords.x}px` } } previousTimeRef.current = time requestRef.current = requestAnimationFrame(animateOuterCursor) }, [requestRef] // eslint-disable-line ) // Outer cursor RAF setup / cleanup useEffect(() => { requestRef.current = requestAnimationFrame(animateOuterCursor) return () => { if (requestRef.current !== null) { cancelAnimationFrame(requestRef.current) } } }, [animateOuterCursor]) /** * Calculates amount to scale cursor in px3 * @param {number} orignalSize - starting size * @param {number} scaleAmount - Amount to scale * @returns {String} Scale amount in px */ const getScaleAmount = (orignalSize: number, scaleAmount: number) => { return `${parseInt(String(orignalSize * scaleAmount))}px` } // Scales cursor by HxW const scaleBySize = useCallback( ( cursorRef: HTMLDivElement | null, orignalSize: number, scaleAmount: number ) => { if (cursorRef) { cursorRef.style.height = getScaleAmount(orignalSize, scaleAmount) cursorRef.style.width = getScaleAmount(orignalSize, scaleAmount) } }, [] ) // Mouse Events State updates const onMouseDown = useCallback(() => setIsActive(true), []) const onMouseUp = useCallback(() => setIsActive(false), []) const onMouseEnterViewport = useCallback(() => setIsVisible(true), []) const onMouseLeaveViewport = useCallback(() => setIsVisible(false), []) useEventListener('mousemove', onMouseMove) useEventListener('mousedown', onMouseDown) useEventListener('mouseup', onMouseUp) useEventListener('mouseover', onMouseEnterViewport) useEventListener('mouseout', onMouseLeaveViewport) // Cursors Hover/Active State useEffect(() => { if (isActive) { scaleBySize(cursorInnerRef.current, options.innerSize, options.innerScale) scaleBySize(cursorOuterRef.current, options.outerSize, options.outerScale) } else { scaleBySize(cursorInnerRef.current, options.innerSize, 1) scaleBySize(cursorOuterRef.current, options.outerSize, 1) } }, [ options.innerSize, options.innerScale, options.outerSize, options.outerScale, scaleBySize, isActive ]) // Cursors Click States useEffect(() => { if (isActiveClickable) { scaleBySize( cursorInnerRef.current, options.innerSize, options.innerScale * 1.2 ) scaleBySize( cursorOuterRef.current, options.outerSize, options.outerScale * 1.4 ) } }, [ options.innerSize, options.innerScale, options.outerSize, options.outerScale, scaleBySize, isActiveClickable ]) // Cursor Visibility Statea useEffect(() => { if (cursorInnerRef.current == null || cursorOuterRef.current == null) return if (isVisible) { cursorInnerRef.current.style.opacity = '1' cursorOuterRef.current.style.opacity = '1' } else { cursorInnerRef.current.style.opacity = '0' cursorOuterRef.current.style.opacity = '0' } }, [isVisible]) // Click event state updates useEffect(() => { const clickableEls = document.querySelectorAll( clickables .map((clickable) => typeof clickable === 'object' && clickable?.target ? clickable.target : clickable ?? '' ) .join(',') ) clickableEls.forEach((el) => { if (!showSystemCursor) el.style.cursor = 'none' const clickableOptions = typeof clickables === 'object' ? find( clickables, (clickable: Clickable) => typeof clickable === 'object' && el.matches(clickable.target) ) : {} const options = { ...defaultOptions, ...clickableOptions } el.addEventListener('mouseover', () => { setIsActive(true) setOptions(options) }) el.addEventListener('click', () => { setIsActive(true) setIsActiveClickable(false) }) el.addEventListener('mousedown', () => { setIsActiveClickable(true) }) el.addEventListener('mouseup', () => { setIsActive(true) }) el.addEventListener('mouseout', () => { setIsActive(false) setIsActiveClickable(false) setOptions(defaultOptions) }) }) return () => { clickableEls.forEach((el) => { const clickableOptions = typeof clickables === 'object' ? find( clickables, (clickable: Clickable) => typeof clickable === 'object' && el.matches(clickable.target) ) : {} const options = { ...defaultOptions, ...clickableOptions } el.removeEventListener('mouseover', () => { setIsActive(true) setOptions(options) }) el.removeEventListener('click', () => { setIsActive(true) setIsActiveClickable(false) }) el.removeEventListener('mousedown', () => { setIsActiveClickable(true) }) el.removeEventListener('mouseup', () => { setIsActive(true) }) el.removeEventListener('mouseout', () => { setIsActive(false) setIsActiveClickable(false) setOptions(defaultOptions) }) }) } }, [isActive, clickables, showSystemCursor, defaultOptions]) useEffect(() => { if (typeof window === 'object' && !showSystemCursor) { document.body.style.cursor = 'none' } }, [showSystemCursor]) const coreStyles: CSSProperties = { zIndex: 999, display: 'flex', justifyContent: 'center', alignItems: 'center', position: 'fixed', borderRadius: '50%', pointerEvents: 'none', transform: 'translate(-50%, -50%)', transition: 'opacity 0.15s ease-in-out, height 0.2s ease-in-out, width 0.2s ease-in-out' } // Cursor Styles const styles = { cursorInner: { width: !options.children ? options.innerSize : 'auto', height: !options.children ? options.innerSize : 'auto', backgroundColor: !options.children ? `rgba(${options.color}, 1)` : 'transparent', ...coreStyles, ...(options.innerStyle && options.innerStyle) }, cursorOuter: { width: options.outerSize, height: options.outerSize, backgroundColor: `rgba(${options.color}, ${options.outerAlpha})`, ...coreStyles, ...(options.outerStyle && options.outerStyle) } } return ( <>
{options.children}
) } /** * AnimatedCursor * Calls and passes props to CursorCore if not a touch/mobile device. */ function AnimatedCursor({ children, clickables, color, innerScale, innerSize, innerStyle, outerAlpha, outerScale, outerSize, outerStyle, showSystemCursor, trailingSpeed }: AnimatedCursorProps) { const isTouchdevice = useIsTouchdevice() if (typeof window !== 'undefined' && isTouchdevice) { return <> } return ( {children} ) } export default AnimatedCursor ================================================ FILE: lib/AnimatedCursor.types.ts ================================================ import { CSSProperties, ReactNode } from 'react' export interface AnimatedCursorOptions { children?: ReactNode color?: string innerScale?: number innerSize?: number innerStyle?: CSSProperties outerAlpha?: number outerScale?: number outerSize?: number outerStyle?: CSSProperties } export type Clickable = string | ({ target: string } & AnimatedCursorOptions) export interface AnimatedCursorProps extends AnimatedCursorOptions { clickables?: Clickable[] showSystemCursor?: boolean trailingSpeed?: number } export interface AnimatedCursorCoordinates { x: number y: number } ================================================ FILE: lib/helpers/find.ts ================================================ export default function findInArray( arr: T[], callback: (element: T, index: number, array: T[]) => boolean, ...args ): T | undefined { if (typeof callback !== 'function') { throw new TypeError('callback must be a function') } const list = Object(arr) // Makes sure it always has a positive integer as length. const length = list.length >>> 0 const thisArg = args[2] for (let i = 0; i < length; i++) { const element = list[i] if (callback.call(thisArg, element, i, list)) { return element } } return undefined } ================================================ FILE: lib/hooks/useEventListener.ts ================================================ import { useEffect, useRef } from 'react' type AllEventMaps = HTMLElementEventMap & DocumentEventMap & WindowEventMap export function useEventListener( type: K, listener: (event: HTMLElementEventMap[K]) => void, element: HTMLElement ): void export function useEventListener( type: K, listener: (event: DocumentEventMap[K]) => void, element: Document ): void export function useEventListener( type: K, listener: (event: WindowEventMap[K]) => void, element?: Window ): void export function useEventListener( type: K, listener: (event: AllEventMaps[K]) => void, element?: HTMLElement | Document | Window | null ) { const listenerRef = useRef(listener) useEffect(() => { listenerRef.current = listener }) useEffect(() => { const el = element === undefined ? window : element const internalListener = (ev: AllEventMaps[K]) => { return listenerRef.current(ev) } el?.addEventListener( type, internalListener as EventListenerOrEventListenerObject ) return () => { el?.removeEventListener( type, internalListener as EventListenerOrEventListenerObject ) } }, [type, element]) } ================================================ FILE: lib/hooks/useIsTouchdevice.ts ================================================ import { useEffect, useState } from 'react' const useIsTouchdevice = (): boolean => { const [isTouchdevice, setIsTouchdevice] = useState() useEffect(() => { if (typeof window !== 'undefined') { setIsTouchdevice(window.matchMedia('(hover: none)').matches) } }, []) return isTouchdevice } export default useIsTouchdevice ================================================ FILE: lib/index.ts ================================================ import AnimatedCursor from './AnimatedCursor' export default AnimatedCursor ================================================ FILE: package.json ================================================ { "name": "react-animated-cursor", "version": "2.11.1", "description": "An animated custom cursor component in React.", "author": "Stephen Scaff ", "homepage": "https://stephenscaff.github.io/react-animated-cursor/", "main": "dist/index.js", "module": "dist/index.es.js", "types": "dist/index.d.ts", "browser": "dist/index.umd.js", "files": [ "dist/index.js", "dist/index.es.js", "dist/index.umd.js", "dist/index.d.ts" ], "targets": { "main": false, "module": false, "browser": false, "types": false }, "scripts": { "clean": "rm -rf ./dist", "build": "rollup -c", "dev": "parcel ./docs/src/index.html --dist-dir ./docs/dist", "demo:clean": "rm -rf ./docs/dist", "demo:start": "parcel ./docs/src/index.html --dist-dir ./docs/dist", "demo:build": "parcel build ./docs/src/index.html --dist-dir ./docs/dist --public-url ./", "demo:deploy": "npm run demo:build && gh-pages -d ./docs/dist", "prepare": "npm run build", "prepublish": "rm -rf ./dist && npm run build", "lint": "eslint \"lib/**/*.+(ts|tsx)\" --fix ", "format": "prettier --write \"lib/**/*.+(ts|tsx)\"" }, "keywords": [ "react cursor", "custom cursor", "animated cursor" ], "license": "ISC", "repository": { "type": "git", "url": "https://github.com/stephenscaff/react-animated-cursor" }, "bugs": { "url": "https://github.com/stephenscaff/react-animated-cursor/issues" }, "peerDependencies": { "react": "^18.2.0", "react-dom": "^18.2.0" }, "devDependencies": { "@rollup/plugin-commonjs": "^25.0.0", "@rollup/plugin-node-resolve": "^15.0.2", "@rollup/plugin-replace": "^5.0.2", "@rollup/plugin-typescript": "^11.1.1", "@types/react": "^18.2.6", "@types/react-dom": "^18.2.4", "@typescript-eslint/eslint-plugin": "^5.59.7", "@typescript-eslint/parser": "^5.36.2", "eslint": "^8.41.0", "eslint-config-prettier": "^8.8.0", "eslint-plugin-prettier": "^4.2.1", "eslint-plugin-react": "^7.32.2", "eslint-plugin-react-hooks": "^4.6.0", "gh-pages": "^5.0.0", "parcel": "^2.3.2", "prettier": "^2.0.5", "process": "^0.11.10", "react": "18.2.0", "react-dom": "18.2.0", "rollup": "^3.22.0", "rollup-plugin-dts": "^5.3.0", "rollup-plugin-peer-deps-external": "^2.2.2", "typescript": "^5.0.4" } } ================================================ FILE: readme.md ================================================ # React Animated Cursor A React component that replaces the native cursor with a custom animated [jawn](https://www.urbandictionary.com/define.php?term=Jawn). Available options and props allow you to easily craft a unique cursor experience. ## Contents 1. [📌 Features](#-features) 2. [🎯 Quickstart](#-quickstart) 3. [🤖 Commands](#-commands) 4. [🧬 Options](#-options) 5. [🕹️ Usage](#-usage) 6. [🎨 Cursor Types](#-cursor-types) 7. [📓 Notes](#-notes) 8. [📅 To Dos](#-to-dos)
## 📌 Features ### The custom cursor is comprised of - An inner dot (`cursorInner`) - An outer, outlining circle (`cursorOuter`), with slight opacity based on the dot/primary color - A slight trailing animation of the outer outline - An inversely scaling effect between the inner and outer cursor parts on click or link hover Options exist for modifying the color and scaling of the cursor elements (see props/options below). Style props for in the inner and outer cursor allow you to easily create unique cursor types. [Live Demo→](https://stephenscaff.github.io/react-animated-cursor/)
## 🎯 Quickstart ### Install package from npm `npm i react-animated-cursor` ### Add to you project Add to a global location, like `_app.js` ``` import React from "react"; import AnimatedCursor from "react-animated-cursor" export default function App() { return (
); } ```
## 🤖 Commands **Install** `npm i react-animated-cursor`
**Build**: `npm run build`
**Dev**: `npm run dev`
**Demo Run**: `npm run demo:start`
**Demo Build**: `npm run demo:build`
**Demo Clean**: `npm run demo:clean`
### Demo The demo is bundled with [`Parcel.js`](https://parceljs.org/) and served up at [http://localhost:1234/](http://localhost:1234/). ### Dist On build, `lib` populates `dist` with commonjs, es, umd versions of the component.
## 🕹️ Usage ``` import React from "react"; import AnimatedCursor from "react-animated-cursor" export default function App() { return (
); } ``` ### Example Usage - with options ``` import React from "react"; import AnimatedCursor from "react-animated-cursor" export default function App() { return (
); } ``` ### Example Usage - with simple options and custom config for one class ``` import React from "react"; import AnimatedCursor from "react-animated-cursor" export default function App() { return (
); } ``` ### Client Components, Next.js, SSR In previous versions of the component, integration with Next's SSR environment required using a `Dynamic Import`. However, as of version `2.10.1`, **you _should_ be good to go with a simple `import`.** Relevant updates: - Included module directive `'use client'` to indicate a client side component. - Updated `useEventListener` hook with `window` checks. - Wrapped the `document` use in a check. However, if you do run into any issues, you could try including with Dynamic Import. **Next's Dynamic Import** ``` 'use client'; // indicates Client Component // Import with next's dynamic import import dynamic from 'next/dynamic'; const AnimatedCursor = dynamic(() => import('react-animated-cursor'), { ssr: false, }); ```
## 🧬 Options | Option | Type | Description | Default | | ---- | ---- | -------- | -------| | `clickables` | array | Collection of selectors cursor that trigger cursor interaction or object with single target and possibly the rest of the options listed below | `['a', 'input[type="text"]', 'input[type="email"]', 'input[type="number"]', 'input[type="submit"]', 'input[type="image"]', 'label[for]', 'select', 'textarea', 'button', '.link']` | | `color` | string | rgb value | `220, 90, 90` | | `innerScale` | number | amount dot scales on click or link hover | `0.7` | | `innerSize` | number | Size (px) of inner cursor dot | `8` | | `innerStyle` | object | provides custom styles / css to inner cursor | `null` | | `outerAlpha` | number | amount of alpha transparency for outer cursor dot | `0.4` | | `outerScale` | number | amount outer dot scales on click or link hover | `5` | | `outerSize` | number | Size (px) of outer cursor outline | `8` | | `outerStyle` | object | provides custom styles / css to outer cursor | `null` | | `showSystemCursor` | boolean | Show system/brower cursor | `false` | | `trailingSpeed` | number | Outer dot's trailing speed | `8` |
## 🎨 Cursor Types You can use the `innerStyle` and `outerStyle` props to provide custom styles and create a variery of custom cursor types. Additionally, you can pass custom styles and css vars to create unique cursors or update style based on events. ### Dynamic Styles Use CSS variables with `innerStyle` and `outerStyle` props to create dynamic styles that you can easily update. For example, perhaps you have a light and dark mode experience and what your cursor to also adapt it's colors. **CSS Vars** ``` html { --cursor-color: #333 } html.dark-mode { --cursor-color: #fff } ``` **Pass CSS Var as Style Props** ``` ``` ### Donut Cursor A donut style cursor basically resembles a donut. You can easily create on by applying using the `outerStyle` props to apply an outer border ``` ``` [Donut Demo→](https://stephenscaff.github.io/react-animated-cursor?cursor=donut)
### Blend Mode Cursor You can use CSS mix-blend-mode with the style props to create an intersting cursor effect on hover that inverts the content's color. Works best with white / black cursors. ``` ``` [Blend Mode Demo→](https://stephenscaff.github.io/react-animated-cursor?cursor=blendmode)
## 📓 Notes ### Mobile / Touch `helpers/isDevice.js` uses UA sniffing to determine if on a common device so we can avoid rendering cursors. Yes... I know, there are other and probably better ways to handle this. Whatevers.
## 📅 To Dos - ~~Either remove on mobile, or provide touch events.~~ - ~~Separate click and hover scalings to provide a different scaling when clicking on links/clickables~~ - ~~Fix transform blur in Safari, which may mean migrating from `scale` to a `width` &`height` update~~ 4/4/23 - ~~Make clickables (cursor targets / selectors) a prop~~ - ~~Add PropType checks~~ - ~~Open cursor styles as props~~ - ~~Add ability to maintain system cursor for the squeamish~~ 4/4/23 - ~~Migrate to TS~~ - ~~Allow for different behavior based on the element hovered~~ - Options to control cursor transition speed and bezier - Solution for impacting state during route changes - Add some proper tests
Have fun ya'll. ================================================ FILE: rollup.config.mjs ================================================ import commonjs from '@rollup/plugin-commonjs' import external from 'rollup-plugin-peer-deps-external' import resolve from '@rollup/plugin-node-resolve' import typescript from '@rollup/plugin-typescript' import dts from 'rollup-plugin-dts' import pkg from './package.json' assert { type: 'json' } const umdGlobals = { react: 'React', 'react-animated-cursor': 'AnimatedCursor', 'react/jsx-runtime': 'jsxRuntime' } const config = [ { external: ['react', 'react-dom'], input: 'lib/index.ts', output: [ { file: pkg.main, format: 'cjs', banner: "'use client';" }, { file: pkg.module, format: 'esm', banner: "'use client';" }, { file: pkg.browser, format: 'umd', name: 'AnimatedCursor', globals: umdGlobals, banner: "'use client';" } ], plugins: [ external(), resolve(), commonjs(), typescript({ exclude: 'node_modules' }) ] }, { external: ['react', 'react-dom'], input: 'lib/index.ts', output: [{ file: pkg.types, format: 'es' }], plugins: [external(), resolve(), dts()] } ] export default config ================================================ FILE: tsconfig.json ================================================ { "compilerOptions": { "jsx": "react-jsx", "moduleResolution": "node", "target": "es5", "esModuleInterop": true, "allowSyntheticDefaultImports": true, "allowJs": true }, "include": ["lib"], "exclude": ["node_modules"] }