@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>fromContext – 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="function-fromcontext"> <a name="function-fromcontext" class="anchor" href="#function-fromcontext"> <span class="permalink">🔗</span> </a> Function: fromContext() </h1> <blockquote> <p><strong>fromContext</strong><<code>T</code>, <code>C</code>>(<code>context</code>, <code>fallback</code>): (<code>host</code>) => <a href="../type-aliases/Signal.html"><code>Signal</code></a><<code>T</code>></p> </blockquote> <p>Defined in: <a href="https://github.com/zeixcom/ui-element/blob/f80be4b02c5d1c80817271ddf0fad982e43ad03e/src/core/context.ts#L125">src/core/context.ts:125</a></p> <p>Consume a context value for a component.</p> <h2 id="type-parameters"> <a name="type-parameters" class="anchor" href="#type-parameters"> <span class="permalink">🔗</span> </a> Type Parameters </h2> <h3 id="t"> <a name="t" class="anchor" href="#t"> <span class="permalink">🔗</span> </a> T </h3> <p><code>T</code> <em>extends</em> <code>object</code></p> <h3 id="c"> <a name="c" class="anchor" href="#c"> <span class="permalink">🔗</span> </a> C </h3> <p><code>C</code> <em>extends</em> <code>HTMLElement</code></p> <h2 id="parameters"> <a name="parameters" class="anchor" href="#parameters"> <span class="permalink">🔗</span> </a> Parameters </h2> <h3 id="context"> <a name="context" class="anchor" href="#context"> <span class="permalink">🔗</span> </a> context </h3> <p><a href="../type-aliases/Context.html"><code>Context</code></a><<code>string</code>, <a href="../type-aliases/Signal.html"><code>Signal</code></a><<code>T</code>>></p> <p>context key to consume</p> <h3 id="fallback"> <a name="fallback" class="anchor" href="#fallback"> <span class="permalink">🔗</span> </a> fallback </h3> <p><a href="../type-aliases/MaybeSignal.html"><code>MaybeSignal</code></a><<code>T</code>></p> <p>fallback value to use if context is not provided</p> <h2 id="returns"> <a name="returns" class="anchor" href="#returns"> <span class="permalink">🔗</span> </a> Returns </h2> <ul> <li>a function that returns the consumed context signal or a signal of the fallback value</li> </ul> <blockquote> <p>(<code>host</code>): <a href="../type-aliases/Signal.html"><code>Signal</code></a><<code>T</code>></p> </blockquote> <h3 id="parameters"> <a name="parameters" class="anchor" href="#parameters"> <span class="permalink">🔗</span> </a> Parameters </h3> <h4 id="host"> <a name="host" class="anchor" href="#host"> <span class="permalink">🔗</span> </a> host </h4> <p><code>C</code></p> <h3 id="returns"> <a name="returns" class="anchor" href="#returns"> <span class="permalink">🔗</span> </a> Returns </h3> <p><a href="../type-aliases/Signal.html"><code>Signal</code></a><<code>T</code>></p> <h2 id="since"> <a name="since" class="anchor" href="#since"> <span class="permalink">🔗</span> </a> Since </h2> <p>0.13.1</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>