@zeix/ui-element
Version:
UIElement - a HTML-first library for reactive Web Components
350 lines (338 loc) • 11.9 kB
HTML
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>ElementUpdater\<E, T\> – 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-elementupdaterlte-tgt">
<a name="type-alias-elementupdaterlte-tgt" class="anchor" href="#type-alias-elementupdaterlte-tgt">
<span class="permalink">🔗</span>
<span class="title">Type Alias: ElementUpdater<E, T></span>
</a>
</h1>
<blockquote>
<p><strong>ElementUpdater</strong><<code>E</code>, <code>T</code>> = <code>object</code></p>
</blockquote>
<p>Defined in: <a href="https://github.com/zeixcom/ui-element/blob/bc5efd047a1ae7f13c4c9861e40f8a1b07b7e003/src/lib/effects.ts#L37">src/lib/effects.ts:37</a></p>
<h2 id="type-parameters">
<a name="type-parameters" class="anchor" href="#type-parameters">
<span class="permalink">🔗</span>
<span class="title">Type Parameters</span>
</a>
</h2>
<h3 id="e">
<a name="e" class="anchor" href="#e">
<span class="permalink">🔗</span>
<span class="title">E</span>
</a>
</h3>
<p><code>E</code> <em>extends</em> <code>Element</code></p>
<h3 id="t">
<a name="t" class="anchor" href="#t">
<span class="permalink">🔗</span>
<span class="title">T</span>
</a>
</h3>
<p><code>T</code></p>
<h2 id="properties">
<a name="properties" class="anchor" href="#properties">
<span class="permalink">🔗</span>
<span class="title">Properties</span>
</a>
</h2>
<h3 id="delete">
<a name="delete" class="anchor" href="#delete">
<span class="permalink">🔗</span>
<span class="title">delete()?</span>
</a>
</h3>
<blockquote>
<p><code>optional</code> <strong>delete</strong>: (<code>element</code>) => <code>void</code></p>
</blockquote>
<p>Defined in: <a href="https://github.com/zeixcom/ui-element/blob/bc5efd047a1ae7f13c4c9861e40f8a1b07b7e003/src/lib/effects.ts#L42">src/lib/effects.ts:42</a></p>
<h4 id="parameters">
<a name="parameters" class="anchor" href="#parameters">
<span class="permalink">🔗</span>
<span class="title">Parameters</span>
</a>
</h4>
<h5 id="element">
<a name="element" class="anchor" href="#element">
<span class="permalink">🔗</span>
<span class="title">element</span>
</a>
</h5>
<p><code>E</code></p>
<h4 id="returns">
<a name="returns" class="anchor" href="#returns">
<span class="permalink">🔗</span>
<span class="title">Returns</span>
</a>
</h4>
<p><code>void</code></p>
<hr>
<h3 id="name">
<a name="name" class="anchor" href="#name">
<span class="permalink">🔗</span>
<span class="title">name?</span>
</a>
</h3>
<blockquote>
<p><code>optional</code> <strong>name</strong>: <code>string</code></p>
</blockquote>
<p>Defined in: <a href="https://github.com/zeixcom/ui-element/blob/bc5efd047a1ae7f13c4c9861e40f8a1b07b7e003/src/lib/effects.ts#L39">src/lib/effects.ts:39</a></p>
<hr>
<h3 id="op">
<a name="op" class="anchor" href="#op">
<span class="permalink">🔗</span>
<span class="title">op</span>
</a>
</h3>
<blockquote>
<p><strong>op</strong>: <a href="UpdateOperation.html"><code>UpdateOperation</code></a></p>
</blockquote>
<p>Defined in: <a href="https://github.com/zeixcom/ui-element/blob/bc5efd047a1ae7f13c4c9861e40f8a1b07b7e003/src/lib/effects.ts#L38">src/lib/effects.ts:38</a></p>
<hr>
<h3 id="read">
<a name="read" class="anchor" href="#read">
<span class="permalink">🔗</span>
<span class="title">read()</span>
</a>
</h3>
<blockquote>
<p><strong>read</strong>: (<code>element</code>) => <code>T</code> | <code>null</code></p>
</blockquote>
<p>Defined in: <a href="https://github.com/zeixcom/ui-element/blob/bc5efd047a1ae7f13c4c9861e40f8a1b07b7e003/src/lib/effects.ts#L40">src/lib/effects.ts:40</a></p>
<h4 id="parameters">
<a name="parameters" class="anchor" href="#parameters">
<span class="permalink">🔗</span>
<span class="title">Parameters</span>
</a>
</h4>
<h5 id="element">
<a name="element" class="anchor" href="#element">
<span class="permalink">🔗</span>
<span class="title">element</span>
</a>
</h5>
<p><code>E</code></p>
<h4 id="returns">
<a name="returns" class="anchor" href="#returns">
<span class="permalink">🔗</span>
<span class="title">Returns</span>
</a>
</h4>
<p><code>T</code> | <code>null</code></p>
<hr>
<h3 id="reject">
<a name="reject" class="anchor" href="#reject">
<span class="permalink">🔗</span>
<span class="title">reject()?</span>
</a>
</h3>
<blockquote>
<p><code>optional</code> <strong>reject</strong>: (<code>error</code>) => <code>void</code></p>
</blockquote>
<p>Defined in: <a href="https://github.com/zeixcom/ui-element/blob/bc5efd047a1ae7f13c4c9861e40f8a1b07b7e003/src/lib/effects.ts#L44">src/lib/effects.ts:44</a></p>
<h4 id="parameters">
<a name="parameters" class="anchor" href="#parameters">
<span class="permalink">🔗</span>
<span class="title">Parameters</span>
</a>
</h4>
<h5 id="error">
<a name="error" class="anchor" href="#error">
<span class="permalink">🔗</span>
<span class="title">error</span>
</a>
</h5>
<p><code>unknown</code></p>
<h4 id="returns">
<a name="returns" class="anchor" href="#returns">
<span class="permalink">🔗</span>
<span class="title">Returns</span>
</a>
</h4>
<p><code>void</code></p>
<hr>
<h3 id="resolve">
<a name="resolve" class="anchor" href="#resolve">
<span class="permalink">🔗</span>
<span class="title">resolve()?</span>
</a>
</h3>
<blockquote>
<p><code>optional</code> <strong>resolve</strong>: (<code>element</code>) => <code>void</code></p>
</blockquote>
<p>Defined in: <a href="https://github.com/zeixcom/ui-element/blob/bc5efd047a1ae7f13c4c9861e40f8a1b07b7e003/src/lib/effects.ts#L43">src/lib/effects.ts:43</a></p>
<h4 id="parameters">
<a name="parameters" class="anchor" href="#parameters">
<span class="permalink">🔗</span>
<span class="title">Parameters</span>
</a>
</h4>
<h5 id="element">
<a name="element" class="anchor" href="#element">
<span class="permalink">🔗</span>
<span class="title">element</span>
</a>
</h5>
<p><code>E</code></p>
<h4 id="returns">
<a name="returns" class="anchor" href="#returns">
<span class="permalink">🔗</span>
<span class="title">Returns</span>
</a>
</h4>
<p><code>void</code></p>
<hr>
<h3 id="update">
<a name="update" class="anchor" href="#update">
<span class="permalink">🔗</span>
<span class="title">update()</span>
</a>
</h3>
<blockquote>
<p><strong>update</strong>: (<code>element</code>, <code>value</code>) => <code>void</code></p>
</blockquote>
<p>Defined in: <a href="https://github.com/zeixcom/ui-element/blob/bc5efd047a1ae7f13c4c9861e40f8a1b07b7e003/src/lib/effects.ts#L41">src/lib/effects.ts:41</a></p>
<h4 id="parameters">
<a name="parameters" class="anchor" href="#parameters">
<span class="permalink">🔗</span>
<span class="title">Parameters</span>
</a>
</h4>
<h5 id="element">
<a name="element" class="anchor" href="#element">
<span class="permalink">🔗</span>
<span class="title">element</span>
</a>
</h5>
<p><code>E</code></p>
<h5 id="value">
<a name="value" class="anchor" href="#value">
<span class="permalink">🔗</span>
<span class="title">value</span>
</a>
</h5>
<p><code>T</code></p>
<h4 id="returns">
<a name="returns" class="anchor" href="#returns">
<span class="permalink">🔗</span>
<span class="title">Returns</span>
</a>
</h4>
<p><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>