docs/index.html
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>React Mouse Trail</title><meta name="description" content="Documentation for React Mouse Trail"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">React Mouse Trail</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h2>React Mouse Trail</h2></div><div class="tsd-panel tsd-typography"><a id="md:react-webgl-trails-" class="tsd-anchor"></a><h1 class="tsd-anchor-link">React WebGL Trails <img src="https://github.com/react18-tools/react-mouse-trail/blob/main/popper.png?raw=true" style="height: 40px"/><a href="#md:react-webgl-trails-" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1><p><a href="https://github.com/react18-tools/react-mouse-trail/actions/workflows/test.yml" target="_blank" class="external"><img src="https://github.com/react18-tools/react-mouse-trail/actions/workflows/test.yml/badge.svg" alt="test"></a> <a href="https://codeclimate.com/github/react18-tools/react-mouse-trail/maintainability" target="_blank" class="external"><img src="https://api.codeclimate.com/v1/badges/4bb3a3316ff4ecd2a9eb/maintainability" alt="Maintainability"></a> <a href="https://codecov.io/gh/react18-tools/react-mouse-trail" target="_blank" class="external"><img src="https://codecov.io/gh/react18-tools/react-mouse-trail/graph/badge.svg" alt="codecov"></a> <a href="https://www.npmjs.com/package/react-mouse-trails" target="_blank" class="external"><img src="https://img.shields.io/npm/v/react-mouse-trails.svg?colorB=green" alt="Version"></a> <a href="https://www.npmjs.com/package/react-mouse-trails" target="_blank" class="external"><img src="https://img.jsdelivr.com/img.shields.io/npm/d18m/react-mouse-trails.svg" alt="Downloads"></a> <img src="https://img.shields.io/bundlephobia/minzip/react-mouse-trails" alt="npm bundle size"> <a href="https://gitpod.io/from-referrer/" target="_blank" class="external"><img src="https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod" alt="Gitpod ready-to-code"></a></p>
<p>A lightweight WebGL-based React component for creating an interactive mouse trail effect. Works with Next.js out of the box.</p>
<p>✅ Fully TypeScript</p>
<p>✅ Leverages the power of React 18 Server components</p>
<p>✅ Compatible with all React build systems/tools/frameworks</p>
<p>✅ Documented with <a href="https://react18-tools.github.io/react-mouse-trail" target="_blank" class="external">Typedoc</a> (<a href="https://react18-tools.github.io/react-mouse-trail" target="_blank" class="external">Docs</a>)</p>
<p>✅ Examples for Next.js, Vite</p>
<blockquote>
<p><img src="https://github.com/react18-tools/react-mouse-trail/blob/main/popper.png?raw=true" style="height: 20px"/> Please consider starring <a href="https://github.com/react18-tools/react-mouse-trail" target="_blank" class="external">this repository</a> and sharing it with your friends.</p>
</blockquote>
<a id="md:getting-started" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Getting Started<a href="#md:getting-started" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><a id="md:installation" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Installation<a href="#md:installation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="bash"><span class="hl-0">$</span><span class="hl-1"> </span><span class="hl-2">pnpm</span><span class="hl-1"> </span><span class="hl-2">add</span><span class="hl-1"> </span><span class="hl-2">react-webgl-trails</span>
</code><button type="button">Copy</button></pre>
<p><strong><em>or</em></strong></p>
<pre><code class="bash"><span class="hl-0">$</span><span class="hl-1"> </span><span class="hl-2">npm</span><span class="hl-1"> </span><span class="hl-2">install</span><span class="hl-1"> </span><span class="hl-2">react-webgl-trails</span>
</code><button type="button">Copy</button></pre>
<p><strong><em>or</em></strong></p>
<pre><code class="bash"><span class="hl-0">$</span><span class="hl-1"> </span><span class="hl-2">yarn</span><span class="hl-1"> </span><span class="hl-2">add</span><span class="hl-1"> </span><span class="hl-2">react-webgl-trails</span>
</code><button type="button">Copy</button></pre>
<a id="md:usage" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Usage<a href="#md:usage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>MouseTrail is simple to integrate:</p>
<pre><code class="tsx"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">MouseTrail</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">"react-mouse-trail"</span><span class="hl-1">;</span><br/><br/><span class="hl-3">export</span><span class="hl-1"> </span><span class="hl-3">default</span><span class="hl-1"> </span><span class="hl-5">function</span><span class="hl-1"> </span><span class="hl-0">Layout</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-3">return</span><span class="hl-1"> (</span><br/><span class="hl-1"> </span><span class="hl-6"><</span><span class="hl-7">html</span><span class="hl-1"> </span><span class="hl-8">lang</span><span class="hl-1">=</span><span class="hl-2">"en"</span><span class="hl-1"> </span><span class="hl-8">suppressHydrationWarning</span><span class="hl-6">></span><br/><span class="hl-1"> </span><span class="hl-6"><</span><span class="hl-7">body</span><span class="hl-1"> </span><span class="hl-8">className</span><span class="hl-1">=</span><span class="hl-5">{</span><span class="hl-4">inter</span><span class="hl-9">.</span><span class="hl-4">className</span><span class="hl-5">}</span><span class="hl-6">></span><br/><span class="hl-1"> </span><span class="hl-5">{</span><span class="hl-10">/* ... */</span><span class="hl-5">}</span><br/><span class="hl-1"> </span><span class="hl-6"><</span><span class="hl-11">MouseTrail</span><span class="hl-1"> </span><span class="hl-8">rgb</span><span class="hl-1">=</span><span class="hl-5">{</span><span class="hl-9">[</span><span class="hl-12">1</span><span class="hl-9">, </span><span class="hl-12">0</span><span class="hl-9">, </span><span class="hl-12">0</span><span class="hl-9">]</span><span class="hl-5">}</span><span class="hl-1"> </span><span class="hl-6">/></span><br/><span class="hl-1"> </span><span class="hl-6"></</span><span class="hl-7">body</span><span class="hl-6">></span><br/><span class="hl-1"> </span><span class="hl-6"></</span><span class="hl-7">html</span><span class="hl-6">></span><br/><span class="hl-1"> );</span><br/><span class="hl-1">}</span>
</code><button type="button">Copy</button></pre>
<p>By default, the RGB value <code>[1, 0, 0]</code> represents the color red.</p>
<p><img src="https://repobeats.axiom.co/api/embed/016960ad97aa7b1abbdd9a615f5ffeb08d869cb6.svg" alt="Repobeats" title="Repobeats analytics image"></p>
<a id="md:license" class="tsd-anchor"></a><h2 class="tsd-anchor-link">License<a href="#md:license" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>This library is licensed under the MPL-2.0 open-source license.</p>
<blockquote>
<p><img src="https://github.com/react18-tools/react-mouse-trail/blob/main/popper.png?raw=true" style="height: 20px"/> Please consider enrolling in <a href="https://mayank-chaudhari.vercel.app/courses" target="_blank" class="external">our courses</a> or <a href="https://github.com/sponsors/mayank1513" target="_blank" class="external">sponsoring</a> our work.</p>
</blockquote>
<hr />
<p align="center" style="text-align:center">with 💖 by <a href="https://mayank-chaudhari.vercel.app" target="_blank">Mayank Kumar Chaudhari</a></p></div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#md:react-webgl-trails-"><span>React <wbr/>WebGL <wbr/>Trails <img src="https://github.com/react18-<wbr/>tools/react-<wbr/>mouse-<wbr/>trail/blob/main/popper.png?raw=true" style="height: 40px"/></span></a><ul><li><a href="#md:getting-started"><span>Getting <wbr/>Started</span></a></li><li><ul><li><a href="#md:installation"><span>Installation</span></a></li></ul></li><li><a href="#md:usage"><span>Usage</span></a></li><li><a href="#md:license"><span>License</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="index.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg><span>React Mouse Trail</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>