Deploying to docs from @ 5d5b172 🚀

playableprints · Feb 3, 2024 · 6112717 · 6112717
1 parent d48f744
commit 6112717
Show file tree

Hide file tree

Showing 36 changed files with 258 additions and 254 deletions.
diff --git a/assets/search.js b/assets/search.js
diff --git a/classes/_playableprints_lothlorien.SortedTree.html b/classes/_playableprints_lothlorien.SortedTree.html
diff --git a/classes/_playableprints_lothlorien.Tree.html b/classes/_playableprints_lothlorien.Tree.html
diff --git a/functions/_playableprints_lothlorien.treeutil.buildBranches.html b/functions/_playableprints_lothlorien.treeutil.buildBranches.html
diff --git a/functions/_playableprints_lothlorien.treeutil.deconstructPaths.html b/functions/_playableprints_lothlorien.treeutil.deconstructPaths.html
diff --git a/functions/_playableprints_lothlorien.treeutil.dirname.html b/functions/_playableprints_lothlorien.treeutil.dirname.html
diff --git a/functions/_playableprints_lothlorien.treeutil.getTree.html b/functions/_playableprints_lothlorien.treeutil.getTree.html
diff --git a/functions/_playableprints_lothlorien_react.DepthMarker.html b/functions/_playableprints_lothlorien_react.DepthMarker.html
diff --git a/functions/_playableprints_lothlorien_react.LazyTreeView.html b/functions/_playableprints_lothlorien_react.LazyTreeView.html
diff --git a/functions/_playableprints_lothlorien_react.TreeView.html b/functions/_playableprints_lothlorien_react.TreeView.html
diff --git a/functions/_playableprints_lothlorien_react.useFoldControls.html b/functions/_playableprints_lothlorien_react.useFoldControls.html
diff --git a/functions/_playableprints_lothlorien_react.useFoldState.html b/functions/_playableprints_lothlorien_react.useFoldState.html
diff --git a/functions/_playableprints_lothlorien_react.useSortedTree.html b/functions/_playableprints_lothlorien_react.useSortedTree.html
diff --git a/functions/_playableprints_lothlorien_react.useTree.html b/functions/_playableprints_lothlorien_react.useTree.html
diff --git a/interfaces/_playableprints_lothlorien_react.DepthMarkerProps.html b/interfaces/_playableprints_lothlorien_react.DepthMarkerProps.html
diff --git a/interfaces/_playableprints_lothlorien_react.LazyTreeViewProps.html b/interfaces/_playableprints_lothlorien_react.LazyTreeViewProps.html
diff --git a/interfaces/_playableprints_lothlorien_react.TreeFoldControls.html b/interfaces/_playableprints_lothlorien_react.TreeFoldControls.html
diff --git a/interfaces/_playableprints_lothlorien_react.TreeNodeComponent.html b/interfaces/_playableprints_lothlorien_react.TreeNodeComponent.html
@@ -1,7 +1,7 @@
 <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>TreeNodeComponent | Lothlorien</title><meta name="description" content="Documentation for Lothlorien"/><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/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><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"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://github.com/playableprints/lothlorien">Github</a></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">Lothlorien</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"><use href="#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="../index.html">Lothlorien</a></li><li><a href="../modules/_playableprints_lothlorien_react.html">@playableprints/lothlorien-react</a></li><li><a href="_playableprints_lothlorien_react.TreeNodeComponent.html">TreeNodeComponent</a></li></ul><h1>Interface TreeNodeComponent&lt;T&gt;</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A component helper type to define what a TreeView takes as a node renderer</p>
 </div><div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1"> </span><span class="hl-5">type</span><span class="hl-1"> </span><span class="hl-9">MyPayload</span><span class="hl-1"> = {</span><br/><span class="hl-1">     </span><span class="hl-0">name</span><span class="hl-1">: </span><span class="hl-9">string</span><br/><span class="hl-1"> };</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">MyNodeRenderer</span><span class="hl-1">: </span><span class="hl-9">TreeNodeComponent</span><span class="hl-1">&lt;</span><span class="hl-9">SortedTree</span><span class="hl-1">&lt;</span><span class="hl-9">MyPayload</span><span class="hl-1">&gt;&gt; = ({ </span><span class="hl-0">nodeKey</span><span class="hl-1">, </span><span class="hl-0">value</span><span class="hl-1">, </span><span class="hl-0">childKeys</span><span class="hl-1"> }) </span><span class="hl-5">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1">    </span><span class="hl-2">return</span><span class="hl-1"> (&lt;&gt;</span><br/><span class="hl-1">         &lt;</span><span class="hl-9">div</span><span class="hl-1">&gt;{value.</span><span class="hl-0">name</span><span class="hl-1">}&lt;/</span><span class="hl-0">div</span><span class="hl-1">&gt;</span><br/><span class="hl-1">     &lt;/&gt;)</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-7">App</span><span class="hl-1"> = () </span><span class="hl-5">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1">     </span><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">myTree</span><span class="hl-1"> = </span><span class="hl-7">useSortedTree</span><span class="hl-1">&lt;</span><span class="hl-9">MyPayload</span><span class="hl-1">&gt;();</span><br/><span class="hl-1">     </span><span class="hl-2">return</span><span class="hl-1"> &lt;</span><span class="hl-9">TreeView</span><span class="hl-1"> </span><span class="hl-9">value</span><span class="hl-1">={</span><span class="hl-0">myTree</span><span class="hl-1">} </span><span class="hl-9">renderer</span><span class="hl-1">={</span><span class="hl-0">MyNodeRenderer</span><span class="hl-1">} /&gt;</span><br/><span class="hl-1">}</span>
 </code><button>Copy</button></pre>
-</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">TreeNodeComponent</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_playableprints_lothlorien_react.TreeNodeComponent.html#T">T</a><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="_playableprints_lothlorien_react.TreeNodeComponent.html#contextTypes">contextTypes</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ValidationMap</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_playableprints_lothlorien_react.TreeNodeComponent.html#defaultProps">defaultProps</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="_playableprints_lothlorien_react.TreeNodeComponentProps.html" class="tsd-signature-type tsd-kind-interface">TreeNodeComponentProps</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_playableprints_lothlorien_react.TreeNodeComponent.html#T">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_playableprints_lothlorien_react.TreeNodeComponent.html#displayName">displayName</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_playableprints_lothlorien_react.TreeNodeComponent.html#propTypes">propTypes</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">WeakValidationMap</span><span class="tsd-signature-symbol">&lt;</span><a href="_playableprints_lothlorien_react.TreeNodeComponentProps.html" class="tsd-signature-type tsd-kind-interface">TreeNodeComponentProps</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_playableprints_lothlorien_react.TreeNodeComponent.html#T">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><h4><a id="T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-keyword"> extends </span><a href="../classes/_playableprints_lothlorien.Tree.html" class="tsd-signature-type tsd-kind-class">Tree</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section> <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/playableprints/lothlorien/blob/458eefa/packages/lothlorien-react/src/util.tsx#L53">packages/lothlorien-react/src/util.tsx:53</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="_playableprints_lothlorien_react.TreeNodeComponent.html#contextTypes" class="tsd-index-link deprecated tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>context<wbr/>Types?</span></a>
+</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">TreeNodeComponent</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_playableprints_lothlorien_react.TreeNodeComponent.html#T">T</a><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="_playableprints_lothlorien_react.TreeNodeComponent.html#contextTypes">contextTypes</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ValidationMap</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_playableprints_lothlorien_react.TreeNodeComponent.html#defaultProps">defaultProps</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="_playableprints_lothlorien_react.TreeNodeComponentProps.html" class="tsd-signature-type tsd-kind-interface">TreeNodeComponentProps</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_playableprints_lothlorien_react.TreeNodeComponent.html#T">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_playableprints_lothlorien_react.TreeNodeComponent.html#displayName">displayName</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_playableprints_lothlorien_react.TreeNodeComponent.html#propTypes">propTypes</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">WeakValidationMap</span><span class="tsd-signature-symbol">&lt;</span><a href="_playableprints_lothlorien_react.TreeNodeComponentProps.html" class="tsd-signature-type tsd-kind-interface">TreeNodeComponentProps</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_playableprints_lothlorien_react.TreeNodeComponent.html#T">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><h4><a id="T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-keyword"> extends </span><a href="../classes/_playableprints_lothlorien.Tree.html" class="tsd-signature-type tsd-kind-class">Tree</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section> <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/playableprints/lothlorien/blob/5d5b172/packages/lothlorien-react/src/util.tsx#L57">packages/lothlorien-react/src/util.tsx:57</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="_playableprints_lothlorien_react.TreeNodeComponent.html#contextTypes" class="tsd-index-link deprecated tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>context<wbr/>Types?</span></a>
 <a href="_playableprints_lothlorien_react.TreeNodeComponent.html#defaultProps" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>default<wbr/>Props?</span></a>
 <a href="_playableprints_lothlorien_react.TreeNodeComponent.html#displayName" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>display<wbr/>Name?</span></a>
 <a href="_playableprints_lothlorien_react.TreeNodeComponent.html#propTypes" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>prop<wbr/>Types?</span></a>