Skip to content

Commit 97da063

Browse files
committed
[docs] Tweaks
1 parent b02e826 commit 97da063

11 files changed

Lines changed: 317 additions & 370 deletions

File tree

docs/api/all.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34954,7 +34954,7 @@
3495434954
position<span class="operator">?</span><span class="operator">:</span> <span class="string">"top"</span> <span class="operator">|</span> <span class="string">"right"</span> <span class="operator">|</span> <span class="string">"bottom"</span> <span class="operator">|</span> <span class="string">"left"</span> <span class="operator">|</span> <span class="string">"full"</span><span class="punctuation">;</span>
3495534955
open<span class="operator">?</span><span class="operator">:</span> <span class="builtin">boolean</span><span class="punctuation">;</span>
3495634956
hue<span class="operator">?</span><span class="operator">:</span> <span class="builtin">number</span><span class="punctuation">;</span>
34957-
<span class="punctuation">}</span></code></pre><div class="table"><table><tr><th></th><th>Type</th><th>Description</th></tr><tr><th><code>position<span class="operator">?</span></code></th><td><code><span class="string">"top"</span> <span class="operator">|</span> <span class="string">"right"</span> <span class="operator">|</span> <span class="string">"bottom"</span> <span class="operator">|</span> <span class="string">"left"</span> <span class="operator">|</span> <span class="string">"full"</span></code></td><td><p>An optional string to indicate where you want the inspector to first appear.</p></td></tr><tr><th><code>open<span class="operator">?</span></code></th><td><code><span class="builtin">boolean</span></code></td><td><p>An optional boolean to indicate whether the inspector should start in the opened state.</p></td></tr><tr><th><code>hue<span class="operator">?</span></code></th><td><code><span class="builtin">number</span></code></td><td><p>An optional number to indicate the hue of the inspector&#x27;s UI, defaulting to 270.</p></td></tr></table></div><section class="s5"><h5>Since</h5><p>v5.0.0</p></section></section></section></section><section class="s2" id="/api/ui-svelte/" data-id="u4"><h2><code>ui-svelte</code></h2><p>The <code>ui-svelte</code> module of the TinyBase project provides both hooks 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 hooks 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. Hooks register listeners such that components using those hooks re-render when data changes.</p><p>Hook parameters accept either plain values or reactive getter functions (<code>[</code>MaybeGetter<code>](#/api/ui-svelte/type-aliases/identity/maybegetter/)&lt;T&gt; = T | (() =&gt; T)</code>), so passing <code>() =&gt; tableId</code> from a <code>let</code>-bound Svelte prop makes the hook re-execute whenever the prop changes.</p><p>The components in this module provide a further abstraction over those hooks to ease the composition of user interfaces that use TinyBase.</p><section class="s3"><h3>See also</h3><p><a href="#/guides/building-uis/building-uis-with-svelte/">Building UIs With Svelte</a> guide</p></section><section class="s3"><h3>Since</h3><p>v8.1.0</p></section><section class="s3" id="/api/ui-svelte/functions/" data-id="u4/F50"><h3>Functions</h3><section class="s4" id="/api/ui-svelte/functions/component/" data-id="u4/F50/C101"><h4>Component functions</h4><section class="s5" id="/api/ui-svelte/functions/component/tablesview/" data-id="TV3"><h5><code>TablesView</code></h5><pre><code><span class="function"><a href="#/api/ui-react/functions/store-components/tablesview/">TablesView</a></span><span class="punctuation">(</span>
34957+
<span class="punctuation">}</span></code></pre><div class="table"><table><tr><th></th><th>Type</th><th>Description</th></tr><tr><th><code>position<span class="operator">?</span></code></th><td><code><span class="string">"top"</span> <span class="operator">|</span> <span class="string">"right"</span> <span class="operator">|</span> <span class="string">"bottom"</span> <span class="operator">|</span> <span class="string">"left"</span> <span class="operator">|</span> <span class="string">"full"</span></code></td><td><p>An optional string to indicate where you want the inspector to first appear.</p></td></tr><tr><th><code>open<span class="operator">?</span></code></th><td><code><span class="builtin">boolean</span></code></td><td><p>An optional boolean to indicate whether the inspector should start in the opened state.</p></td></tr><tr><th><code>hue<span class="operator">?</span></code></th><td><code><span class="builtin">number</span></code></td><td><p>An optional number to indicate the hue of the inspector&#x27;s UI, defaulting to 270.</p></td></tr></table></div><section class="s5"><h5>Since</h5><p>v5.0.0</p></section></section></section></section><section class="s2" id="/api/ui-svelte/" data-id="u4"><h2><code>ui-svelte</code></h2><p>The <code>ui-svelte</code> module of the TinyBase project provides both hooks 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 hooks 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. Hooks register listeners such that components using those hooks re-render when data changes.</p><p>Hook parameters accept either plain values or reactive getter functions (see 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 hook re-execute whenever the prop changes.</p><p>The components in this module provide a further abstraction over those hooks to ease the composition of user interfaces that use TinyBase.</p><section class="s3"><h3>See also</h3><p><a href="#/guides/building-uis/building-uis-with-svelte/">Building UIs With Svelte</a> guide</p></section><section class="s3"><h3>Since</h3><p>v8.1.0</p></section><section class="s3" id="/api/ui-svelte/functions/" data-id="u4/F50"><h3>Functions</h3><section class="s4" id="/api/ui-svelte/functions/component/" data-id="u4/F50/C101"><h4>Component functions</h4><section class="s5" id="/api/ui-svelte/functions/component/tablesview/" data-id="TV3"><h5><code>TablesView</code></h5><pre><code><span class="function"><a href="#/api/ui-react/functions/store-components/tablesview/">TablesView</a></span><span class="punctuation">(</span>
3495834958
<span class="keyword">this</span><span class="operator">:</span> <span class="keyword">void</span><span class="punctuation">,</span>
3495934959
internals<span class="operator">:</span> Brand<span class="operator">&lt;</span><span class="string">"ComponentInternals"</span><span class="operator">></span><span class="punctuation">,</span>
3496034960
props<span class="operator">:</span> <span class="type"><a href="#/api/ui-svelte/type-aliases/props/tablesviewprops/">TablesViewProps</a></span><span class="punctuation">,</span>

docs/api/ui-svelte/article.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +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 both hooks 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 hooks 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. Hooks register listeners such that components using those hooks re-render when data changes.</p><p>Hook parameters accept either plain values or reactive getter functions (<code>[</code>MaybeGetter<code>](/api/ui-svelte/type-aliases/identity/maybegetter/)&lt;T&gt; = T | (() =&gt; T)</code>), so passing <code>() =&gt; tableId</code> from a <code>let</code>-bound Svelte prop makes the hook re-execute whenever the prop changes.</p><p>The components in this module provide a further abstraction over those hooks to ease the composition of user interfaces that use TinyBase.</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/component/">Component functions</a></li><li><a href="/api/ui-svelte/functions/hook/">Hook 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>
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 both hooks 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 hooks 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. Hooks register listeners such that components using those hooks re-render when data changes.</p><p>Hook parameters accept either plain values or reactive getter functions (see 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 hook re-execute whenever the prop changes.</p><p>The components in this module provide a further abstraction over those hooks to ease the composition of user interfaces that use TinyBase.</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/component/">Component functions</a></li><li><a href="/api/ui-svelte/functions/hook/">Hook 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>

0 commit comments

Comments
 (0)