Skip to content

Commit 9a7342f

Browse files
committed
[docs] Minor typo
1 parent eb87bc3 commit 9a7342f

File tree

6 files changed

+6
-6
lines changed

6 files changed

+6
-6
lines changed

docs/api/all.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10697,7 +10697,7 @@
1069710697
getSliceComponentProps<span class="operator">?</span><span class="operator">:</span> <span class="punctuation">(</span>sliceId<span class="operator">:</span> <span class="builtin">string</span><span class="punctuation">)</span><span class="operator">:</span> <span class="type"><a href="#/api/ui-react/type-aliases/props/extraprops/">ExtraProps</a></span><span class="punctuation">;</span>
1069810698
separator<span class="operator">?</span><span class="operator">:</span> ReactElement <span class="operator">|</span> <span class="builtin">string</span><span class="punctuation">;</span>
1069910699
debugIds<span class="operator">?</span><span class="operator">:</span> <span class="builtin">boolean</span><span class="punctuation">;</span>
10700-
<span class="punctuation">}</span></code></pre><div class="table"><table><tr><th></th><th>Type</th><th>Description</th></tr><tr><th><code>indexId</code></th><td><code><span class="type"><a href="#/api/common/type-aliases/identity/id/">Id</a></span></code></td><td><p>The <a href="#/api/common/type-aliases/identity/id/"><code>Id</code></a> of the <a href="#/api/indexes/type-aliases/concept/index/"><code>Index</code></a> in the <a href="#/api/indexes/interfaces/indexes/indexes/"><code>Indexes</code></a> object to be rendered.</p></td></tr><tr><th><code>indexes<span class="operator">?</span></code></th><td><code><span class="type"><a href="#/api/ui-react/type-aliases/identity/indexesorindexesid/">IndexesOrIndexesId</a></span></code></td><td><p>The <a href="#/api/indexes/interfaces/indexes/indexes/"><code>Indexes</code></a> object to be accessed: omit for the default context <a href="#/api/indexes/interfaces/indexes/indexes/"><code>Indexes</code></a> object, provide an <a href="#/api/common/type-aliases/identity/id/"><code>Id</code></a> for a named context <a href="#/api/indexes/interfaces/indexes/indexes/"><code>Indexes</code></a> object, or provide an explicit reference.</p></td></tr><tr><th><code>sliceComponent<span class="operator">?</span></code></th><td><code>ComponentType<span class="operator">&lt;</span><span class="type"><a href="#/api/ui-react/type-aliases/props/sliceprops/">SliceProps</a></span><span class="operator">></span></code></td><td><p>A component for rendering each <a href="#/api/indexes/type-aliases/concept/slice/"><code>Slice</code></a> in the <a href="#/api/indexes/type-aliases/concept/index/"><code>Index</code></a>.</p></td></tr><tr><th><code>getSliceComponentProps<span class="operator">?</span></code></th><td><code><span class="function">getSliceComponentProps</span><span class="punctuation">(</span>sliceId<span class="operator">:</span> <span class="builtin">string</span><span class="punctuation">)</span><span class="operator">:</span> <span class="type"><a href="#/api/ui-react/type-aliases/props/extraprops/">ExtraProps</a></span></code></td><td><p>A function for generating extra props for each <a href="#/api/indexes/type-aliases/concept/slice/"><code>Slice</code></a> component based on its <a href="#/api/common/type-aliases/identity/id/"><code>Id</code></a>.</p></td></tr><tr><th><code>separator<span class="operator">?</span></code></th><td><code>ReactElement <span class="operator">|</span> <span class="builtin">string</span></code></td><td><p>A component or string to separate each <a href="#/api/indexes/type-aliases/concept/slice/"><code>Slice</code></a> component.</p></td></tr><tr><th><code>debugIds<span class="operator">?</span></code></th><td><code><span class="builtin">boolean</span></code></td><td><p>Whether the component should also render the <a href="#/api/common/type-aliases/identity/id/"><code>Id</code></a> of the <a href="#/api/indexes/type-aliases/concept/index/"><code>Index</code></a>, and its descendent objects, to assist with debugging.</p></td></tr></table></div></section><section class="s5" id="/api/ui-react/type-aliases/props/sliceprops/" data-id="SP"><h5><code>SliceProps</code></h5><p><a href="#/api/ui-react/type-aliases/props/indexprops/"><code>IndexProps</code></a> props are used for components that refer to a single <a href="#/api/indexes/type-aliases/concept/slice/"><code>Slice</code></a> in an <a href="#/api/indexes/type-aliases/concept/index/"><code>Index</code></a> object, such as the <a href="#/api/ui-react/functions/indexes-components/sliceview/"><code>SliceView</code></a> component.</p><pre><code><span class="punctuation">{</span>
10700+
<span class="punctuation">}</span></code></pre><div class="table"><table><tr><th></th><th>Type</th><th>Description</th></tr><tr><th><code>indexId</code></th><td><code><span class="type"><a href="#/api/common/type-aliases/identity/id/">Id</a></span></code></td><td><p>The <a href="#/api/common/type-aliases/identity/id/"><code>Id</code></a> of the <a href="#/api/indexes/type-aliases/concept/index/"><code>Index</code></a> in the <a href="#/api/indexes/interfaces/indexes/indexes/"><code>Indexes</code></a> object to be rendered.</p></td></tr><tr><th><code>indexes<span class="operator">?</span></code></th><td><code><span class="type"><a href="#/api/ui-react/type-aliases/identity/indexesorindexesid/">IndexesOrIndexesId</a></span></code></td><td><p>The <a href="#/api/indexes/interfaces/indexes/indexes/"><code>Indexes</code></a> object to be accessed: omit for the default context <a href="#/api/indexes/interfaces/indexes/indexes/"><code>Indexes</code></a> object, provide an <a href="#/api/common/type-aliases/identity/id/"><code>Id</code></a> for a named context <a href="#/api/indexes/interfaces/indexes/indexes/"><code>Indexes</code></a> object, or provide an explicit reference.</p></td></tr><tr><th><code>sliceComponent<span class="operator">?</span></code></th><td><code>ComponentType<span class="operator">&lt;</span><span class="type"><a href="#/api/ui-react/type-aliases/props/sliceprops/">SliceProps</a></span><span class="operator">></span></code></td><td><p>A component for rendering each <a href="#/api/indexes/type-aliases/concept/slice/"><code>Slice</code></a> in the <a href="#/api/indexes/type-aliases/concept/index/"><code>Index</code></a>.</p></td></tr><tr><th><code>getSliceComponentProps<span class="operator">?</span></code></th><td><code><span class="function">getSliceComponentProps</span><span class="punctuation">(</span>sliceId<span class="operator">:</span> <span class="builtin">string</span><span class="punctuation">)</span><span class="operator">:</span> <span class="type"><a href="#/api/ui-react/type-aliases/props/extraprops/">ExtraProps</a></span></code></td><td><p>A function for generating extra props for each <a href="#/api/indexes/type-aliases/concept/slice/"><code>Slice</code></a> component based on its <a href="#/api/common/type-aliases/identity/id/"><code>Id</code></a>.</p></td></tr><tr><th><code>separator<span class="operator">?</span></code></th><td><code>ReactElement <span class="operator">|</span> <span class="builtin">string</span></code></td><td><p>A component or string to separate each <a href="#/api/indexes/type-aliases/concept/slice/"><code>Slice</code></a> component.</p></td></tr><tr><th><code>debugIds<span class="operator">?</span></code></th><td><code><span class="builtin">boolean</span></code></td><td><p>Whether the component should also render the <a href="#/api/common/type-aliases/identity/id/"><code>Id</code></a> of the <a href="#/api/indexes/type-aliases/concept/index/"><code>Index</code></a>, and its descendent objects, to assist with debugging.</p></td></tr></table></div></section><section class="s5" id="/api/ui-react/type-aliases/props/sliceprops/" data-id="SP"><h5><code>SliceProps</code></h5><p><code>SliceProps</code> props are used for components that refer to a single <a href="#/api/indexes/type-aliases/concept/slice/"><code>Slice</code></a> in an <a href="#/api/indexes/type-aliases/concept/index/"><code>Index</code></a> object, such as the <a href="#/api/ui-react/functions/indexes-components/sliceview/"><code>SliceView</code></a> component.</p><pre><code><span class="punctuation">{</span>
1070110701
indexId<span class="operator">:</span> <span class="type"><a href="#/api/common/type-aliases/identity/id/">Id</a></span><span class="punctuation">;</span>
1070210702
sliceId<span class="operator">:</span> <span class="type"><a href="#/api/common/type-aliases/identity/id/">Id</a></span><span class="punctuation">;</span>
1070310703
indexes<span class="operator">?</span><span class="operator">:</span> <span class="type"><a href="#/api/ui-react/type-aliases/identity/indexesorindexesid/">IndexesOrIndexesId</a></span><span class="punctuation">;</span>

0 commit comments

Comments
 (0)