Skip to content

Commit

Permalink
upgrade deps && docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mayank1513 committed Jan 16, 2025
1 parent ae9377b commit c086b6c
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 16 deletions.
2 changes: 1 addition & 1 deletion docs/functions/react_particles_particles.Particles.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@
<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">=&gt;</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">&lt;</span><span class="hl-8">HTMLCanvasElement</span><span class="hl-1">&gt;(</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">&quot;fixed&quot;</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">&quot;100vw&quot;</span><span class="hl-1">, </span><span class="hl-4">height:</span><span class="hl-1"> </span><span class="hl-2">&quot;100vh&quot;</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">&quot;none&quot;</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">=&gt;</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"> &lt;</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">&quot;particles&quot;</span><span class="hl-1"> /&gt;;</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> <a href="../interfaces/react_particles_particles.ParticlesProps.html" class="tsd-signature-type tsd-kind-interface">ParticlesProps</a><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/9ab66fbe9c80c904cca1157342608a05f290ba89/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">Webgl Generative Particles</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><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>
</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> <a href="../interfaces/react_particles_particles.ParticlesProps.html" class="tsd-signature-type tsd-kind-interface">ParticlesProps</a><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/ae9377b1bc1cc1a0b2f2e0ed4f2c1d3c4ad68214/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">Webgl Generative Particles</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><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>
Loading

0 comments on commit c086b6c

Please sign in to comment.