docs/functions/react_particles_particles.Particles.html
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Particles | Webgl Generative Particles</title><meta name="description" content="Documentation for Webgl Generative Particles"/><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">Webgl Generative Particles</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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Webgl Generative Particles</a></li><li><a href="../modules/react_particles_particles.html">react/particles/particles</a></li><li><a href="react_particles_particles.Particles.html">Particles</a></li></ul><h1>Function Particles</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="tsx"><span class="hl-10"><</span><span class="hl-8">Particles</span><span class="hl-1"> </span><span class="hl-10">/></span>
</code><button type="button">Copy</button></pre>
</div><div class="tsd-tag-Source"><h4 class="tsd-anchor-link"><a id="Source" class="tsd-anchor"></a>Source<a href="#Source" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><ul>
<li>Source code</li>
</ul>
<pre><code class="ts"><span class="hl-3">export</span><span class="hl-1"> </span><span class="hl-7">const</span><span class="hl-1"> </span><span class="hl-0">Particles</span><span class="hl-1"> = ({ </span><span class="hl-4">options</span><span class="hl-1">, </span><span class="hl-4">overlay</span><span class="hl-1">, </span><span class="hl-4">fullScreenOverlay</span><span class="hl-1">, ...</span><span class="hl-4">props</span><span class="hl-1"> }: </span><span class="hl-8">ParticlesProps</span><span class="hl-1">) </span><span class="hl-7">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-7">const</span><span class="hl-1"> </span><span class="hl-11">canvasRef</span><span class="hl-1"> = </span><span class="hl-0">useRef</span><span class="hl-1"><</span><span class="hl-8">HTMLCanvasElement</span><span class="hl-1">>(</span><span class="hl-7">null</span><span class="hl-1">);</span><br/><br/><span class="hl-1"> </span><span class="hl-7">const</span><span class="hl-1"> </span><span class="hl-11">fsStyles</span><span class="hl-1"> = </span><span class="hl-4">fullScreenOverlay</span><br/><span class="hl-1"> ? { </span><span class="hl-4">position:</span><span class="hl-1"> </span><span class="hl-2">"fixed"</span><span class="hl-1">, </span><span class="hl-4">top:</span><span class="hl-1"> </span><span class="hl-6">0</span><span class="hl-1">, </span><span class="hl-4">left:</span><span class="hl-1"> </span><span class="hl-6">0</span><span class="hl-1">, </span><span class="hl-4">width:</span><span class="hl-1"> </span><span class="hl-2">"100vw"</span><span class="hl-1">, </span><span class="hl-4">height:</span><span class="hl-1"> </span><span class="hl-2">"100vh"</span><span class="hl-1"> }</span><br/><span class="hl-1"> : {};</span><br/><br/><span class="hl-1"> </span><span class="hl-7">const</span><span class="hl-1"> </span><span class="hl-11">resolvedOverlay</span><span class="hl-1"> = </span><span class="hl-4">overlay</span><span class="hl-1"> || </span><span class="hl-4">fullScreenOverlay</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-7">const</span><span class="hl-1"> </span><span class="hl-0">style</span><span class="hl-1"> = (</span><br/><span class="hl-1"> </span><span class="hl-4">resolvedOverlay</span><span class="hl-1"> ? { </span><span class="hl-4">pointerEvents:</span><span class="hl-1"> </span><span class="hl-2">"none"</span><span class="hl-1">, ...</span><span class="hl-4">fsStyles</span><span class="hl-1">, ...</span><span class="hl-4">props</span><span class="hl-1">.</span><span class="hl-4">style</span><span class="hl-1"> } : </span><span class="hl-4">props</span><span class="hl-1">.</span><span class="hl-4">style</span><br/><span class="hl-1"> ) </span><span class="hl-3">as</span><span class="hl-1"> </span><span class="hl-8">CSSProperties</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-0">useEffect</span><span class="hl-1">(</span><br/><span class="hl-1"> () </span><span class="hl-7">=></span><br/><span class="hl-1"> </span><span class="hl-4">canvasRef</span><span class="hl-1">.</span><span class="hl-4">current</span><br/><span class="hl-1"> ? </span><span class="hl-0">renderParticles</span><span class="hl-1">(</span><span class="hl-4">canvasRef</span><span class="hl-1">.</span><span class="hl-4">current</span><span class="hl-1">, { ...</span><span class="hl-4">options</span><span class="hl-1">, </span><span class="hl-4">overlay:</span><span class="hl-1"> </span><span class="hl-4">resolvedOverlay</span><span class="hl-1"> })</span><br/><span class="hl-1"> : </span><span class="hl-9">/* v8 ignore next */</span><br/><span class="hl-1"> </span><span class="hl-7">undefined</span><span class="hl-1">,</span><br/><span class="hl-1"> [</span><span class="hl-4">options</span><span class="hl-1">, </span><span class="hl-4">resolvedOverlay</span><span class="hl-1">],</span><br/><span class="hl-1"> );</span><br/><span class="hl-1"> </span><span class="hl-3">return</span><span class="hl-1"> <</span><span class="hl-8">canvas</span><span class="hl-1"> </span><span class="hl-8">ref</span><span class="hl-1">={</span><span class="hl-4">canvasRef</span><span class="hl-1">} </span><span class="hl-8">style</span><span class="hl-1">={</span><span class="hl-4">style</span><span class="hl-1">} {...</span><span class="hl-8">props</span><span class="hl-1">} </span><span class="hl-8">data</span><span class="hl-1">-</span><span class="hl-8">testid</span><span class="hl-1">=</span><span class="hl-2">"particles"</span><span class="hl-1"> />;</span><br/><span class="hl-1">};</span>
</code><button type="button">Copy</button></pre>
</div></div></section><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="Particles" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Particles</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">__namedParameters</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Element</span><a href="#Particles" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">__namedParameters</span>: <a href="../interfaces/react_particles_particles.ParticlesProps.html" class="tsd-signature-type tsd-kind-interface">ParticlesProps</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Element</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/react18-tools/webgl-generative-particles/blob/5b2db2b1cfa6b3eb72cae2bc7b54f39c1ac1cdb5/lib/src/react/particles/particles.tsx#L20">react/particles/particles.tsx:20</a></li></ul></aside></li></ul></section></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></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Webgl Generative Particles</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>