profectus-docs/assets/api_interfaces_features_particles_particles.ParticlesOptions.md.67d30c88.js

import{_ as e,c as t,o as a,N as r}from"./chunks/framework.0799945b.js";const b=JSON.parse('{"title":"Interface: ParticlesOptions","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/interfaces/features/particles/particles.ParticlesOptions.md","lastUpdated":null}'),o={name:"api/interfaces/features/particles/particles.ParticlesOptions.md"},s=r('<h1 id="interface-particlesoptions" tabindex="-1">Interface: ParticlesOptions <a class="header-anchor" href="#interface-particlesoptions" aria-label="Permalink to &quot;Interface: ParticlesOptions&quot;">​</a></h1><p><a href="./../../../modules/features/particles/particles">features/particles/particles</a>.ParticlesOptions</p><p>An object that configures <a href="./../../../modules/features/particles/particles#particles">Particles</a>.</p><h2 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-label="Permalink to &quot;Properties&quot;">​</a></h2><h3 id="classes" tabindex="-1">classes <a class="header-anchor" href="#classes" aria-label="Permalink to &quot;classes&quot;">​</a></h3><p>• <code>Optional</code> <strong>classes</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a>&lt;<a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" target="_blank" rel="noreferrer"><code>Record</code></a>&lt;<code>string</code>, <code>boolean</code>&gt;&gt;</p><p>Dictionary of CSS classes to apply to this feature.</p><h4 id="defined-in" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/particles/particles.tsx#L19" target="_blank" rel="noreferrer">profectus/src/features/particles/particles.tsx:19</a></p><hr><h3 id="oncontainerresized" tabindex="-1">onContainerResized <a class="header-anchor" href="#oncontainerresized" aria-label="Permalink to &quot;onContainerResized&quot;">​</a></h3><p>• <code>Optional</code> <strong>onContainerResized</strong>: (<code>boundingRect</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/API/DOMRect" target="_blank" rel="noreferrer"><code>DOMRect</code></a>) =&gt; <code>void</code></p><h4 id="type-declaration" tabindex="-1">Type declaration <a class="header-anchor" href="#type-declaration" aria-label="Permalink to &quot;Type declaration&quot;">​</a></h4><p>▸ (<code>boundingRect</code>): <code>void</code></p><p>A function that is called when the particles canvas is resized.</p><h5 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-label="Permalink to &quot;Parameters&quot;">​</a></h5><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th></tr></thead><tbody><tr><td style="text-align:left;"><code>boundingRect</code></td><td style="text-align:left;"><a href="https://developer.mozilla.org/en-US/docs/Web/API/DOMRect" target="_blank" rel="noreferrer"><code>DOMRect</code></a></td></tr></tbody></table><h5 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-label="Permalink to &quot;Returns&quot;">​</a></h5><p><code>void</code></p><h4 id="defined-in-1" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-1" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/particles/particles.tsx#L23" target="_blank" rel="noreferrer">profectus/src/features/particles/particles.tsx:23</a></p><hr><h3 id="onhotreload" tabindex="-1">onHotReload <a class="header-anchor" href="#onhotreload" aria-label="Permalink to &quot;onHotReload&quot;">​</a></h3><p>• <code>Optional</code> <strong>onHotReload</strong>: <code>VoidFunction</code></p><p>A function that is called whenever the particles element is reloaded during development. For restarting particle effects.</p><h4 id="defined-in-2" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-2" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/particles/particles.tsx#L25" target="_blank" rel="noreferrer">profectus/src/features/particles/particles.tsx:25</a></p><hr><h3 id="style" tabindex="-1">style <a class="header-anchor" href="#style" aria-label="Permalink to &quot;style&quot;">​</a></h3><p>• <code>Optional</code> <strong>style</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a>&lt;<a href="./../../../modules/features/feature#stylevalue"><code>StyleValue</code></a>&gt;</p><p>CSS to apply to this feature.</p><h4 id="defined-in-3" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-3" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/particles/particles.tsx#L21" target="_blank" rel="noreferrer">profectus/src/features/particles/particles.tsx:21</a></p>',33),i=[s];function n(c,l,d,p,h,f){return a(),t("div",null,i)}const m=e(o,[["render",n]]);export{b as __pageData,m as default};