UNPKG

@zeix/ui-element

Version:

UIElement - a HTML-first library for reactive Web Components

301 lines (289 loc) 10.5 kB
<!doctype html> <html lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>SelectorFunctions\<P\> – UIElement Docs</title> <meta name="description" content="" /> <link rel="stylesheet" href="../../assets/main.css" /> <script type="module" src="../../assets/main.js"></script> </head> <body class="api"> <context-router> <header class="content-grid"> <h1 class="content"> UIElement Docs <small>Version 0.13.3</small> </h1> <section-menu> <nav> <h2 class="visually-hidden">Main Menu</h2> <ol> <li> <a href="../../index.html"> <span class="icon">📖</span> <strong>Introduction</strong> <small>Overview and key benefits of UIElement</small> </a> </li> <li> <a href="../../getting-started.html"> <span class="icon">🚀</span> <strong>Getting Started</strong> <small>Installation, setup, and first steps</small> </a> </li> <li> <a href="../../components.html"> <span class="icon">🏗️</span> <strong>Components</strong> <small>Anatomy, lifecycle, signals, effects</small> </a> </li> <li> <a href="../../styling.html"> <span class="icon">🎨</span> <strong>Styling</strong> <small>Scoped styles, CSS custom properties</small> </a> </li> <li> <a href="../../data-flow.html"> <span class="icon">🔄</span> <strong>Data Flow</strong> <small>Passing state, events, context</small> </a> </li> <li> <a href="../../examples.html"> <span class="icon">🍽️</span> <strong>Examples</strong> <small>Common use cases and demos</small> </a> </li> <li> <a href="../../blog.html"> <span class="icon">📜</span> <strong>Blog</strong> <small>Latest articles and updates</small> </a> </li> <li> <a href="../../api.html"> <span class="icon">📚</span> <strong>API Reference</strong> <small>Functions, types, and constants</small> </a> </li> <li> <a href="../../about.html"> <span class="icon">🤝</span> <strong>About</strong> <small>License, versioning, getting involved</small> </a> </li> </ol> </nav> </section-menu> <card-callout class="content danger" hidden> <p class="error" role="alert" aria-live="polite"></p> </card-callout> </header> <main class="content-grid"><section class="api-content"> <h1 id="type-alias-selectorfunctionsltpgt"> <a name="type-alias-selectorfunctionsltpgt" class="anchor" href="#type-alias-selectorfunctionsltpgt"> <span class="permalink">🔗</span> </a> Type Alias: SelectorFunctions&lt;P&gt; </h1> <blockquote> <p><strong>SelectorFunctions</strong>&lt;<code>P</code>&gt; = <code>object</code></p> </blockquote> <p>Defined in: <a href="https://github.com/zeixcom/ui-element/blob/f80be4b02c5d1c80817271ddf0fad982e43ad03e/src/component.ts#L97">src/component.ts:97</a></p> <h2 id="type-parameters"> <a name="type-parameters" class="anchor" href="#type-parameters"> <span class="permalink">🔗</span> </a> Type Parameters </h2> <h3 id="p"> <a name="p" class="anchor" href="#p"> <span class="permalink">🔗</span> </a> P </h3> <p><code>P</code> <em>extends</em> <a href="ComponentProps.html"><code>ComponentProps</code></a></p> <h2 id="properties"> <a name="properties" class="anchor" href="#properties"> <span class="permalink">🔗</span> </a> Properties </h2> <h3 id="all"> <a name="all" class="anchor" href="#all"> <span class="permalink">🔗</span> </a> all() </h3> <blockquote> <p><strong>all</strong>: &lt;<code>E</code>, <code>K</code>&gt;(<code>selector</code>, ...<code>fns</code>) =&gt; (<code>host</code>) =&gt; <a href="Cleanup.html"><code>Cleanup</code></a></p> </blockquote> <p>Defined in: <a href="https://github.com/zeixcom/ui-element/blob/f80be4b02c5d1c80817271ddf0fad982e43ad03e/src/component.ts#L102">src/component.ts:102</a></p> <h4 id="type-parameters"> <a name="type-parameters" class="anchor" href="#type-parameters"> <span class="permalink">🔗</span> </a> Type Parameters </h4> <h5 id="e"> <a name="e" class="anchor" href="#e"> <span class="permalink">🔗</span> </a> E </h5> <p><code>E</code> <em>extends</em> <code>Element</code> = <code>never</code></p> <h5 id="k"> <a name="k" class="anchor" href="#k"> <span class="permalink">🔗</span> </a> K </h5> <p><code>K</code> <em>extends</em> <code>string</code> = <code>string</code></p> <h4 id="parameters"> <a name="parameters" class="anchor" href="#parameters"> <span class="permalink">🔗</span> </a> Parameters </h4> <h5 id="selector"> <a name="selector" class="anchor" href="#selector"> <span class="permalink">🔗</span> </a> selector </h5> <p><code>K</code></p> <h5 id="fns"> <a name="fns" class="anchor" href="#fns"> <span class="permalink">🔗</span> </a> fns </h5> <p>...<a href="Effect.html"><code>Effect</code></a>&lt;<code>P</code>, <a href="ElementFromSelector.html"><code>ElementFromSelector</code></a>&lt;<code>K</code>, <code>E</code>&gt;&gt;[]</p> <h4 id="returns"> <a name="returns" class="anchor" href="#returns"> <span class="permalink">🔗</span> </a> Returns </h4> <blockquote> <p>(<code>host</code>): <a href="Cleanup.html"><code>Cleanup</code></a></p> </blockquote> <h5 id="parameters"> <a name="parameters" class="anchor" href="#parameters"> <span class="permalink">🔗</span> </a> Parameters </h5> <h6 id="host"> <a name="host" class="anchor" href="#host"> <span class="permalink">🔗</span> </a> host </h6> <p><a href="Component.html"><code>Component</code></a>&lt;<code>P</code>&gt;</p> <h5 id="returns"> <a name="returns" class="anchor" href="#returns"> <span class="permalink">🔗</span> </a> Returns </h5> <p><a href="Cleanup.html"><code>Cleanup</code></a></p> <hr> <h3 id="first"> <a name="first" class="anchor" href="#first"> <span class="permalink">🔗</span> </a> first() </h3> <blockquote> <p><strong>first</strong>: &lt;<code>E</code>, <code>K</code>&gt;(<code>selector</code>, ...<code>fns</code>) =&gt; (<code>host</code>) =&gt; <a href="Cleanup.html"><code>Cleanup</code></a> | <code>void</code></p> </blockquote> <p>Defined in: <a href="https://github.com/zeixcom/ui-element/blob/f80be4b02c5d1c80817271ddf0fad982e43ad03e/src/component.ts#L98">src/component.ts:98</a></p> <h4 id="type-parameters"> <a name="type-parameters" class="anchor" href="#type-parameters"> <span class="permalink">🔗</span> </a> Type Parameters </h4> <h5 id="e"> <a name="e" class="anchor" href="#e"> <span class="permalink">🔗</span> </a> E </h5> <p><code>E</code> <em>extends</em> <code>Element</code> = <code>never</code></p> <h5 id="k"> <a name="k" class="anchor" href="#k"> <span class="permalink">🔗</span> </a> K </h5> <p><code>K</code> <em>extends</em> <code>string</code> = <code>string</code></p> <h4 id="parameters"> <a name="parameters" class="anchor" href="#parameters"> <span class="permalink">🔗</span> </a> Parameters </h4> <h5 id="selector"> <a name="selector" class="anchor" href="#selector"> <span class="permalink">🔗</span> </a> selector </h5> <p><code>K</code></p> <h5 id="fns"> <a name="fns" class="anchor" href="#fns"> <span class="permalink">🔗</span> </a> fns </h5> <p>...<a href="Effect.html"><code>Effect</code></a>&lt;<code>P</code>, <a href="ElementFromSelector.html"><code>ElementFromSelector</code></a>&lt;<code>K</code>, <code>E</code>&gt;&gt;[]</p> <h4 id="returns"> <a name="returns" class="anchor" href="#returns"> <span class="permalink">🔗</span> </a> Returns </h4> <blockquote> <p>(<code>host</code>): <a href="Cleanup.html"><code>Cleanup</code></a> | <code>void</code></p> </blockquote> <h5 id="parameters"> <a name="parameters" class="anchor" href="#parameters"> <span class="permalink">🔗</span> </a> Parameters </h5> <h6 id="host"> <a name="host" class="anchor" href="#host"> <span class="permalink">🔗</span> </a> host </h6> <p><a href="Component.html"><code>Component</code></a>&lt;<code>P</code>&gt;</p> <h5 id="returns"> <a name="returns" class="anchor" href="#returns"> <span class="permalink">🔗</span> </a> Returns </h5> <p><a href="Cleanup.html"><code>Cleanup</code></a> | <code>void</code></p> </section></main> <footer class="content-grid"> <div class="content"> <h2 class="visually-hidden">Footer</h2> <p>© 2024 – 2025 Zeix AG</p> </div> </footer> </context-router> </body> </html>