react-smokey-fluid-cursor 1.0.4 → 2.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Farasat Ali
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,183 +1,335 @@
-<h1 align="center">💨 React Smokey Fluid Cursor</h1>
-
 <p align="center">
-A beautiful, interactive fluid simulation that creates stunning visual effects following your cursor movements for your React and Next.js application on web. Built with WebGL for high-performance real-time fluid dynamics.
+  <img src="https://raw.githubusercontent.com/faraasat/react-smokey-fluid-cursor/main/.github/assets/banner.svg" alt="react-smokey-fluid-cursor" width="100%" />
 </p>
 
-![npm version](https://img.shields.io/npm/v/react-smokey-fluid-cursor.svg)
-![package size minified](https://img.shields.io/bundlephobia/min/react-smokey-fluid-cursor?style=plastic)
-[![Badge](https://data.jsdelivr.com/v1/package/npm/react-smokey-fluid-cursor/badge)](https://www.jsdelivr.com/package/npm/react-smokey-fluid-cursor)
-[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
+<p align="center">
+  A GPU-accelerated fluid-simulation cursor trail for React and Next.js — one component, no configuration required.
+</p>
 
-![total downloads](https://img.shields.io/npm/dt/react-smokey-fluid-cursor.svg)
-![total downloads per year](https://img.shields.io/npm/dy/react-smokey-fluid-cursor.svg)
-![total downloads per week](https://img.shields.io/npm/dw/react-smokey-fluid-cursor.svg)
-![total downloads per month](https://img.shields.io/npm/dm/react-smokey-fluid-cursor.svg)
-![download-image](https://img.shields.io/npm/dm/react-smokey-fluid-cursor.svg)
+<p align="center">
+  <a href="https://www.npmjs.com/package/react-smokey-fluid-cursor"><img alt="npm version" src="https://img.shields.io/npm/v/react-smokey-fluid-cursor?color=cb3837&label=npm&logo=npm"></a>
+  <a href="https://www.npmjs.com/package/react-smokey-fluid-cursor"><img alt="downloads" src="https://img.shields.io/npm/dm/react-smokey-fluid-cursor?color=cb3837&label=downloads"></a>
+  <a href="https://bundlephobia.com/package/react-smokey-fluid-cursor"><img alt="bundle size" src="https://img.shields.io/bundlephobia/minzip/react-smokey-fluid-cursor?label=minzipped"></a>
+  <a href="https://github.com/faraasat/react-smokey-fluid-cursor/actions/workflows/ci.yml"><img alt="CI" src="https://github.com/faraasat/react-smokey-fluid-cursor/actions/workflows/ci.yml/badge.svg"></a>
+  <img alt="types" src="https://img.shields.io/badge/types-included-3178c6?logo=typescript&logoColor=white">
+  <a href="https://github.com/faraasat/react-smokey-fluid-cursor/blob/main/LICENSE"><img alt="license" src="https://img.shields.io/npm/l/react-smokey-fluid-cursor?color=blue"></a>
+</p>
 
-[![react-smokey-fluid-cursor](https://nodei.co/npm/react-smokey-fluid-cursor.png)](https://npmjs.org/package/react-smokey-fluid-cursor)
+<p align="center">
+  <a href="https://faraasat.github.io/react-smokey-fluid-cursor/"><b>Live demo</b></a> ·
+  <a href="https://www.npmjs.com/package/react-smokey-fluid-cursor">npm</a> ·
+  <a href="https://github.com/faraasat/react-smokey-fluid-cursor/blob/main/CHANGELOG.md">Changelog</a> ·
+  <a href="https://github.com/faraasat/react-smokey-fluid-cursor/issues">Issues</a>
+</p>
 
 ---
 
-## 📦 Installation
+## Upgrading from 1.x
 
-```bash
-npm i react-smokey-fluid-cursor
+`2.0.0` adds scoped rendering, an imperative handle and live config updates.
+`<SmokeyFluidCursor />` keeps its props, but four behaviours differ.
 
-yarn add react-smokey-fluid-cursor
+| Change | Impact | What to do |
+| --- | --- | --- |
+| **The component renders `null`** when not `scoped` | The canvas is created and appended by the engine rather than returned from render, so it no longer appears where you placed the component | Nothing, unless you relied on its position in the DOM. Use `scoped` to keep it inside your own wrapper |
+| **Placement is applied inline**, not via an injected `<style>` | CSS you wrote against `#smokey-fluid-canvas` no longer wins | Use the `position`, `zIndex`, `pointerEvents` and `className` options, or add `!important` |
+| **Device pixel ratio is capped at 2** (`maxDpr`) | Slightly softer on 3x displays, markedly better frame rate and battery | `maxDpr: Infinity` restores the old behaviour |
+| **`prefers-reduced-motion` is honoured** | Visitors who asked for reduced motion get a still canvas | `respectReducedMotion: false` opts out |
 
-pnpm i react-smokey-fluid-cursor
+### The effect is invisible after upgrading?
 
-bun add react-smokey-fluid-cursor
+The canvas sits behind your content at `z-index: -9999`. If your page sets an
+opaque background on `<body>`, it paints over the effect — see
+[the section above](#the-effect-is-invisible-check-your-page-background). This
+applied to 1.x too, but the package now warns about it in development.
+
+### New, optional
+
+```tsx
+const fluid = useRef<FluidHandle>(null);
+
+<SmokeyFluidCursor ref={fluid} scoped config={{ palette: ["#ff4ecd"] }} />;
+fluid.current?.pause();
+fluid.current?.setConfig({ curl: 30 });
 ```
 
----
+## Why
 
-## 📸 Demo
+A real-time Navier–Stokes fluid solver running in WebGL, wired to your pointer
+and wrapped as a single React component. It cleans up after itself on unmount,
+survives React StrictMode's double-invoke, and degrades quietly on devices
+without WebGL instead of crashing your page.
 
-Checkout demo here: [Demo](https://react-smokey-fluid-cursor.vercel.app/)
+> Not using React? See
+> [`smokey-fluid-cursor`](https://github.com/faraasat/smokey-fluid-cursor).
 
-Also see more details in [Example](https://github.com/faraasat/react-smokey-fluid-cursor/tree/main/example):
+## Installation
 
-![Demo](https://github.com/faraasat/react-smokey-fluid-cursor/blob/main/images/demo.gif)
+```bash
+npm install react-smokey-fluid-cursor
+```
 
----
+<details>
+<summary>yarn / pnpm / bun</summary>
 
-## 🚀 Quick Start
+```bash
+yarn add react-smokey-fluid-cursor
+pnpm add react-smokey-fluid-cursor
+bun add react-smokey-fluid-cursor
+```
+</details>
 
-### **React (CRA)**
+**Peer dependencies:** `react >= 17`, `react-dom >= 17`.
 
-```tsx
-// src/App.tsx|jsx
-import React from "react";
+## Quick start
 
+```tsx
 import { SmokeyFluidCursor } from "react-smokey-fluid-cursor";
 
-function App() {
+export default function Layout({ children }) {
   return (
-    <div className="App">
-      {/* Place observer once globally */}
+    <>
       <SmokeyFluidCursor />
-    </div>
+      {children}
+    </>
   );
 }
 ```
 
-### **Vite + React**
+That is the whole integration. The component renders nothing itself — it
+creates a `fixed`, full-viewport canvas behind your content with
+`pointer-events: none`, and tears it down on unmount.
+
+> **Next.js App Router:** the package ships the `"use client"` directive, so it
+> can be imported straight into a server component.
+
+## Scope it to one section
+
+Pass `scoped` and an `absolute` position, and the effect stays inside the
+component's own wrapper instead of covering the page:
 
 ```tsx
-// src/main.tsx|jsx
-import React from "react";
+<SmokeyFluidCursor
+  scoped
+  style={{ height: 320, borderRadius: 16 }}
+  config={{ position: "absolute", zIndex: 0, palette: ["#4ea8ff", "#7c4dff"] }}
+>
+  <h2>Hover me</h2>
+</SmokeyFluidCursor>
+```
+
+When `scoped`, the wrapper gets `position: relative` and `overflow: hidden`
+automatically, so the fluid is clipped to it.
+
+## Controlling it
 
+Grab a ref for a live handle — pause, resume or retune without remounting:
+
+```tsx
+import { useRef } from "react";
 import { SmokeyFluidCursor } from "react-smokey-fluid-cursor";
+import type { FluidHandle } from "react-smokey-fluid-cursor";
+
+function Page() {
+  const fluid = useRef<FluidHandle>(null);
 
-function Main() {
   return (
     <>
-      <SmokeyFluidCursor />
+      <SmokeyFluidCursor ref={fluid} />
+      <button onClick={() => fluid.current?.pause()}>Pause</button>
+      <button onClick={() => fluid.current?.setConfig({ curl: 30 })}>Swirl</button>
     </>
   );
 }
-
-export default Main;
 ```
 
-### **Next.js Pages Router**
+| Method | Description |
+| --- | --- |
+| `pause()` / `resume()` | Freeze or restart the simulation. |
+| `isPaused()` | Current state. |
+| `setConfig(partial)` | Retune in place, no remount. |
+| `splat(x, y, color?)` | Inject a splash, in CSS pixels relative to the canvas. |
+| `dispose()` | Tear down early (the component already does this on unmount). |
+| `canvas` | The canvas being rendered into. |
 
-```tsx
-// pages/_app.tsx|jsx
-import type { AppProps } from "next/app";
+### The hook
 
-import { SmokeyFluidCursor } from "react-smokey-fluid-cursor";
+For full control over where the effect lives:
 
-function MyApp({ Component, pageProps }: AppProps) {
-  return (
-    <>
-      {/* Global ad observer */}
-      <SmokeyFluidCursor />
-      <Component {...pageProps} />
-    </>
-  );
+```tsx
+import { useSmokeyFluidCursor } from "react-smokey-fluid-cursor";
+
+function Hero() {
+  const ref = useRef<HTMLDivElement>(null);
+  useSmokeyFluidCursor({ position: "absolute" }, ref);
+  return <div ref={ref} style={{ position: "relative", height: 300 }} />;
 }
+```
+
+## Updating config
+
+Cheap options (`curl`, `splatForce`, `palette`, `colorIntensity`, dissipation,
+`paused`, `zIndex`, …) are pushed straight into the running simulation.
+
+Structural options (`id`, `position`, `simResolution`, `dyeResolution`) rebuild
+it, because they reallocate buffers or move DOM. Changing those every render
+would be expensive, so keep them stable.
+
+## The effect is invisible? Check your page background
+
+This is the single most common integration problem, and it looks like the
+package is broken when it is not.
 
-export default MyApp;
+The canvas defaults to `z-index: -9999` so it sits behind your content. Per the
+CSS painting order, a negatively-stacked element paints **above the root
+background but below the background of block-level descendants** — so this
+extremely common setup hides the effect completely:
+
+```css
+/* ✗ body's background paints straight over the canvas */
+body { background: #0b0f17; }
+```
+
+Put the page background on `<html>` instead:
+
+```css
+/* ✓ the canvas paints above the root background, below your content */
+html { background: #0b0f17; }
+body { background: transparent; }
 ```
 
-### **Next.js (App Router)**
+Alternatively, lift the canvas above your background and push your content
+above the canvas:
 
 ```tsx
-// app/layout.tsx|jsx
-import "./globals.css";
+initFluid({ zIndex: 0 });
+```
+```css
+main { position: relative; z-index: 1; }
+```
 
-import { SmokeyFluidCursor } from "react-smokey-fluid-cursor";
+In development the package detects this and warns in the console rather than
+leaving you with a blank screen.
 
-export default function RootLayout({
-  children,
-}: {
-  children: React.ReactNode;
-}) {
-  return (
-    <html lang="en">
-      <body>
-        <SmokeyFluidCursor />
-        {children}
-      </body>
-    </html>
-  );
-}
+## Configuration
+
+Every option is optional.
+
+### Mounting & placement
+
+| Option | Type | Default | Description |
+| --- | --- | --- | --- |
+| `container` | `HTMLElement \| string` | `document.body` | Where to create the canvas. Set automatically when `scoped`. |
+| `canvas` | `HTMLCanvasElement \| string` | — | Render into an existing canvas instead. |
+| `id` | `string` | `"smokey-fluid-canvas"` | Id assigned to the canvas. |
+| `position` | `"fixed" \| "absolute" \| "relative" \| "static"` | `"fixed"` | `absolute` confines the effect to its container. |
+| `zIndex` | `number` | `-9999` | Stacking order. |
+| `pointerEvents` | `boolean` | `false` | Whether the canvas swallows clicks. |
+| `className` | `string` | — | Extra class on the canvas. |
+
+### Performance & accessibility
+
+| Option | Type | Default | Description |
+| --- | --- | --- | --- |
+| `maxDpr` | `number` | `2` | Caps the device pixel ratio. Uncapped, a 3x phone renders **nine times** the pixels of a 1x display. |
+| `pauseOnHidden` | `boolean` | `true` | Stop the loop while the tab is backgrounded. |
+| `respectReducedMotion` | `boolean` | `true` | Start paused for `prefers-reduced-motion: reduce`. |
+| `paused` | `boolean` | `false` | Start frozen. |
+
+### Appearance
+
+| Option | Type | Default | Description |
+| --- | --- | --- | --- |
+| `palette` | `string[]` | `null` | Hex colours to draw from, e.g. `["#ff4ecd"]`. Omit for random hues. |
+| `colorIntensity` | `number` | `0.15` | Brightness multiplier. |
+| `backColor` | `{ r, g, b }` | `{ r: 0, g: 0, b: 0 }` | Canvas background. |
+| `transparent` | `boolean` | `true` | Blend with the page background. |
+| `shading` | `boolean` | `true` | Lighting, for depth. |
+| `colorUpdateSpeed` | `number` | `10` | How fast the palette rotates. |
+
+### Simulation
+
+| Option | Type | Default | Description |
+| --- | --- | --- | --- |
+| `simResolution` | `number` | `128` | Velocity/pressure grid. |
+| `dyeResolution` | `number` | `1440` | Colour buffer resolution — the main quality/cost dial. |
+| `densityDissipation` | `number` | `3.5` | How fast colour fades. |
+| `velocityDissipation` | `number` | `2` | How fast motion slows. |
+| `pressure` | `number` | `0.1` | Initial pressure multiplier. |
+| `pressureIteration` | `number` | `20` | Jacobi iterations. |
+| `curl` | `number` | `10` | Vorticity confinement — the swirliness. |
+| `splatRadius` | `number` | `0.5` | Size of each splat. |
+| `splatForce` | `number` | `6000` | Force per splat. |
+
+## Lifecycle
+
+On unmount the component stops the render loop, detaches its window listeners,
+releases the WebGL context and removes the canvas it created. Mounting and
+unmounting repeatedly — including StrictMode's development double-invoke —
+does not stack simulations.
+
+## Performance
+
+The big levers, in order of impact:
+
+1. **`maxDpr`** — already capped at `2`. Drop to `1` for the weakest devices.
+2. **`dyeResolution`** — `512` is much cheaper and still looks good.
+3. **`pressureIteration`** — `10` roughly halves the solver cost.
+
+```tsx
+<SmokeyFluidCursor config={{ maxDpr: 1, dyeResolution: 512, pressureIteration: 10 }} />
 ```
 
----
+## Accessibility
 
-## ⚙️ Configuration Options
-
-Customize the fluid simulation with these configuration options:
-
-| Property              | Default Value                 | Description                                    |
-| --------------------- | ----------------------------- | ---------------------------------------------- |
-| `id`                  | `"react-smokey-fluid-cursor"` | Canvas element ID                              |
-| `simResolution`       | `128`                         | Simulation resolution (higher = more detailed) |
-| `dyeResolution`       | `512`                         | Dye/color resolution                           |
-| `densityDissipation`  | `0.98`                        | How quickly colors fade (0–1)                  |
-| `velocityDissipation` | `0.98`                        | How quickly movement slows down                |
-| `pressureIteration`   | `10`                          | Pressure solver iterations                     |
-| `curl`                | `30`                          | Vorticity/swirl intensity                      |
-| `splatRadius`         | `0.25`                        | Size of cursor splats                          |
-| `splatForce`          | `6000`                        | Force of cursor movements                      |
-| `shading`             | `true`                        | Enable 3D lighting effects                     |
-| `colorUpdateSpeed`    | `0.5`                         | Speed of color transitions                     |
-| `transparent`         | `false`                       | Transparent background                         |
+A full-screen animation is a real problem for people with vestibular
+disorders. By default this honours `prefers-reduced-motion: reduce` by starting
+paused, and reacts if the preference changes while the page is open.
 
----
+## Browser support
 
-## 🌟 Features
+Requires WebGL (WebGL 2 when available, WebGL 1 fallback). Without it the
+component logs a warning and renders nothing — it never throws, so a decorative
+effect cannot take down your app.
 
-- **Real-time Fluid Dynamics**: Physics-based simulation using Navier-Stokes equations
-- **WebGL Accelerated**: High-performance rendering for smooth 60fps
-- **Interactive**: Responds to mouse and touch movements
-- **Customizable**: Extensive configuration options
-- **Mobile Support**: Touch-optimized interactions
-- **Auto-scaling**: Adapts to screen size and pixel ratio
-- **Color Cycling**: Dynamic, evolving color palettes
-- **3D Lighting**: Optional shading for depth perception
+## Contributing
 
----
+Issues and pull requests are welcome.
 
-## 🎯 Use Cases
+```bash
+git clone https://github.com/faraasat/react-smokey-fluid-cursor.git
+cd react-smokey-fluid-cursor
+npm install
+npm test          # vitest unit tests
+npm run typecheck # tsc --noEmit
+npm run build     # tsup
+```
 
-- **Website Backgrounds**: Immersive animated backgrounds
-- **Cursor Effects**: Enhanced user interaction feedback
-- **Data Visualization**: Fluid-based data representations
-- **Art Installations**: Digital art and creative coding
-- **Game Effects**: Atmospheric and UI effects
-- **Product Demos**: Eye-catching technology showcases
+End-to-end tests run against the built demo in a real browser (desktop and
+mobile viewports), and cover the things unit tests cannot: layout, CSS and
+keyboard behaviour.
 
----
+```bash
+npm run build && npm --prefix example install && npm --prefix example run build
+npm run test:e2e      # playwright
+npm run test:e2e:ui   # interactive
+```
+
+To run the demo site against your local build:
+
+```bash
+npm run example:dev
+```
+
+Releases are manual — nothing publishes on a push to `main`. Maintainers run
+the **Release** workflow from the Actions tab.
+
+## Privacy
 
-## 🧑‍💻 Author
+The published package contains **no telemetry**. The demo site at
+[faraasat.github.io/react-smokey-fluid-cursor](https://faraasat.github.io/react-smokey-fluid-cursor/) uses
+Google Analytics and Aptabase; the library itself never phones home.
 
-Built and maintained by [**Farasat Ali**](https://www.farasat.me)
+## License
 
-- Website: [www.farasat.me](https://www.farasat.me)
-- LinkedIn: [linkedin.com/in/faraasat](https://linkedin.com/in/faraasat)
-- GitHub: [github.com/faraasat](https://github.com/faraasat)
+[MIT](./LICENSE) © [Farasat Ali](https://github.com/faraasat)