[docs] Bump

Author: jamesgpearce

docs/api/all.html

@@ -1 +1 @@
-<nav><ul><li><a href="/">TinyBase</a></li><li><a href="/api/">API</a></li><li><a href="/api/ui-svelte/"><code>ui-svelte</code></a></li></ul></nav><section class="s1" id="/api/ui-svelte/" data-id="u4"><h1><code>ui-svelte</code></h1><p>The <code>ui-svelte</code> module of the TinyBase project provides reactive functions, listener functions, and components to make it easy to create reactive Svelte 5 apps with <a href="/api/the-essentials/creating-stores/store/"><code>Store</code></a> objects.</p><p>The reactive functions in this module provide access to the data and structures exposed by other modules in the project. They return reactive objects with a <code>current</code> property. Those functions register listeners such that components using them re-render when data changes.</p><p>Functions like the <a href="/api/ui-svelte/functions/getter/getstore/"><code>getStore</code></a> function and <a href="/api/ui-svelte/functions/getter/getmetrics/"><code>getMetrics</code></a> function return TinyBase objects directly from Provider context. Functions like the <a href="/api/ui-svelte/functions/getter/getcell/"><code>getCell</code></a> function, the <a href="/api/ui-svelte/functions/getter/getrow/"><code>getRow</code></a> function, the <a href="/api/ui-svelte/functions/getter/gettable/"><code>getTable</code></a> function, the <a href="/api/ui-svelte/functions/getter/getvalue/"><code>getValue</code></a> function, and the <a href="/api/ui-svelte/functions/getter/hascell/"><code>hasCell</code></a> function return reactive objects whose <code>current</code> property reflects underlying TinyBase data.</p><p>Function parameters accept either plain values or reactive getter functions (as per the <a href="/api/ui-svelte/type-aliases/identity/maybegetter/"><code>MaybeGetter</code></a> type), so passing <code>() =&gt; tableId</code> from a <code>let</code>-bound Svelte prop makes the function re-execute whenever the prop changes.</p><section class="s2"><h2>See also</h2><p><a href="/guides/building-uis/building-uis-with-svelte/">Building UIs With Svelte</a> guide</p></section><section class="s2"><h2>Since</h2><p>v8.1.0</p></section><section class="s2" id="/api/ui-svelte/functions/" data-id="u4/F50"><h2>Functions</h2><ul><li><a href="/api/ui-svelte/functions/getter/">Getter functions</a></li><li><a href="/api/ui-svelte/functions/listener/">Listener functions</a></li><li><a href="/api/ui-svelte/functions/callback/">Callback functions</a></li><li><a href="/api/ui-svelte/functions/component/">Component functions</a></li><li><a href="/api/ui-svelte/functions/provider/">Provider functions</a></li></ul></section><section class="s2" id="/api/ui-svelte/type-aliases/" data-id="u4/TA27"><h2>Type Aliases</h2><ul><li><a href="/api/ui-svelte/type-aliases/identity/">Identity type aliases</a></li><li><a href="/api/ui-svelte/type-aliases/props/">Props type aliases</a></li></ul></section></section>
+<nav><ul><li><a href="/">TinyBase</a></li><li><a href="/api/">API</a></li><li><a href="/api/ui-svelte/"><code>ui-svelte</code></a></li></ul></nav><section class="s1" id="/api/ui-svelte/" data-id="u4"><h1><code>ui-svelte</code></h1><p>The <code>ui-svelte</code> module of the TinyBase project provides reactive functions, listener functions, and components to make it easy to create reactive Svelte 5 apps with <a href="/api/the-essentials/creating-stores/store/"><code>Store</code></a> objects.</p><p>The reactive functions in this module provide access to the data and structures exposed by other modules in the project. They return reactive objects with a <code>current</code> property. Those functions register listeners such that components using them re-render when data changes.</p><p>The components in this module provide a further abstraction over those reactive functions, and use Svelte snippet props to customize rendering in an idiomatic way.</p><p>Functions like the <a href="/api/ui-svelte/functions/getter/getstore/"><code>getStore</code></a> function and <a href="/api/ui-svelte/functions/getter/getmetrics/"><code>getMetrics</code></a> function return TinyBase objects directly from Provider context. Functions like the <a href="/api/ui-svelte/functions/getter/getcell/"><code>getCell</code></a> function, the <a href="/api/ui-svelte/functions/getter/getrow/"><code>getRow</code></a> function, the <a href="/api/ui-svelte/functions/getter/gettable/"><code>getTable</code></a> function, the <a href="/api/ui-svelte/functions/getter/getvalue/"><code>getValue</code></a> function, and the <a href="/api/ui-svelte/functions/getter/hascell/"><code>hasCell</code></a> function return reactive objects whose <code>current</code> property reflects underlying TinyBase data.</p><p>Function parameters accept either plain values or reactive getter functions (as per the <a href="/api/ui-svelte/type-aliases/identity/maybegetter/"><code>MaybeGetter</code></a> type), so passing <code>() =&gt; tableId</code> from a <code>let</code>-bound Svelte prop makes the function re-execute whenever the prop changes.</p><section class="s2"><h2>See also</h2><p><a href="/guides/building-uis/building-uis-with-svelte/">Building UIs With Svelte</a> guide</p></section><section class="s2"><h2>Since</h2><p>v8.1.0</p></section><section class="s2" id="/api/ui-svelte/functions/" data-id="u4/F50"><h2>Functions</h2><ul><li><a href="/api/ui-svelte/functions/getter/">Getter functions</a></li><li><a href="/api/ui-svelte/functions/listener/">Listener functions</a></li><li><a href="/api/ui-svelte/functions/callback/">Callback functions</a></li><li><a href="/api/ui-svelte/functions/component/">Component functions</a></li><li><a href="/api/ui-svelte/functions/provider/">Provider functions</a></li></ul></section><section class="s2" id="/api/ui-svelte/type-aliases/" data-id="u4/TA27"><h2>Type Aliases</h2><ul><li><a href="/api/ui-svelte/type-aliases/identity/">Identity type aliases</a></li><li><a href="/api/ui-svelte/type-aliases/props/">Props type aliases</a></li></ul></section></section>

docs/api/ui-svelte/article.html

@@ -5,7 +5,7 @@
 <span class="punctuation">)</span><span class="operator">:</span> <span class="punctuation">{</span>
   $on<span class="operator">?</span><span class="operator">:</span> <span class="punctuation">(</span>type<span class="operator">:</span> <span class="builtin">string</span><span class="punctuation">,</span> <span class="function-variable">callback</span><span class="operator">:</span> <span class="punctuation">(</span>e<span class="operator">:</span> <span class="builtin">any</span><span class="punctuation">)</span> <span class="operator">=></span> <span class="keyword">void</span><span class="punctuation">)</span><span class="operator">:</span> <span class="punctuation">(</span><span class="punctuation">)</span> <span class="operator">=></span> <span class="keyword">void</span><span class="punctuation">;</span>
   $set<span class="operator">?</span><span class="operator">:</span> <span class="punctuation">(</span>props<span class="operator">:</span> Partial<span class="operator">&lt;</span><span class="type"><a href="/api/ui-svelte/type-aliases/props/providerprops/">ProviderProps</a></span><span class="operator">></span><span class="punctuation">)</span><span class="operator">:</span> <span class="keyword">void</span><span class="punctuation">;</span>
-<span class="punctuation">}</span></code></pre><div class="table"><table><tr><th></th><th>Type</th><th>Description</th></tr><tr><th><code><span class="keyword">this</span></code></th><td><code><span class="keyword">void</span></code></td><td></td></tr><tr><th><code>internals</code></th><td><code>Brand<span class="operator">&lt;</span><span class="string">"ComponentInternals"</span><span class="operator">></span></code></td><td></td></tr><tr><th><code>props</code></th><td><code><span class="type"><a href="/api/ui-svelte/type-aliases/props/providerprops/">ProviderProps</a></span></code></td><td><p>The props passed to the component.</p></td></tr><tr><th class="right">returns</th><td><code><span class="punctuation">{</span> $on<span class="operator">?</span><span class="operator">:</span> <span class="punctuation">(</span>type<span class="operator">:</span> <span class="builtin">string</span><span class="punctuation">,</span> <span class="function-variable">callback</span><span class="operator">:</span> <span class="punctuation">(</span>e<span class="operator">:</span> <span class="builtin">any</span><span class="punctuation">)</span> <span class="operator">=></span> <span class="keyword">void</span><span class="punctuation">)</span><span class="operator">:</span> <span class="punctuation">(</span><span class="punctuation">)</span> <span class="operator">=></span> <span class="keyword">void</span><span class="punctuation">;</span> $set<span class="operator">?</span><span class="operator">:</span> <span class="punctuation">(</span>props<span class="operator">:</span> Partial<span class="operator">&lt;</span><span class="type"><a href="/api/ui-svelte/type-aliases/props/providerprops/">ProviderProps</a></span><span class="operator">></span><span class="punctuation">)</span><span class="operator">:</span> <span class="keyword">void</span><span class="punctuation">;</span> <span class="punctuation">}</span></code></td><td><p></p></td></tr></table></div><p><a href="/api/the-essentials/creating-stores/store/"><code>Store</code></a> objects, <a href="/api/metrics/interfaces/metrics/metrics/"><code>Metrics</code></a>, <a href="/api/indexes/interfaces/indexes/indexes/"><code>Indexes</code></a>, <a href="/api/relationships/interfaces/relationships/relationships/"><code>Relationships</code></a>, <a href="/api/queries/interfaces/queries/queries/"><code>Queries</code></a>, <a href="/api/checkpoints/interfaces/checkpoints/checkpoints/"><code>Checkpoints</code></a>, Persisters, and Synchronizers can all be provided both as single defaults and as named instances in a <code>*ById</code> map.</p><section class="s2"><h2>Example</h2><p>This example creates a Provider context with a default <a href="/api/the-essentials/creating-stores/store/"><code>Store</code></a>.</p><pre><code><span class="comment">// In a .svelte file:</span>
+<span class="punctuation">}</span></code></pre><div class="table"><table><tr><th></th><th>Type</th><th>Description</th></tr><tr><th><code><span class="keyword">this</span></code></th><td><code><span class="keyword">void</span></code></td><td></td></tr><tr><th><code>internals</code></th><td><code>Brand<span class="operator">&lt;</span><span class="string">"ComponentInternals"</span><span class="operator">></span></code></td><td></td></tr><tr><th><code>props</code></th><td><code><span class="type"><a href="/api/ui-svelte/type-aliases/props/providerprops/">ProviderProps</a></span></code></td><td><p>The props passed to the component.</p></td></tr><tr><th class="right">returns</th><td><code><span class="punctuation">{</span> $on<span class="operator">?</span><span class="operator">:</span> <span class="punctuation">(</span>type<span class="operator">:</span> <span class="builtin">string</span><span class="punctuation">,</span> <span class="function-variable">callback</span><span class="operator">:</span> <span class="punctuation">(</span>e<span class="operator">:</span> <span class="builtin">any</span><span class="punctuation">)</span> <span class="operator">=></span> <span class="keyword">void</span><span class="punctuation">)</span><span class="operator">:</span> <span class="punctuation">(</span><span class="punctuation">)</span> <span class="operator">=></span> <span class="keyword">void</span><span class="punctuation">;</span> $set<span class="operator">?</span><span class="operator">:</span> <span class="punctuation">(</span>props<span class="operator">:</span> Partial<span class="operator">&lt;</span><span class="type"><a href="/api/ui-svelte/type-aliases/props/providerprops/">ProviderProps</a></span><span class="operator">></span><span class="punctuation">)</span><span class="operator">:</span> <span class="keyword">void</span><span class="punctuation">;</span> <span class="punctuation">}</span></code></td><td><p></p></td></tr></table></div><p><a href="/api/the-essentials/creating-stores/store/"><code>Store</code></a> objects, <a href="/api/metrics/interfaces/metrics/metrics/"><code>Metrics</code></a>, <a href="/api/indexes/interfaces/indexes/indexes/"><code>Indexes</code></a>, <a href="/api/relationships/interfaces/relationships/relationships/"><code>Relationships</code></a>, <a href="/api/queries/interfaces/queries/queries/"><code>Queries</code></a>, <a href="/api/checkpoints/interfaces/checkpoints/checkpoints/"><code>Checkpoints</code></a>, Persisters, and Synchronizers can all be provided both as single defaults and as named instances in a <code>*ById</code> map.</p><p><code>Provider</code> components can be nested and their contexts are merged, so outer defaults and named instances remain visible unless a nearer Provider replaces them.</p><section class="s2"><h2>Example</h2><p>This example creates a Provider context with a default <a href="/api/the-essentials/creating-stores/store/"><code>Store</code></a>.</p><pre><code><span class="comment">// In a .svelte file:</span>
 <span class="comment">// &lt;Provider store={createStore()}></span>
 <span class="comment">//   &lt;App /></span>
 <span class="comment">// &lt;/Provider></span>