| <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>docs/concepts/state-management | react-declarative</title><meta name="description" content="Documentation for react-declarative"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">react-declarative</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">react-declarative</a></li><li><a href="docs_concepts_state-management.html">docs/concepts/state-management</a></li></ul></div><div class="tsd-panel tsd-typography"><a id="how-react-declarative-manages-form-state-for-you" class="tsd-anchor"></a><h1 class="tsd-anchor-link">How react-declarative manages form state for you<a href="#how-react-declarative-manages-form-state-for-you" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h1><p>react-declarative manages form state for you. You supply an initial data loader, subscribe to changes, and define per-field rules as plain callback functions — the library handles diffing, re-renders, validation display, and disabled/hidden field states without any external state managers or manual <code>useState</code> wiring. This page explains all the moving parts.</p> |
| <a id="loading-initial-data-the-handler-prop" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Loading initial data: the <code>handler</code> prop<a href="#loading-initial-data-the-handler-prop" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>The <code>handler</code> prop tells <code><One /></code> where to get its initial data. It can be a static object, a sync function, or an async function — the component resolves it automatically.</p> |
| <pre><code class="typescript"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">OneTyped</span><span class="hl-1">, </span><span class="hl-2">TypedField</span><span class="hl-1">, </span><span class="hl-2">FieldType</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">'react-declarative'</span><span class="hl-1">;</span><br/><br/><span class="hl-17">// Static object</span><br/><span class="hl-1"><</span><span class="hl-2">OneTyped</span><br/><span class="hl-1"> </span><span class="hl-2">fields</span><span class="hl-1">={</span><span class="hl-2">fields</span><span class="hl-1">}</span><br/><span class="hl-1"> </span><span class="hl-2">handler</span><span class="hl-1">={{ </span><span class="hl-20">firstName</span><span class="hl-1">: </span><span class="hl-3">'Jane'</span><span class="hl-1">, </span><span class="hl-20">email</span><span class="hl-1">: </span><span class="hl-3">'jane@example.com'</span><span class="hl-1"> }}</span><br/><span class="hl-1">/></span><br/><br/><span class="hl-17">// Async function — useful for fetching from an API</span><br/><span class="hl-1"><</span><span class="hl-2">OneTyped</span><br/><span class="hl-1"> </span><span class="hl-2">fields</span><span class="hl-1">={</span><span class="hl-2">fields</span><span class="hl-1">}</span><br/><span class="hl-1"> </span><span class="hl-2">handler</span><span class="hl-1">={</span><span class="hl-5">async</span><span class="hl-1"> (</span><span class="hl-2">payload</span><span class="hl-1">) </span><span class="hl-4">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-7">const</span><span class="hl-1"> </span><span class="hl-2">user</span><span class="hl-1"> = </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-5">fetch</span><span class="hl-1">(</span><span class="hl-3">`/api/users/</span><span class="hl-4">${</span><span class="hl-2">payload</span><span class="hl-9">.</span><span class="hl-2">userId</span><span class="hl-4">}</span><span class="hl-3">`</span><span class="hl-1">).</span><span class="hl-5">then</span><span class="hl-1">(</span><span class="hl-2">r</span><span class="hl-1"> </span><span class="hl-4">=></span><span class="hl-1"> </span><span class="hl-2">r</span><span class="hl-1">.</span><span class="hl-5">json</span><span class="hl-1">());</span><br/><span class="hl-1"> </span><span class="hl-7">return</span><span class="hl-1"> </span><span class="hl-2">user</span><span class="hl-1">;</span><br/><span class="hl-1"> }}</span><br/><span class="hl-1"> </span><span class="hl-2">payload</span><span class="hl-1">={{ </span><span class="hl-20">userId</span><span class="hl-1">: </span><span class="hl-3">'42'</span><span class="hl-1"> }}</span><br/><span class="hl-1">/></span> |
| </code><button type="button">Copy</button></pre> |
|
|
| <p><code>handler</code> receives the current <code>payload</code> value, so you can use runtime context (IDs, roles, feature flags) to decide what data to load without threading props manually.</p> |
| <blockquote> |
| <p><strong>Note:</strong> <code>IOnePublicProps</code> also exposes a <code>data</code> prop as an alternative to <code>handler</code> for developers who prefer the familiar controlled-component pattern. Use either; avoid mixing both on the same <code><One /></code>.</p> |
| </blockquote> |
| <a id="reacting-to-changes-the-onchange-prop" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Reacting to changes: the <code>onChange</code> prop<a href="#reacting-to-changes-the-onchange-prop" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p><code>onChange</code> (aliased as <code>change</code> in the lower-level <code>IOneProps</code>) is called on every field change. It receives the full updated data object. Use it to sync state, auto-save, or update sibling UI.</p> |
| <pre><code class="typescript"><span class="hl-4">const</span><span class="hl-1"> [</span><span class="hl-10">formData</span><span class="hl-1">, </span><span class="hl-10">setFormData</span><span class="hl-1">] = </span><span class="hl-5">useState</span><span class="hl-1"><</span><span class="hl-7">ProfileData</span><span class="hl-1"> | </span><span class="hl-7">null</span><span class="hl-1">>(</span><span class="hl-4">null</span><span class="hl-1">);</span><br/><br/><span class="hl-1"><</span><span class="hl-2">OneTyped</span><span class="hl-1"><</span><span class="hl-2">ProfileData</span><span class="hl-1">></span><br/><span class="hl-1"> </span><span class="hl-2">fields</span><span class="hl-1">={</span><span class="hl-2">fields</span><span class="hl-1">}</span><br/><span class="hl-1"> </span><span class="hl-2">handler</span><span class="hl-1">={() => </span><span class="hl-5">fetchProfile</span><span class="hl-1">()}</span><br/><span class="hl-1"> </span><span class="hl-2">onChange</span><span class="hl-1">={(</span><span class="hl-2">data</span><span class="hl-1">, initial) => {</span><br/><span class="hl-1"> </span><span class="hl-17">// `initial` is true on the first call after handler resolves —</span><br/><span class="hl-1"> </span><span class="hl-17">// useful to skip saves triggered by loading data.</span><br/><span class="hl-1"> </span><span class="hl-0">if</span><span class="hl-1"> (!</span><span class="hl-2">initial</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-5">setFormData</span><span class="hl-1">(</span><span class="hl-2">data</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> }}</span><br/><span class="hl-1">/></span> |
| </code><button type="button">Copy</button></pre> |
|
|
| <a id="debouncing-for-server-auto-save" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Debouncing for server auto-save<a href="#debouncing-for-server-auto-save" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>For text-heavy forms you usually don't want to fire a network request on every keystroke. Use <code>fieldDebounce</code> on <code><One /></code> to delay <code>onChange</code> calls from <code>FieldType.Text</code> fields, and debounce the save logic itself on the consumer side.</p> |
| <pre><code class="typescript"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">useMemo</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">'react'</span><span class="hl-1">;</span><br/><span class="hl-0">import</span><span class="hl-1"> </span><span class="hl-2">debounce</span><span class="hl-1"> </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">'lodash/debounce'</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-10">autoSave</span><span class="hl-1"> = </span><span class="hl-5">useMemo</span><span class="hl-1">(</span><br/><span class="hl-1"> () </span><span class="hl-4">=></span><br/><span class="hl-1"> </span><span class="hl-5">debounce</span><span class="hl-1">(</span><span class="hl-4">async</span><span class="hl-1"> (</span><span class="hl-2">data</span><span class="hl-1">: </span><span class="hl-7">ProfileData</span><span class="hl-1">) </span><span class="hl-4">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-5">fetch</span><span class="hl-1">(</span><span class="hl-3">'/api/profile'</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-2">method:</span><span class="hl-1"> </span><span class="hl-3">'PUT'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">body:</span><span class="hl-1"> </span><span class="hl-10">JSON</span><span class="hl-1">.</span><span class="hl-5">stringify</span><span class="hl-1">(</span><span class="hl-2">data</span><span class="hl-1">),</span><br/><span class="hl-1"> });</span><br/><span class="hl-1"> }, </span><span class="hl-16">800</span><span class="hl-1">),</span><br/><span class="hl-1"> []</span><br/><span class="hl-1">);</span><br/><br/><span class="hl-1"><</span><span class="hl-2">OneTyped</span><span class="hl-1"><</span><span class="hl-2">ProfileData</span><span class="hl-1">></span><br/><span class="hl-1"> </span><span class="hl-2">fields</span><span class="hl-1">={</span><span class="hl-2">fields</span><span class="hl-1">}</span><br/><span class="hl-1"> </span><span class="hl-2">handler</span><span class="hl-1">={</span><span class="hl-2">fetchProfile</span><span class="hl-1">}</span><br/><span class="hl-1"> </span><span class="hl-2">fieldDebounce</span><span class="hl-1">={</span><span class="hl-16">300</span><span class="hl-1">} </span><span class="hl-17">// debounces Text field onChange internally</span><br/><span class="hl-1"> </span><span class="hl-2">onChange</span><span class="hl-1">={(</span><span class="hl-2">data</span><span class="hl-1">, initial) => {</span><br/><span class="hl-1"> </span><span class="hl-0">if</span><span class="hl-1"> (!</span><span class="hl-2">initial</span><span class="hl-1">) </span><span class="hl-5">autoSave</span><span class="hl-1">(</span><span class="hl-2">data</span><span class="hl-1">);</span><br/><span class="hl-1"> }}</span><br/><span class="hl-1">/></span> |
| </code><button type="button">Copy</button></pre> |
|
|
| <a id="passing-context-the-payload-prop" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Passing context: the <code>payload</code> prop<a href="#passing-context-the-payload-prop" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p><code>payload</code> is a stable reference object (or factory function) that flows into every field callback alongside the data object. Use it for anything that comes from outside the form itself — user permissions, route parameters, feature flags, or references to external services.</p> |
| <pre><code class="typescript"><span class="hl-4">interface</span><span class="hl-1"> </span><span class="hl-7">AppPayload</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">userRole</span><span class="hl-1">: </span><span class="hl-3">'admin'</span><span class="hl-1"> | </span><span class="hl-3">'viewer'</span><span class="hl-1">;</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-10">fields</span><span class="hl-1">: </span><span class="hl-7">TypedField</span><span class="hl-1"><</span><span class="hl-7">ProfileData</span><span class="hl-1">, </span><span class="hl-7">AppPayload</span><span class="hl-1">>[] = [</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">type:</span><span class="hl-1"> </span><span class="hl-2">FieldType</span><span class="hl-1">.</span><span class="hl-2">Text</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">name:</span><span class="hl-1"> </span><span class="hl-3">'internalNote'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">title:</span><span class="hl-1"> </span><span class="hl-3">'Internal note'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-17">// Only admins can edit this field</span><br/><span class="hl-1"> </span><span class="hl-5">isReadonly</span><span class="hl-2">:</span><span class="hl-1"> (</span><span class="hl-2">_data</span><span class="hl-1">, </span><span class="hl-2">payload</span><span class="hl-1">) </span><span class="hl-4">=></span><span class="hl-1"> </span><span class="hl-2">payload</span><span class="hl-1">.</span><span class="hl-2">userRole</span><span class="hl-1"> !== </span><span class="hl-3">'admin'</span><span class="hl-1">,</span><br/><span class="hl-1"> },</span><br/><span class="hl-1">];</span><br/><br/><span class="hl-1"><</span><span class="hl-2">OneTyped</span><span class="hl-1"><</span><span class="hl-2">ProfileData</span><span class="hl-1">, </span><span class="hl-2">AppPayload</span><span class="hl-1">></span><br/><span class="hl-1"> </span><span class="hl-2">fields</span><span class="hl-1">={</span><span class="hl-2">fields</span><span class="hl-1">}</span><br/><span class="hl-1"> </span><span class="hl-2">handler</span><span class="hl-1">={</span><span class="hl-2">fetchProfile</span><span class="hl-1">}</span><br/><span class="hl-1"> </span><span class="hl-2">payload</span><span class="hl-1">={{ </span><span class="hl-20">userRole</span><span class="hl-1">: </span><span class="hl-2">currentUser</span><span class="hl-1">.</span><span class="hl-2">role</span><span class="hl-1"> }}</span><br/><span class="hl-1">/></span> |
| </code><button type="button">Copy</button></pre> |
|
|
| <blockquote> |
| <p><strong>Warning:</strong> <code>payload</code> bypasses change detection by design — updating it does not trigger a re-render of the form tree. If you need reactive context that causes re-renders, use the <code>context</code> prop on <code><One /></code> instead.</p> |
| </blockquote> |
| <a id="per-field-state-callbacks" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Per-field state callbacks<a href="#per-field-state-callbacks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Each field can declare four callbacks that receive the current <code>data</code> object (and <code>payload</code>) and return a value describing the field's state. react-declarative re-evaluates these on every change and updates the UI automatically.</p> |
| <a id="isinvalid--blocking-validation" class="tsd-anchor"></a><h3 class="tsd-anchor-link">isInvalid — blocking validation<a href="#isinvalid--blocking-validation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Return a non-null string to mark the field invalid and display an error. Return <code>null</code> if the value is acceptable. Fields with errors prevent the <code>invalidity</code> callback on <code><One /></code> from resolving cleanly.</p> |
| <pre><code class="typescript"><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-20">type</span><span class="hl-1">: </span><span class="hl-2">FieldType</span><span class="hl-1">.</span><span class="hl-2">Text</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-20">name</span><span class="hl-1">: </span><span class="hl-3">'email'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-20">title</span><span class="hl-1">: </span><span class="hl-3">'Email'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">isInvalid</span><span class="hl-1">({ </span><span class="hl-2">email</span><span class="hl-1"> }) {</span><br/><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-10">expr</span><span class="hl-1"> =</span><span class="hl-11"> /</span><span class="hl-12">^</span><span class="hl-13">[</span><span class="hl-14">\w</span><span class="hl-11">-.</span><span class="hl-13">]</span><span class="hl-15">+</span><span class="hl-11">@</span><span class="hl-13">([</span><span class="hl-11">\w-</span><span class="hl-13">]</span><span class="hl-15">+</span><span class="hl-14">\.</span><span class="hl-13">)</span><span class="hl-15">+</span><span class="hl-13">[</span><span class="hl-11">\w-</span><span class="hl-13">]</span><span class="hl-15">{2,4}</span><span class="hl-12">$</span><span class="hl-11">/</span><span class="hl-4">g</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-0">if</span><span class="hl-1"> (!</span><span class="hl-2">expr</span><span class="hl-1">.</span><span class="hl-5">test</span><span class="hl-1">(</span><span class="hl-2">email</span><span class="hl-1">)) {</span><br/><span class="hl-1"> </span><span class="hl-0">return</span><span class="hl-1"> </span><span class="hl-3">'Invalid email address'</span><span class="hl-1">;</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> </span><span class="hl-0">return</span><span class="hl-1"> </span><span class="hl-4">null</span><span class="hl-1">;</span><br/><span class="hl-1"> },</span><br/><span class="hl-1">}</span> |
| </code><button type="button">Copy</button></pre> |
|
|
| <p><code>isInvalid</code> supports cross-field validation — the full data object is available, so you can compare two fields:</p> |
| <pre><code class="typescript"><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-20">type</span><span class="hl-1">: </span><span class="hl-2">FieldType</span><span class="hl-1">.</span><span class="hl-2">Text</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-20">name</span><span class="hl-1">: </span><span class="hl-3">'to'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-20">title</span><span class="hl-1">: </span><span class="hl-3">'To'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-20">isInvalid</span><span class="hl-1">: ({ </span><span class="hl-2">from</span><span class="hl-1">, </span><span class="hl-2">to</span><span class="hl-1"> }) </span><span class="hl-4">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">if</span><span class="hl-1"> (</span><span class="hl-2">from</span><span class="hl-1"> && </span><span class="hl-2">to</span><span class="hl-1"> && </span><span class="hl-5">parseInt</span><span class="hl-1">(</span><span class="hl-2">from</span><span class="hl-1">) > </span><span class="hl-5">parseInt</span><span class="hl-1">(</span><span class="hl-2">to</span><span class="hl-1">)) {</span><br/><span class="hl-1"> </span><span class="hl-0">return</span><span class="hl-1"> </span><span class="hl-3">'Must be greater than "From"'</span><span class="hl-1">;</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> </span><span class="hl-0">return</span><span class="hl-1"> </span><span class="hl-4">null</span><span class="hl-1">;</span><br/><span class="hl-1"> },</span><br/><span class="hl-1">}</span> |
| </code><button type="button">Copy</button></pre> |
|
|
| <a id="isincorrect--non-blocking-validation" class="tsd-anchor"></a><h3 class="tsd-anchor-link">isIncorrect — non-blocking validation<a href="#isincorrect--non-blocking-validation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Like <code>isInvalid</code>, but returning a string shows a warning indicator in the UI without blocking form submission. Use it for spell-check style hints that don't prevent saving.</p> |
| <pre><code class="typescript"><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-20">type</span><span class="hl-1">: </span><span class="hl-2">FieldType</span><span class="hl-1">.</span><span class="hl-2">Text</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-20">name</span><span class="hl-1">: </span><span class="hl-3">'username'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-20">title</span><span class="hl-1">: </span><span class="hl-3">'Username'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">isIncorrect</span><span class="hl-1">({ </span><span class="hl-2">username</span><span class="hl-1"> }) {</span><br/><span class="hl-1"> </span><span class="hl-0">if</span><span class="hl-1"> (</span><span class="hl-2">username</span><span class="hl-1"> && </span><span class="hl-2">username</span><span class="hl-1">.</span><span class="hl-2">length</span><span class="hl-1"> < </span><span class="hl-16">4</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-0">return</span><span class="hl-1"> </span><span class="hl-3">'Usernames shorter than 4 characters are not recommended'</span><span class="hl-1">;</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> </span><span class="hl-0">return</span><span class="hl-1"> </span><span class="hl-4">null</span><span class="hl-1">;</span><br/><span class="hl-1"> },</span><br/><span class="hl-1">}</span> |
| </code><button type="button">Copy</button></pre> |
|
|
| <a id="isvisible--show-or-hide-a-field" class="tsd-anchor"></a><h3 class="tsd-anchor-link">isVisible — show or hide a field<a href="#isvisible--show-or-hide-a-field" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Return <code>false</code> to remove the field from the DOM entirely. The field's value is still present in the data object even when hidden.</p> |
| <pre><code class="typescript"><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-20">type</span><span class="hl-1">: </span><span class="hl-2">FieldType</span><span class="hl-1">.</span><span class="hl-2">Text</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-20">name</span><span class="hl-1">: </span><span class="hl-3">'companyName'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-20">title</span><span class="hl-1">: </span><span class="hl-3">'Company name'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-20">isVisible</span><span class="hl-1">: ({ </span><span class="hl-2">accountType</span><span class="hl-1"> }) </span><span class="hl-4">=></span><span class="hl-1"> </span><span class="hl-2">accountType</span><span class="hl-1"> === </span><span class="hl-3">'business'</span><span class="hl-1">,</span><br/><span class="hl-1">}</span> |
| </code><button type="button">Copy</button></pre> |
|
|
| <a id="isdisabled--prevent-interaction" class="tsd-anchor"></a><h3 class="tsd-anchor-link">isDisabled — prevent interaction<a href="#isdisabled--prevent-interaction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Return <code>true</code> to render the field in a disabled state. The value is still readable but cannot be changed by the user.</p> |
| <pre><code class="typescript"><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-20">type</span><span class="hl-1">: </span><span class="hl-2">FieldType</span><span class="hl-1">.</span><span class="hl-2">Text</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-20">name</span><span class="hl-1">: </span><span class="hl-3">'email'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-20">title</span><span class="hl-1">: </span><span class="hl-3">'Email'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-20">isDisabled</span><span class="hl-1">: ({ </span><span class="hl-2">locked</span><span class="hl-1"> }) </span><span class="hl-4">=></span><span class="hl-1"> </span><span class="hl-5">Boolean</span><span class="hl-1">(</span><span class="hl-2">locked</span><span class="hl-1">),</span><br/><span class="hl-1">}</span> |
| </code><button type="button">Copy</button></pre> |
|
|
| <a id="isreadonly--display-without-edit" class="tsd-anchor"></a><h3 class="tsd-anchor-link">isReadonly — display without edit<a href="#isreadonly--display-without-edit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Return <code>true</code> to render the field in read-only mode. Unlike <code>isDisabled</code>, the value is still visually styled as an active field but cannot be edited.</p> |
| <pre><code class="typescript"><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-20">type</span><span class="hl-1">: </span><span class="hl-2">FieldType</span><span class="hl-1">.</span><span class="hl-2">Text</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-20">name</span><span class="hl-1">: </span><span class="hl-3">'createdAt'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-20">title</span><span class="hl-1">: </span><span class="hl-3">'Created at'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-20">isReadonly</span><span class="hl-1">: () </span><span class="hl-4">=></span><span class="hl-1"> </span><span class="hl-4">true</span><span class="hl-1">,</span><br/><span class="hl-1">}</span> |
| </code><button type="button">Copy</button></pre> |
|
|
| <a id="computed-values-with-compute" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Computed values with <code>compute</code><a href="#computed-values-with-compute" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>The <code>compute</code> prop derives a field's display value from the data object each render. A field with <code>compute</code> is automatically read-only, because its value is never stored in the data object directly.</p> |
| <pre><code class="typescript"><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-10">fields</span><span class="hl-1">: </span><span class="hl-7">TypedField</span><span class="hl-1">[] = [</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">type:</span><span class="hl-1"> </span><span class="hl-2">FieldType</span><span class="hl-1">.</span><span class="hl-2">Text</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">name:</span><span class="hl-1"> </span><span class="hl-3">'firstName'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">title:</span><span class="hl-1"> </span><span class="hl-3">'First name'</span><span class="hl-1">,</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">type:</span><span class="hl-1"> </span><span class="hl-2">FieldType</span><span class="hl-1">.</span><span class="hl-2">Text</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">name:</span><span class="hl-1"> </span><span class="hl-3">'lastName'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">title:</span><span class="hl-1"> </span><span class="hl-3">'Last name'</span><span class="hl-1">,</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">type:</span><span class="hl-1"> </span><span class="hl-2">FieldType</span><span class="hl-1">.</span><span class="hl-2">Text</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">name:</span><span class="hl-1"> </span><span class="hl-3">'fullName'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">title:</span><span class="hl-1"> </span><span class="hl-3">'Full name (computed)'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-17">// Always shows "firstName lastName", never stored separately</span><br/><span class="hl-1"> </span><span class="hl-5">compute</span><span class="hl-2">:</span><span class="hl-1"> ({ </span><span class="hl-2">firstName</span><span class="hl-1">, </span><span class="hl-2">lastName</span><span class="hl-1"> }) </span><span class="hl-4">=></span><br/><span class="hl-1"> [</span><span class="hl-2">firstName</span><span class="hl-1">, </span><span class="hl-2">lastName</span><span class="hl-1">].</span><span class="hl-5">filter</span><span class="hl-1">(</span><span class="hl-2">Boolean</span><span class="hl-1">).</span><span class="hl-5">join</span><span class="hl-1">(</span><span class="hl-3">' '</span><span class="hl-1">),</span><br/><span class="hl-1"> },</span><br/><span class="hl-1">];</span> |
| </code><button type="button">Copy</button></pre> |
|
|
| <a id="default-values-vs-handler-loaded-data" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Default values vs handler-loaded data<a href="#default-values-vs-handler-loaded-data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p><code>defaultValue</code> at the field level and <code>handler</code>-loaded data are two separate mechanisms that interact in a specific order:</p> |
| <ol> |
| <li><strong>handler runs</strong> — <code><One /></code> calls your <code>handler</code> function and awaits the result. The returned object becomes the initial data.</li> |
| <li><strong>defaultValue fills gaps</strong> — For each field that has a <code>defaultValue</code>, if the resolved data object has <code>null</code>, <code>undefined</code>, or is missing that key, the <code>defaultValue</code> is used instead.</li> |
| <li><strong>First onChange fires</strong> — <code>onChange</code> is called once with <code>initial: true</code> to reflect the merged initial state. This gives you the fully resolved starting data.</li> |
| </ol> |
| <pre><code class="typescript"><span class="hl-17">// If handler returns { firstName: 'Jane' } and the schema has:</span><br/><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-20">type</span><span class="hl-1">: </span><span class="hl-2">FieldType</span><span class="hl-1">.</span><span class="hl-2">Text</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-20">name</span><span class="hl-1">: </span><span class="hl-3">'role'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-20">defaultValue</span><span class="hl-1">: </span><span class="hl-3">'viewer'</span><span class="hl-1">, </span><span class="hl-17">// used because handler didn't supply 'role'</span><br/><span class="hl-1">},</span><br/><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-20">type</span><span class="hl-1">: </span><span class="hl-2">FieldType</span><span class="hl-1">.</span><span class="hl-2">Text</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-20">name</span><span class="hl-1">: </span><span class="hl-3">'firstName'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-20">defaultValue</span><span class="hl-1">: </span><span class="hl-3">'Unknown'</span><span class="hl-1">, </span><span class="hl-17">// NOT used — handler already supplied 'Jane'</span><br/><span class="hl-1">},</span> |
| </code><button type="button">Copy</button></pre> |
|
|
| <p><code>defaultValue</code> can also be a function that receives <code>payload</code>, which is useful when the default depends on runtime context:</p> |
| <pre><code class="typescript"><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-20">type</span><span class="hl-1">: </span><span class="hl-2">FieldType</span><span class="hl-1">.</span><span class="hl-2">Text</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-20">name</span><span class="hl-1">: </span><span class="hl-3">'assignee'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-20">defaultValue</span><span class="hl-1">: (</span><span class="hl-2">payload</span><span class="hl-1">) </span><span class="hl-4">=></span><span class="hl-1"> </span><span class="hl-2">payload</span><span class="hl-1">.</span><span class="hl-2">currentUsername</span><span class="hl-1">,</span><br/><span class="hl-1">}</span> |
| </code><button type="button">Copy</button></pre> |
|
|
| <a id="full-example-a-self-validating-form-with-auto-save" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Full example: a self-validating form with auto-save<a href="#full-example-a-self-validating-form-with-auto-save" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><pre><code class="typescript"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">useState</span><span class="hl-1">, </span><span class="hl-2">useMemo</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">'react'</span><span class="hl-1">;</span><br/><span class="hl-0">import</span><span class="hl-1"> </span><span class="hl-2">debounce</span><span class="hl-1"> </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">'lodash/debounce'</span><span class="hl-1">;</span><br/><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">OneTyped</span><span class="hl-1">, </span><span class="hl-2">TypedField</span><span class="hl-1">, </span><span class="hl-2">FieldType</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">'react-declarative'</span><span class="hl-1">;</span><br/><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">Email</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">'@mui/icons-material'</span><span class="hl-1">;</span><br/><br/><span class="hl-4">interface</span><span class="hl-1"> </span><span class="hl-7">ProfileData</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">firstName</span><span class="hl-1">: </span><span class="hl-7">string</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-2">lastName</span><span class="hl-1">: </span><span class="hl-7">string</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-2">email</span><span class="hl-1">: </span><span class="hl-7">string</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-2">role</span><span class="hl-1">: </span><span class="hl-7">string</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-2">visible</span><span class="hl-1">: </span><span class="hl-7">boolean</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-2">disabled</span><span class="hl-1">: </span><span class="hl-7">boolean</span><span class="hl-1">;</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-4">interface</span><span class="hl-1"> </span><span class="hl-7">AppPayload</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">userId</span><span class="hl-1">: </span><span class="hl-7">string</span><span class="hl-1">;</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-10">fields</span><span class="hl-1">: </span><span class="hl-7">TypedField</span><span class="hl-1"><</span><span class="hl-7">ProfileData</span><span class="hl-1">, </span><span class="hl-7">AppPayload</span><span class="hl-1">>[] = [</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">type:</span><span class="hl-1"> </span><span class="hl-2">FieldType</span><span class="hl-1">.</span><span class="hl-2">Text</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">name:</span><span class="hl-1"> </span><span class="hl-3">'firstName'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">title:</span><span class="hl-1"> </span><span class="hl-3">'First name'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">columns:</span><span class="hl-1"> </span><span class="hl-3">'6'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">isDisabled</span><span class="hl-2">:</span><span class="hl-1"> ({ </span><span class="hl-2">disabled</span><span class="hl-1"> }) </span><span class="hl-4">=></span><span class="hl-1"> </span><span class="hl-2">disabled</span><span class="hl-1">,</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">type:</span><span class="hl-1"> </span><span class="hl-2">FieldType</span><span class="hl-1">.</span><span class="hl-2">Text</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">name:</span><span class="hl-1"> </span><span class="hl-3">'lastName'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">title:</span><span class="hl-1"> </span><span class="hl-3">'Last name'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">columns:</span><span class="hl-1"> </span><span class="hl-3">'6'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">isDisabled</span><span class="hl-2">:</span><span class="hl-1"> ({ </span><span class="hl-2">disabled</span><span class="hl-1"> }) </span><span class="hl-4">=></span><span class="hl-1"> </span><span class="hl-2">disabled</span><span class="hl-1">,</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">type:</span><span class="hl-1"> </span><span class="hl-2">FieldType</span><span class="hl-1">.</span><span class="hl-2">Text</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">name:</span><span class="hl-1"> </span><span class="hl-3">'email'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">title:</span><span class="hl-1"> </span><span class="hl-3">'Email'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">inputType:</span><span class="hl-1"> </span><span class="hl-3">'email'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">trailingIcon:</span><span class="hl-1"> </span><span class="hl-2">Email</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">isVisible</span><span class="hl-2">:</span><span class="hl-1"> ({ </span><span class="hl-2">visible</span><span class="hl-1"> }) </span><span class="hl-4">=></span><span class="hl-1"> </span><span class="hl-2">visible</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">isInvalid</span><span class="hl-2">:</span><span class="hl-1"> ({ </span><span class="hl-2">email</span><span class="hl-1"> }) </span><span class="hl-4">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">if</span><span class="hl-1"> (!</span><span class="hl-2">email</span><span class="hl-1">) </span><span class="hl-0">return</span><span class="hl-1"> </span><span class="hl-3">'Email is required'</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-0">if</span><span class="hl-1"> (!</span><span class="hl-11">/</span><span class="hl-12">^</span><span class="hl-13">[^</span><span class="hl-11">\s@</span><span class="hl-13">]</span><span class="hl-15">+</span><span class="hl-11">@</span><span class="hl-13">[^</span><span class="hl-11">\s@</span><span class="hl-13">]</span><span class="hl-15">+</span><span class="hl-14">\.</span><span class="hl-13">[^</span><span class="hl-11">\s@</span><span class="hl-13">]</span><span class="hl-15">+</span><span class="hl-12">$</span><span class="hl-11">/</span><span class="hl-1">.</span><span class="hl-5">test</span><span class="hl-1">(</span><span class="hl-2">email</span><span class="hl-1">)) </span><span class="hl-0">return</span><span class="hl-1"> </span><span class="hl-3">'Invalid email'</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-0">return</span><span class="hl-1"> </span><span class="hl-4">null</span><span class="hl-1">;</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">type:</span><span class="hl-1"> </span><span class="hl-2">FieldType</span><span class="hl-1">.</span><span class="hl-2">Expansion</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">title:</span><span class="hl-1"> </span><span class="hl-3">'Debug controls'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">fields:</span><span class="hl-1"> [</span><br/><span class="hl-1"> { </span><span class="hl-2">type:</span><span class="hl-1"> </span><span class="hl-2">FieldType</span><span class="hl-1">.</span><span class="hl-2">Switch</span><span class="hl-1">, </span><span class="hl-2">name:</span><span class="hl-1"> </span><span class="hl-3">'visible'</span><span class="hl-1">, </span><span class="hl-2">title:</span><span class="hl-1"> </span><span class="hl-3">'Show email field'</span><span class="hl-1">, </span><span class="hl-2">defaultValue:</span><span class="hl-1"> </span><span class="hl-4">true</span><span class="hl-1"> },</span><br/><span class="hl-1"> { </span><span class="hl-2">type:</span><span class="hl-1"> </span><span class="hl-2">FieldType</span><span class="hl-1">.</span><span class="hl-2">Switch</span><span class="hl-1">, </span><span class="hl-2">name:</span><span class="hl-1"> </span><span class="hl-3">'disabled'</span><span class="hl-1">, </span><span class="hl-2">title:</span><span class="hl-1"> </span><span class="hl-3">'Disable name fields'</span><span class="hl-1"> },</span><br/><span class="hl-1"> ],</span><br/><span class="hl-1"> },</span><br/><span class="hl-1">];</span><br/><br/><span class="hl-0">export</span><span class="hl-1"> </span><span class="hl-4">function</span><span class="hl-1"> </span><span class="hl-5">ProfileForm</span><span class="hl-1">({ </span><span class="hl-2">userId</span><span class="hl-1"> }: { </span><span class="hl-2">userId</span><span class="hl-1">: </span><span class="hl-7">string</span><span class="hl-1"> }) {</span><br/><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> [</span><span class="hl-10">saved</span><span class="hl-1">, </span><span class="hl-10">setSaved</span><span class="hl-1">] = </span><span class="hl-5">useState</span><span class="hl-1">(</span><span class="hl-4">false</span><span class="hl-1">);</span><br/><br/><span class="hl-1"> </span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-10">autoSave</span><span class="hl-1"> = </span><span class="hl-5">useMemo</span><span class="hl-1">(</span><br/><span class="hl-1"> () </span><span class="hl-4">=></span><br/><span class="hl-1"> </span><span class="hl-5">debounce</span><span class="hl-1">(</span><span class="hl-4">async</span><span class="hl-1"> (</span><span class="hl-2">data</span><span class="hl-1">: </span><span class="hl-7">ProfileData</span><span class="hl-1">) </span><span class="hl-4">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-5">fetch</span><span class="hl-1">(</span><span class="hl-3">`/api/users/</span><span class="hl-4">${</span><span class="hl-2">userId</span><span class="hl-4">}</span><span class="hl-3">`</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-2">method:</span><span class="hl-1"> </span><span class="hl-3">'PUT'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">body:</span><span class="hl-1"> </span><span class="hl-10">JSON</span><span class="hl-1">.</span><span class="hl-5">stringify</span><span class="hl-1">(</span><span class="hl-2">data</span><span class="hl-1">),</span><br/><span class="hl-1"> });</span><br/><span class="hl-1"> </span><span class="hl-5">setSaved</span><span class="hl-1">(</span><span class="hl-4">true</span><span class="hl-1">);</span><br/><span class="hl-1"> }, </span><span class="hl-16">600</span><span class="hl-1">),</span><br/><span class="hl-1"> [</span><span class="hl-2">userId</span><span class="hl-1">]</span><br/><span class="hl-1"> );</span><br/><br/><span class="hl-1"> </span><span class="hl-0">return</span><span class="hl-1"> (</span><br/><span class="hl-1"> <</span><span class="hl-2">OneTyped</span><span class="hl-1"><</span><span class="hl-2">ProfileData</span><span class="hl-1">, </span><span class="hl-2">AppPayload</span><span class="hl-1">></span><br/><span class="hl-1"> </span><span class="hl-2">fields</span><span class="hl-1">={</span><span class="hl-2">fields</span><span class="hl-1">}</span><br/><span class="hl-1"> </span><span class="hl-2">handler</span><span class="hl-1">={</span><span class="hl-5">async</span><span class="hl-1"> ({ </span><span class="hl-2">userId</span><span class="hl-1"> }) </span><span class="hl-4">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-7">const</span><span class="hl-1"> </span><span class="hl-2">res</span><span class="hl-1"> = </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-5">fetch</span><span class="hl-1">(</span><span class="hl-3">`/api/users/</span><span class="hl-4">${</span><span class="hl-2">userId</span><span class="hl-4">}</span><span class="hl-3">`</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-7">return</span><span class="hl-1"> </span><span class="hl-7">res</span><span class="hl-1">.</span><span class="hl-7">json</span><span class="hl-1">();</span><br/><span class="hl-1"> }}</span><br/><span class="hl-1"> </span><span class="hl-2">payload</span><span class="hl-1">={{ </span><span class="hl-2">userId</span><span class="hl-1"> }}</span><br/><span class="hl-1"> </span><span class="hl-2">fieldDebounce</span><span class="hl-1">={</span><span class="hl-16">300</span><span class="hl-1">}</span><br/><span class="hl-1"> </span><span class="hl-2">onChange</span><span class="hl-1">={(</span><span class="hl-2">data</span><span class="hl-1">, initial) => {</span><br/><span class="hl-1"> </span><span class="hl-0">if</span><span class="hl-1"> (!</span><span class="hl-2">initial</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-5">setSaved</span><span class="hl-1">(</span><span class="hl-4">false</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-5">autoSave</span><span class="hl-1">(</span><span class="hl-2">data</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> }}</span><br/><span class="hl-1"> /></span><br/><span class="hl-1"> );</span><br/><span class="hl-1">}</span> |
| </code><button type="button">Copy</button></pre> |
|
|
| </div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#how-react-declarative-manages-form-state-for-you"><span>How react-<wbr/>declarative manages form state for you</span></a><ul><li><a href="#loading-initial-data-the-handler-prop"><span>Loading initial data: the handler prop</span></a></li><li><a href="#reacting-to-changes-the-onchange-prop"><span>Reacting to changes: the on<wbr/>Change prop</span></a></li><li><ul><li><a href="#debouncing-for-server-auto-save"><span>Debouncing for server auto-<wbr/>save</span></a></li></ul></li><li><a href="#passing-context-the-payload-prop"><span>Passing context: the payload prop</span></a></li><li><a href="#per-field-state-callbacks"><span>Per-<wbr/>field state callbacks</span></a></li><li><ul><li><a href="#isinvalid--blocking-validation"><span>is<wbr/>Invalid — blocking validation</span></a></li><li><a href="#isincorrect--non-blocking-validation"><span>is<wbr/>Incorrect — non-<wbr/>blocking validation</span></a></li><li><a href="#isvisible--show-or-hide-a-field"><span>is<wbr/>Visible — show or hide a field</span></a></li><li><a href="#isdisabled--prevent-interaction"><span>is<wbr/>Disabled — prevent interaction</span></a></li><li><a href="#isreadonly--display-without-edit"><span>is<wbr/>Readonly — display without edit</span></a></li></ul></li><li><a href="#computed-values-with-compute"><span>Computed values with compute</span></a></li><li><a href="#default-values-vs-handler-loaded-data"><span>Default values vs handler-<wbr/>loaded data</span></a></li><li><a href="#full-example-a-self-validating-form-with-auto-save"><span>Full example: a self-<wbr/>validating form with auto-<wbr/>save</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">react-declarative</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> |
|
|
