{"_id":"@ar-dacity/ardacity-splash-cursor","_rev":"3-544cdf29d7603537b3835bd0967948bb","name":"@ar-dacity/ardacity-splash-cursor","dist-tags":{"latest":"1.0.2"},"versions":{"1.0.0":{"name":"@ar-dacity/ardacity-splash-cursor","version":"1.0.0","keywords":["react","ui","components","animation","cursor","fluid","webgl","shader"],"author":{"name":"ArDacity"},"license":"MIT","_id":"@ar-dacity/ardacity-splash-cursor@1.0.0","maintainers":[{"name":"ruffledzest","email":"vibhanshalok@gmail.com"}],"dist":{"shasum":"9fb26aa53ada02c3d73e299a86b51bfc9b14eee6","tarball":"https://registry.npmjs.org/@ar-dacity/ardacity-splash-cursor/-/ardacity-splash-cursor-1.0.0.tgz","fileCount":6,"integrity":"sha512-CnIwzEkPr2h0KpbJESFUClD888ryltlyWWIuDkX4XgnYok6BQ74NrUPhI1G23X0Bsq5EA4F9FfjgW7C4/P8VwQ==","signatures":[{"sig":"MEUCIQDniejS72Sa0I6SzPXQieigJZebbbqPtuYNLarJVipY3QIgWqFdJgf4/+xfrjzXJetbbdvnXPtTSVYhNqwcqE4qq/0=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":38998},"main":"dist/index.js","types":"dist/index.d.ts","gitHead":"941eefed13b8107ea83f3b7ddd9b14cb1b6bb2a9","scripts":{"build":"tsc","postinstall":"node ./scripts/install.js","prepublishOnly":"npm run build"},"_npmUser":{"name":"ruffledzest","email":"vibhanshalok@gmail.com"},"_npmVersion":"10.8.1","description":"Interactive fluid simulation cursor effects for React applications","directories":{},"_nodeVersion":"20.12.1","_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.3.3","@types/node":"^20.10.5","@types/react":"^18.2.45"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"_npmOperationalInternal":{"tmp":"tmp/ardacity-splash-cursor_1.0.0_1745464363453_0.176337649775967","host":"s3://npm-registry-packages-npm-production"}},"1.0.1":{"name":"@ar-dacity/ardacity-splash-cursor","version":"1.0.1","keywords":["react","ui","components","animation","cursor","fluid","webgl","shader"],"author":{"name":"ArDacity"},"license":"MIT","_id":"@ar-dacity/ardacity-splash-cursor@1.0.1","maintainers":[{"name":"ruffledzest","email":"vibhanshalok@gmail.com"}],"dist":{"shasum":"a636b1cecefd51cfa0c1cb421fde1192611f4cd0","tarball":"https://registry.npmjs.org/@ar-dacity/ardacity-splash-cursor/-/ardacity-splash-cursor-1.0.1.tgz","fileCount":7,"integrity":"sha512-/Z7ogvxWfjri7xcbhoaz+W6ruJIKO7WoPyj3g9yPdrxolYW8v00liGv0cs2LcwSR+AUYpN2YVq2Hl6hM8CbpEQ==","signatures":[{"sig":"MEYCIQC1bzPWTVU6bbF8fTcMpL+P3P8eEgd5fhYvjLWk+MuPaQIhAJYi7ccgNx73CzPuadgv/3VMwr0aVoV7X64VpjydhniB","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":39388},"main":"dist/index.js","types":"dist/index.d.ts","gitHead":"941eefed13b8107ea83f3b7ddd9b14cb1b6bb2a9","scripts":{"build":"tsc","postinstall":"node ./scripts/install.js","prepublishOnly":"npm run build"},"_npmUser":{"name":"ruffledzest","email":"vibhanshalok@gmail.com"},"_npmVersion":"10.8.1","description":"Interactive fluid simulation cursor effects for React applications","directories":{},"_nodeVersion":"20.12.1","_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.3.3","@types/node":"^20.10.5","@types/react":"^18.2.45"},"peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"_npmOperationalInternal":{"tmp":"tmp/ardacity-splash-cursor_1.0.1_1745465312100_0.6626887008568751","host":"s3://npm-registry-packages-npm-production"}},"1.0.2":{"name":"@ar-dacity/ardacity-splash-cursor","version":"1.0.2","description":"Interactive fluid simulation cursor effects for React applications","main":"dist/index.js","types":"dist/index.d.ts","scripts":{"build":"tsc","prepublishOnly":"npm run build","postinstall":"node ./scripts/install.js"},"keywords":["react","ui","components","animation","cursor","fluid","webgl","shader"],"author":{"name":"ArDacity"},"license":"MIT","peerDependencies":{"react":">=16.8.0","react-dom":">=16.8.0"},"devDependencies":{"@types/node":"^20.10.5","@types/react":"^18.2.45","typescript":"^5.3.3"},"_id":"@ar-dacity/ardacity-splash-cursor@1.0.2","gitHead":"5cddd9430e62325a1aef7db7c665b66267f8716f","_nodeVersion":"20.12.1","_npmVersion":"10.8.1","dist":{"integrity":"sha512-ixy/UVEYwWbwpRdmp1J/H0SngvUEX+ZfJt0+ZFC4/26cdUyHImmTD2TBwhJ5yKGotzX4ajN46mXHwSeoe2GHug==","shasum":"b5f580f139ad35213e314508250df0ad81f08b72","tarball":"https://registry.npmjs.org/@ar-dacity/ardacity-splash-cursor/-/ardacity-splash-cursor-1.0.2.tgz","fileCount":7,"unpackedSize":44590,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQDNjBrbVI/J/CCycvC4UO7hfS5fh2oc1zBJJdBUixbptwIgYrFXfJRdMsuEmSQwUct2Zg8wnQFjYWVLChq0bpDkcHg="}]},"_npmUser":{"name":"ruffledzest","email":"vibhanshalok@gmail.com"},"directories":{},"maintainers":[{"name":"ruffledzest","email":"vibhanshalok@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/ardacity-splash-cursor_1.0.2_1745466619604_0.7351387946796248"},"_hasShrinkwrap":false}},"time":{"created":"2025-04-24T03:12:43.363Z","modified":"2025-04-24T03:50:19.973Z","1.0.0":"2025-04-24T03:12:43.679Z","1.0.1":"2025-04-24T03:28:32.324Z","1.0.2":"2025-04-24T03:50:19.774Z"},"author":{"name":"ArDacity"},"license":"MIT","keywords":["react","ui","components","animation","cursor","fluid","webgl","shader"],"description":"Interactive fluid simulation cursor effects for React applications","maintainers":[{"name":"ruffledzest","email":"vibhanshalok@gmail.com"}],"readme":"# ArDacity Splash Cursor\r\n\r\nA React component that creates beautiful fluid simulation cursor effects that follow the user's pointer movements, creating a splash-like visual effect. Based on WebGL shaders for high-performance animations.\r\n\r\n## Installation\r\n\r\n```bash\r\nnpm install @ar-dacity/ardacity-splash-cursor\r\n```\r\n\r\nor\r\n\r\n```bash\r\nyarn add @ar-dacity/ardacity-splash-cursor\r\n```\r\n\r\n## What Happens During Installation\r\n\r\nWhen you install this package, it automatically:\r\n\r\n1. Detects your project structure\r\n2. Copies the SplashCursor component file into your components directory\r\n3. Adapts to React or Next.js projects\r\n4. Supports TypeScript by using the appropriate file extension (.tsx)\r\n\r\n## Usage\r\n\r\nAfter installation, you can import the component directly from your components directory:\r\n\r\n```jsx\r\nimport SplashCursor from './components/SplashCursor';\r\n\r\nfunction App() {\r\n  return (\r\n    <div>\r\n      <h1>My Awesome Website</h1>\r\n      {/* Add the SplashCursor component to enable the effect */}\r\n      <SplashCursor />\r\n    </div>\r\n  );\r\n}\r\n```\r\n\r\n## Component Props\r\n\r\n| Property | Type | Default | Description |\r\n|----------|------|---------|-------------|\r\n| SIM_RESOLUTION | number | 128 | Simulation resolution for the fluid dynamics. Higher values increase quality but reduce performance. |\r\n| DYE_RESOLUTION | number | 1440 | Resolution of the color/dye field. Higher values create more detailed color effects. |\r\n| DENSITY_DISSIPATION | number | 3.5 | How quickly the color dissipates. Lower values make colors last longer. |\r\n| VELOCITY_DISSIPATION | number | 2 | How quickly the motion dissipates. Lower values create longer-lasting movement. |\r\n| PRESSURE | number | 0.1 | Fluid pressure parameter that affects how the simulation behaves. |\r\n| PRESSURE_ITERATIONS | number | 20 | More iterations create more accurate fluid simulation at the cost of performance. |\r\n| CURL | number | 3 | Controls the amount of vorticity/swirl in the fluid. |\r\n| SPLAT_RADIUS | number | 0.2 | Size of the splash effect when cursor moves. |\r\n| SPLAT_FORCE | number | 6000 | Strength of the force applied to the fluid when cursor moves. |\r\n| SHADING | boolean | true | Enables 3D-like shading effect on the fluid. |\r\n| COLOR_UPDATE_SPEED | number | 10 | How quickly the colors change. |\r\n| BACK_COLOR | object | { r: 0.5, g: 0, b: 0 } | The background/base color for the fluid effect (RGB values between 0-1). |\r\n| TRANSPARENT | boolean | true | Whether the background should be transparent. |\r\n\r\n## Customization Examples\r\n\r\nYou can customize the fluid simulation by adjusting the props:\r\n\r\n```jsx\r\n<SplashCursor \r\n  SPLAT_RADIUS={0.3}\r\n  SPLAT_FORCE={8000}\r\n  CURL={5}\r\n  BACK_COLOR={{ r: 0, g: 0.3, b: 0.5 }}\r\n/>\r\n```\r\n\r\n## Performance Considerations\r\n\r\nFor optimal performance:\r\n\r\n- Lower the SIM_RESOLUTION and DYE_RESOLUTION on lower-end devices\r\n- Disable SHADING if performance is an issue\r\n- Consider reducing PRESSURE_ITERATIONS for better performance\r\n\r\n## Browser Compatibility\r\n\r\nThe SplashCursor component is compatible with all modern browsers that support WebGL.\r\n\r\n## License\r\n\r\nMIT ","readmeFilename":"README.md"}