@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>Components – UIElement Docs</title> <meta name="description" content="Anatomy, lifecycle, signals, effects" /> <link rel="stylesheet" href="./assets/main.css" /> <script type="module" src="./assets/main.js"></script> </head> <body class=""> <context-router> <header class="content-grid"> <h1 class="content"> UIElement Docs Version 0.13.3 </h1> <section-menu> <nav> <h2 class="visually-hidden">Main Menu</h2> <ol> <li> <a href="index.html"> 📖 Introduction Overview and key benefits of UIElement </a> </li> <li> <a href="getting-started.html"> 🚀 Getting Started Installation, setup, and first steps </a> </li> <li> <a href="components.html"> 🏗️ Components Anatomy, lifecycle, signals, effects </a> </li> <li> <a href="styling.html"> 🎨 Styling Scoped styles, CSS custom properties </a> </li> <li> <a href="data-flow.html"> 🔄 Data Flow Passing state, events, context </a> </li> <li> <a href="examples.html"> 🍽️ Examples Common use cases and demos </a> </li> <li> <a href="blog.html"> 📜 Blog Latest articles and updates </a> </li> <li> <a href="api.html"> 📚 API Reference Functions, types, and constants </a> </li> <li> <a href="about.html"> 🤝 About License, versioning, getting involved </a> </li> </ol> </nav> </section-menu> <card-callout class="content danger" hidden> </card-callout> </header> <main class="content-grid"><section-hero> <h1 id="components"> <a name="components" class="anchor" href="#components"> 🔗 </a> 🏗️ Components </h1> <div> Create lightweight, self-contained Web Components with built-in reactivity. UIElement lets you define custom elements that manage state efficiently, update the DOM automatically, and enhance server-rendered pages without an SPA framework. <module-toc> <nav> <h2>In this Page</h2> <ol> <li><a href="#defining-a-component">Defining a Component</a></li> <li><a href="#component-lifecycle">Component Lifecycle</a></li> <li><a href="#managing-state-with-signals">Managing State with Signals</a></li> <li><a href="#selecting-elements">Selecting Elements</a></li> <li><a href="#adding-event-listeners">Adding Event Listeners</a></li> <li><a href="#synchronizing-state-with-effects">Synchronizing State with Effects</a></li> <li><a href="#next-steps">Next Steps</a></li> </ol> </nav> </module-toc> </div> </section-hero> <section> <h2 id="defining-a-component"> <a name="defining-a-component" class="anchor" href="#defining-a-component"> 🔗 </a> Defining a Component </h2> UIElement builds on Web Components, extending <code>HTMLElement</code> to provide built-in state management and reactive updates. UIElement creates components using the <code>component()</code> function: <module-codeblock language="js" copy-success="Copied!" copy-error="Error trying to copy to clipboard!"> js <pre class="shiki monokai" style="background-color:#272822;color:#F8F8F2" tabindex="0"><code>component('my-component', {}, () => [ // Component setup ]) </code></pre> <basic-button class="copy"> <button type="button" class="secondary small"> Copy </button> </basic-button> </module-codeblock> Every UIElement component must be registered with a valid custom element tag name (two or more words joined with <code>-</code>) as the first parameter. <h3 id="using-the-custom-element-in-html"> <a name="using-the-custom-element-in-html" class="anchor" href="#using-the-custom-element-in-html"> 🔗 </a> Using the Custom Element in HTML </h3> Once registered, the component can be used like any native HTML element: <module-codeblock language="html" copy-success="Copied!" copy-error="Error trying to copy to clipboard!"> html <pre class="shiki monokai" style="background-color:#272822;color:#F8F8F2" tabindex="0"><code><my-component>Content goes here</my-component> </code></pre> <basic-button class="copy"> <button type="button" class="secondary small"> Copy </button> </basic-button> </module-codeblock> </section> <section> <h2 id="component-lifecycle"> <a name="component-lifecycle" class="anchor" href="#component-lifecycle"> 🔗 </a> Component Lifecycle </h2> UIElement manages the Web Component lifecycle from creation to removal. Here's what happens. <h3 id="component-creation"> <a name="component-creation" class="anchor" href="#component-creation"> 🔗 </a> Component Creation </h3> In the <code>constructor()</code> reactive properties are initialized. You pass a second argument to the <code>component()</code> function to defines initial values for component states. <module-codeblock collapsed language="js" copy-success="Copied!" copy-error="Error trying to copy to clipboard!"> js <pre class="shiki monokai" style="background-color:#272822;color:#F8F8F2" tabindex="0"><code>component( 'my-component', { count: 0, // Initial value of "count" signal value: asInteger(5), // Parse "value" attribute as integer defaulting to 5 isEven: el => () => !(el.count % 2), // Computed signal based on "count" signal name: fromContext('display-name', 'World'), // Consume "display-name" signal from closest context provider }, () => [ // Component setup ], ) </code></pre> <basic-button class="copy"> <button type="button" class="secondary small"> Copy </button> </basic-button> <button type="button" class="overlay">Expand</button> </module-codeblock> In this example you see all three ways to define a reactive property: <ul> <li>A static initial value for a <code>State</code> signal (e.g., <code>count: 0</code>)</li> <li>An attribute parser that may provide a fallback value (e.g., <code>value: asInteger(5)</code>)</li> <li>A signal producer function that derives an initial value or a callback function from other properties of the element (e.g., <code>isEven: el => () => !(el.count % 2)</code>) or bundled signal producers (e.g. <code>fromContext(context, fallback)</code>)</li> </ul> <card-callout class="caution"> Note: Property initialization runs before the element is attached to the DOM. You can't access not yet defined properties or child elements here. </card-callout> <h3 id="mounted-in-the-dom"> <a name="mounted-in-the-dom" class="anchor" href="#mounted-in-the-dom"> 🔗 </a> Mounted in the DOM </h3> Runs when the component is added to the page (<code>connectedCallback()</code>). This is where you: <ul> <li>Access sub-elements</li> <li>Set up event listeners</li> <li>Apply effects</li> <li>Emit custom events</li> <li>Provide context</li> </ul> The setup function has two arguments: <ol> <li><code>el</code>: The component element instance.</li> <li><code>{ all, first }</code>: An object containing two functions, <code>all</code> and <code>first</code>, which can be used to select elements within the component. See <a href="#accessing-sub-elements">Accessing Sub-elements</a>.</li> </ol> UIElement expects you to return an array of partially applied functions to be executed during the setup phase. The order doesn't matter, as each function targets a specific element or event. So feel free to organize your code in a way that makes sense to you. Each of these functions will return a cleanup function that will be executed during the <code>disconnectedCallback()</code> lifecycle method. <module-codeblock collapsed language="js" copy-success="Copied!" copy-error="Error trying to copy to clipboard!"> js <pre class="shiki monokai" style="background-color:#272822;color:#F8F8F2" tabindex="0"><code>component( 'my-component', { count: 0, }, (el, { first }) => [ emit('update-count', el.count), // Emit custom event provide('count'), // Provide context first( '.increment', on('click', () => { el.count++ }), // Add click event listener ), first( '.count', setText('count'), // Apply effect to update text ), ], ) </code></pre> <basic-button class="copy"> <button type="button" class="secondary small"> Copy </button> </basic-button> <button type="button" class="overlay">Expand</button> </module-codeblock> <h3 id="removed-from-the-dom"> <a name="removed-from-the-dom" class="anchor" href="#removed-from-the-dom"> 🔗 </a> Removed from the DOM </h3> Runs when the component is removed (<code>disconnectedCallback()</code>). UIElement will run all cleanup functions returned by event listeners and effects during the setup phase (<code>connectedCallback()</code>). This will unsubscribe all signals the component is subscribed to, so you don't need to worry about memory leaks. If you added event listeners outside the scope of your component or subscribed manually to external APIs, you need to return a cleanup function: <module-codeblock collapsed language="js" copy-success="Copied!" copy-error="Error trying to copy to clipboard!"> js <pre class="shiki monokai" style="background-color:#272822;color:#F8F8F2" tabindex="0"><code>component('my-component', {}, el => [ // Setup logic () => { const observer = new IntersectionObserver(([entry]) => { // Do something }) observer.observe(el) // Cleanup logic return () => observer.disconnect() }, ]) </code></pre> <basic-button class="copy"> <button type="button" class="secondary small"> Copy </button> </basic-button> <button type="button" class="overlay">Expand</button> </module-codeblock> <h3 id="observed-attributes"> <a name="observed-attributes" class="anchor" href="#observed-attributes"> 🔗 </a> Observed Attributes </h3> UIElement automatically observes and converts attributes with an associated parser function in the init block and updates them whenever the attribute changes (<code>attributeChangedCallback()</code>). </section> <section> <h2 id="managing-state-with-signals"> <a name="managing-state-with-signals" class="anchor" href="#managing-state-with-signals"> 🔗 </a> Managing State with Signals </h2> UIElement manages state using signals, which are atomic reactive states that trigger updates when they change. We use regular properties to access or update them: <module-codeblock language="js" copy-success="Copied!" copy-error="Error trying to copy to clipboard!"> js <pre class="shiki monokai" style="background-color:#272822;color:#F8F8F2" tabindex="0"><code>console.log('count' in el) // Check if the signal exists console.log(el.count) // Read the signal value el.count = 42 // Update the signal value </code></pre> <basic-button class="copy"> <button type="button" class="secondary small"> Copy </button> </basic-button> </module-codeblock> <h3 id="characteristics-and-special-values"> <a name="characteristics-and-special-values" class="anchor" href="#characteristics-and-special-values"> 🔗 </a> Characteristics and Special Values </h3> Signals in UIElement are of a static type and non-nullable. This allows to simplify the logic as you will never have to check the type or perform null-checks. <ul> <li>If you use TypeScript (recommended), you will be warned that <code>null</code> or <code>undefined</code> cannot be assigned to a signal or if you try to assign a value of a wrong type.</li> <li>If you use vanilla JavaScript without a build step, setting a signal to <code>null</code> or <code>undefined</code> will log an error to the console and abort. However, strict type checking is not enforced at runtime.</li> </ul> Because of the non-nullable nature of signals in UIElement, we need two special values that can be assigned to any signal type: <ul> <li><code>RESET</code>: Will reset to the server-rendered version that was there before UIElement took control. This is what you want to do most of the times when a signal lacks a specific value.</li> <li><code>UNSET</code>: Will delete the signal, unsubscribe its watchers and also delete related attributes or style properties in effects. Use this with special care!</li> </ul> <h3 id="initializing-state-from-attributes"> <a name="initializing-state-from-attributes" class="anchor" href="#initializing-state-from-attributes"> 🔗 </a> Initializing State from Attributes </h3> The standard way to set initial state in UIElement is via server-rendered attributes on the component that needs it. No props drilling as in other frameworks. UIElements provides some bundled attribute parsers to convert attribute values to the desired type. And you can also define your own custom parsers. <module-codeblock collapsed language="js" copy-success="Copied!" copy-error="Error trying to copy to clipboard!"> js <pre class="shiki monokai" style="background-color:#272822;color:#F8F8F2" tabindex="0"><code>component( 'my-component', { count: asInteger(), // Bundled parser: Convert '42' -> 42 date: (_, v) => new Date(v), // Custom parser: '2025-02-14' -> Date object }, () => [ // Component setup ], ) </code></pre> <basic-button class="copy"> <button type="button" class="secondary small"> Copy </button> </basic-button> <button type="button" class="overlay">Expand</button> </module-codeblock> <card-callout class="caution"> Careful: Attributes may not be present on the element or parsing to the desired type may fail. To ensure non-nullability of signals, UIElement falls back to neutral defaults: <ul> <li><code>""</code> (empty string) for <code>string</code></li> <li><code>0</code> for <code>number</code></li> <li><code>{}</code> (empty object) for objects of any kind</li> </ul> </card-callout> <h3 id="bundled-attribute-parsers"> <a name="bundled-attribute-parsers" class="anchor" href="#bundled-attribute-parsers"> 🔗 </a> Bundled Attribute Parsers </h3> <table> <thead> <tr> <th>Function</th> <th>Description</th> </tr> </thead> <tbody><tr> <td><a href="api/functions/asBoolean.html">asBoolean()</a></td> <td>Converts <code>"true"</code> / <code>"false"</code> to a boolean (<code>true</code> / <code>false</code>). Also treats empty attributes (<code>checked</code>) as <code>true</code>.</td> </tr> <tr> <td><a href="api/functions/asInteger.html">asInteger()</a></td> <td>Converts a numeric string (e.g., <code>"42"</code>) to an integer (<code>42</code>).</td> </tr> <tr> <td><a href="api/functions/asNumber.html">asNumber()</a></td> <td>Converts a numeric string (e.g., <code>"3.14"</code>) to a floating-point number (<code>3.14</code>).</td> </tr> <tr> <td><a href="api/functions/asString.html">asString()</a></td> <td>Returns the attribute value as a string (unchanged).</td> </tr> <tr> <td><a href="api/functions/asEnum.html">asEnum(values)</a></td> <td>Ensures the string matches one of the allowed values. Example: <code>asEnum(["small", "medium", "large"])</code>. If the value is not in the list, it defaults to the first option.</td> </tr> <tr> <td><a href="api/functions/asJSON.html">asJSON(fallback)</a></td> <td>Parses a JSON string (e.g., <code>'["a", "b", "c"]'</code>) into an array or object. If invalid, returns the fallback object.</td> </tr> </tbody></table> The pre-defined parsers <code>asInteger()</code>, <code>asNumber()</code> and <code>asString()</code> allow to set a custom fallback value as parameter. The <code>asEnum()</code> parser requires an array of valid values, while the first will be the fallback value for invalid results. The <code>asJSON()</code> parser requires a fallback object as parameter as <code>{}</code> probably won't match the type you're expecting. </section> <section> <h2 id="selecting-elements"> <a name="selecting-elements" class="anchor" href="#selecting-elements"> 🔗 </a> Selecting Elements </h2> Use the provided selector utilities to find elements within your component: <h3 id="first"> <a name="first" class="anchor" href="#first"> 🔗 </a> first() </h3> Selects the first matching element and applies effects: <module-codeblock collapsed language="js" copy-success="Copied!" copy-error="Error trying to copy to clipboard!"> js <pre class="shiki monokai" style="background-color:#272822;color:#F8F8F2" tabindex="0"><code>component( 'basic-counter', { count: asInteger(), }, (el, { first }) => [ first('.count', setText('count')), first( 'button', on('click', () => { el.count++ }), ), ], ) </code></pre> <basic-button class="copy"> <button type="button" class="secondary small"> Copy </button> </basic-button> <button type="button" class="overlay">Expand</button> </module-codeblock> <h3 id="all"> <a name="all" class="anchor" href="#all"> 🔗 </a> all() </h3> Selects all matching elements and applies effects to each: <module-codeblock collapsed language="js" copy-success="Copied!" copy-error="Error trying to copy to clipboard!"> js <pre class="shiki monokai" style="background-color:#272822;color:#F8F8F2" tabindex="0"><code>component( 'module-tabgroup', { selected: '', }, (el, { all }) => [ // Apply click handler to all buttons all( '[role="tab"]', on('click', e => { el.selected = e.currentTarget?.getAttribute('aria-controls') ?? '' }), setProperty( 'ariaSelected', target => target?.getAttribute('aria-controls') === el.selected, ), setProperty('tabIndex', target => target?.getAttribute('aria-controls') === el.selected ? 0 : -1, ), ), // Apply hidden property to all tabs all( '[role="tabpanel"]', show(target => el.selected === target.id), ), ], ) </code></pre> <basic-button class="copy"> <button type="button" class="secondary small"> Copy </button> </basic-button> <button type="button" class="overlay">Expand</button> </module-codeblock> The <code>first()</code> function expects the matched element to be present at connection time. If not, it will silently ignore the call. On the other hand, the <code>all()</code> function creates a dynamic array of elements that will be updated whenever the matching elements are added or removed from the component's DOM branch. UIElement will apply the given setup functions to added elements and run the cleanup functions on removed elements. <card-callout class="tip"> Tip: The <code>all()</code> function is more flexible but also more resource-intensive than <code>first()</code>. Prefer <code>first()</code> when targeting a single element known to be present at connection time. </card-callout> </section> <section> <h2 id="adding-event-listeners"> <a name="adding-event-listeners" class="anchor" href="#adding-event-listeners"> 🔗 </a> Adding Event Listeners </h2> Event listeners allow to respond to user interactions. They are the cause of changes in the component's state. <module-codeblock collapsed language="js" copy-success="Copied!" copy-error="Error trying to copy to clipboard!"> js <pre class="shiki monokai" style="background-color:#272822;color:#F8F8F2" tabindex="0"><code>component("my-component", { active: 0, value: '' }, (el, { all, first }) => [ all("button", on("click", e => { // Set "active" signal to value of data-index attribute of button const index = parseInt(e.target.dataset['index'], 10); el.active = Number.isInteger(index) ? index : 0; }) ), first("input", on("change", e => { // Set "value" signal to value of input element el.value = e.target.value; }) ) ] </code></pre> <basic-button class="copy"> <button type="button" class="secondary small"> Copy </button> </basic-button> <button type="button" class="overlay">Expand</button> </module-codeblock> </section> <section> <h2 id="synchronizing-state-with-effects"> <a name="synchronizing-state-with-effects" class="anchor" href="#synchronizing-state-with-effects"> 🔗 </a> Synchronizing State with Effects </h2> Effects automatically update the DOM when signals change, avoiding manual DOM manipulation. <h3 id="applying-effects"> <a name="applying-effects" class="anchor" href="#applying-effects"> 🔗 </a> Applying Effects </h3> Apply one or multiple effects in the setup function (for component itself) or in element selector functions: <module-codeblock collapsed language="js" copy-success="Copied!" copy-error="Error trying to copy to clipboard!"> js <pre class="shiki monokai" style="background-color:#272822;color:#F8F8F2" tabindex="0"><code>;(_, { first }) => [ // On the component itself setAttribute('open', 'isOpen'), // Set "open" attribute according to "isOpen" signal // On first element matching ".count" first( '.count', setText('count'), // Update text content according to "count" signal toggleClass('even', 'isEven'), // Toggle "even" class according to "isEven" signal ), ] </code></pre> <basic-button class="copy"> <button type="button" class="secondary small"> Copy </button> </basic-button> <button type="button" class="overlay">Expand</button> </module-codeblock> Again, the order of effects is not important. Feel free to apply them in any order that suits your needs. <h3 id="bundled-effects"> <a name="bundled-effects" class="anchor" href="#bundled-effects"> 🔗 </a> Bundled Effects </h3> <table> <thead> <tr> <th>Function</th> <th>Description</th> </tr> </thead> <tbody><tr> <td><a href="api/functions/setText.html">setText()</a></td> <td>Updates text content with a <code>string</code> signal value (while preserving comment nodes).</td> </tr> <tr> <td><a href="api/functions/setProperty.html">setProperty()</a></td> <td>Updates a given property with any signal value.</td> </tr> <tr> <td><a href="api/functions/show.html">show()</a></td> <td>Updates the visibility of an element with a <code>boolean</code> signal value.</td> </tr> <tr> <td><a href="api/functions/setAttribute.html">setAttribute()</a></td> <td>Updates a given attribute with a <code>string</code> signal value.</td> </tr> <tr> <td><a href="api/functions/toggleAttribute.html">toggleAttribute()</a></td> <td>Toggles a given boolean attribute with a <code>boolean</code> signal value.</td> </tr> <tr> <td><a href="api/functions/toggleClass.html">toggleClass()</a></td> <td>Toggles a given CSS class with a <code>boolean</code> signal value.</td> </tr> <tr> <td><a href="api/functions/setStyle.html">setStyle()</a></td> <td>Updates a given CSS property with a <code>string</code> signal value.</td> </tr> <tr> <td><a href="api/functions/dangerouslySetInnerHTML.html">dangerouslySetInnerHTML()</a></td> <td>Sets HTML content with a <code>string</code> signal value.</td> </tr> <tr> <td><a href="api/functions/insertOrRemoveElement.html">insertOrRemoveElement()</a></td> <td>Inserts (positive integer) or removes (negative integer) elements with a <code>number</code> signal value.</td> </tr> </tbody></table> <card-callout class="tip"> Tip: TypeScript will check whether a value of a given type is assignable to a certain element type. You might have to pass a type hint for the queried element type. Prefer <code>setProperty()</code> over <code>setAttribute()</code> for increased type safety. Setting string attributes is possible for all elements, but will have an effect only on some. </card-callout> <h3 id="simplifying-effect-notation"> <a name="simplifying-effect-notation" class="anchor" href="#simplifying-effect-notation"> 🔗 </a> Simplifying Effect Notation </h3> For effects that take two arguments, the second argument can be omitted if the signal key matches the targeted property name, attribute, class, or style property. When signal key matches property name: <module-codeblock language="js" copy-success="Copied!" copy-error="Error trying to copy to clipboard!"> js <pre class="shiki monokai" style="background-color:#272822;color:#F8F8F2" tabindex="0"><code>first('.count', toggleClass('even')) </code></pre> <basic-button class="copy"> <button type="button" class="secondary small"> Copy </button> </basic-button> </module-codeblock> Here, <code>toggleClass("even")</code> automatically uses the <code>"even"</code> signal. <h3 id="using-local-signals-for-protected-state"> <a name="using-local-signals-for-protected-state" class="anchor" href="#using-local-signals-for-protected-state"> 🔗 </a> Using Local Signals for Protected State </h3> Local signals are useful for storing state that should not be exposed to the outside world. They can be used to manage internal state within a component: <module-codeblock collapsed language="js" copy-success="Copied!" copy-error="Error trying to copy to clipboard!"> js <pre class="shiki monokai" style="background-color:#272822;color:#F8F8F2" tabindex="0"><code>component('my-component', {}, (_, { first<span style="color: