@zeix/ui-element

<!doctype html> <html lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>ElementUsage – UIElement Docs</title> <meta name="description" content="" /> <link rel="preload" href="../../assets/main.css?v=452f3291" as="style" /> <link rel="modulepreload" href="../../assets/main.js?v=4387827c" /> <link rel="stylesheet" href="../../assets/main.css?v=452f3291" /> <script type="module" src="../../assets/main.js?v=4387827c" ></script> </head> <body class="api"> <context-router> <header class="content-grid"> <a href="#main" class="skiplink visually-hidden"> Skip to main content </a> <h1 class="content"> UIElement Docs <small>Version 0.14.0</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 id="main" class="content-grid"><section class="api-content"> <h1 id="type-alias-elementusage"> <a name="type-alias-elementusage" class="anchor" href="#type-alias-elementusage"> <span class="permalink">🔗</span> <span class="title">Type Alias: ElementUsage()</span> </a> </h1> <blockquote> <p><strong>ElementUsage</strong> = {<<code>S</code>>(<code>selector</code>, <code>required</code>): <a href="ElementFromSelector.html"><code>ElementFromSelector</code></a><<code>S</code>>; <<code>S</code>>(<code>selector</code>): <code>null</code> | <a href="ElementFromSelector.html"><code>ElementFromSelector</code></a><<code>S</code>>; <<code>E</code>>(<code>selector</code>, <code>required</code>): <code>E</code>; <<code>E</code>>(<code>selector</code>): <code>null</code> | <code>E</code>; }</p> </blockquote> <p>Defined in: <a href="https://github.com/zeixcom/ui-element/blob/bc5efd047a1ae7f13c4c9861e40f8a1b07b7e003/src/core/dom.ts#L72">src/core/dom.ts:72</a></p> <h2 id="call-signature"> <a name="call-signature" class="anchor" href="#call-signature"> <span class="permalink">🔗</span> <span class="title">Call Signature</span> </a> </h2> <blockquote> <p><<code>S</code>>(<code>selector</code>, <code>required</code>): <a href="ElementFromSelector.html"><code>ElementFromSelector</code></a><<code>S</code>></p> </blockquote> <h3 id="type-parameters"> <a name="type-parameters" class="anchor" href="#type-parameters"> <span class="permalink">🔗</span> <span class="title">Type Parameters</span> </a> </h3> <h4 id="s"> <a name="s" class="anchor" href="#s"> <span class="permalink">🔗</span> <span class="title">S</span> </a> </h4> <p><code>S</code> <em>extends</em> <code>string</code></p> <h3 id="parameters"> <a name="parameters" class="anchor" href="#parameters"> <span class="permalink">🔗</span> <span class="title">Parameters</span> </a> </h3> <h4 id="selector"> <a name="selector" class="anchor" href="#selector"> <span class="permalink">🔗</span> <span class="title">selector</span> </a> </h4> <p><code>S</code></p> <h4 id="required"> <a name="required" class="anchor" href="#required"> <span class="permalink">🔗</span> <span class="title">required</span> </a> </h4> <p><code>string</code></p> <h3 id="returns"> <a name="returns" class="anchor" href="#returns"> <span class="permalink">🔗</span> <span class="title">Returns</span> </a> </h3> <p><a href="ElementFromSelector.html"><code>ElementFromSelector</code></a><<code>S</code>></p> <h2 id="call-signature"> <a name="call-signature" class="anchor" href="#call-signature"> <span class="permalink">🔗</span> <span class="title">Call Signature</span> </a> </h2> <blockquote> <p><<code>S</code>>(<code>selector</code>): <code>null</code> | <a href="ElementFromSelector.html"><code>ElementFromSelector</code></a><<code>S</code>></p> </blockquote> <h3 id="type-parameters"> <a name="type-parameters" class="anchor" href="#type-parameters"> <span class="permalink">🔗</span> <span class="title">Type Parameters</span> </a> </h3> <h4 id="s"> <a name="s" class="anchor" href="#s"> <span class="permalink">🔗</span> <span class="title">S</span> </a> </h4> <p><code>S</code> <em>extends</em> <code>string</code></p> <h3 id="parameters"> <a name="parameters" class="anchor" href="#parameters"> <span class="permalink">🔗</span> <span class="title">Parameters</span> </a> </h3> <h4 id="selector"> <a name="selector" class="anchor" href="#selector"> <span class="permalink">🔗</span> <span class="title">selector</span> </a> </h4> <p><code>S</code></p> <h3 id="returns"> <a name="returns" class="anchor" href="#returns"> <span class="permalink">🔗</span> <span class="title">Returns</span> </a> </h3> <p><code>null</code> | <a href="ElementFromSelector.html"><code>ElementFromSelector</code></a><<code>S</code>></p> <h2 id="call-signature"> <a name="call-signature" class="anchor" href="#call-signature"> <span class="permalink">🔗</span> <span class="title">Call Signature</span> </a> </h2> <blockquote> <p><<code>E</code>>(<code>selector</code>, <code>required</code>): <code>E</code></p> </blockquote> <h3 id="type-parameters"> <a name="type-parameters" class="anchor" href="#type-parameters"> <span class="permalink">🔗</span> <span class="title">Type Parameters</span> </a> </h3> <h4 id="e"> <a name="e" class="anchor" href="#e"> <span class="permalink">🔗</span> <span class="title">E</span> </a> </h4> <p><code>E</code> <em>extends</em> <code>Element</code></p> <h3 id="parameters"> <a name="parameters" class="anchor" href="#parameters"> <span class="permalink">🔗</span> <span class="title">Parameters</span> </a> </h3> <h4 id="selector"> <a name="selector" class="anchor" href="#selector"> <span class="permalink">🔗</span> <span class="title">selector</span> </a> </h4> <p><code>string</code></p> <h4 id="required"> <a name="required" class="anchor" href="#required"> <span class="permalink">🔗</span> <span class="title">required</span> </a> </h4> <p><code>string</code></p> <h3 id="returns"> <a name="returns" class="anchor" href="#returns"> <span class="permalink">🔗</span> <span class="title">Returns</span> </a> </h3> <p><code>E</code></p> <h2 id="call-signature"> <a name="call-signature" class="anchor" href="#call-signature"> <span class="permalink">🔗</span> <span class="title">Call Signature</span> </a> </h2> <blockquote> <p><<code>E</code>>(<code>selector</code>): <code>null</code> | <code>E</code></p> </blockquote> <h3 id="type-parameters"> <a name="type-parameters" class="anchor" href="#type-parameters"> <span class="permalink">🔗</span> <span class="title">Type Parameters</span> </a> </h3> <h4 id="e"> <a name="e" class="anchor" href="#e"> <span class="permalink">🔗</span> <span class="title">E</span> </a> </h4> <p><code>E</code> <em>extends</em> <code>Element</code></p> <h3 id="parameters"> <a name="parameters" class="anchor" href="#parameters"> <span class="permalink">🔗</span> <span class="title">Parameters</span> </a> </h3> <h4 id="selector"> <a name="selector" class="anchor" href="#selector"> <span class="permalink">🔗</span> <span class="title">selector</span> </a> </h4> <p><code>string</code></p> <h3 id="returns"> <a name="returns" class="anchor" href="#returns"> <span class="permalink">🔗</span> <span class="title">Returns</span> </a> </h3> <p><code>null</code> | <code>E</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>