@aptre/flex-layout 0.3.0 → 0.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +1 -1
- package/dist/index.d.ts +1 -0
- package/dist/index.mjs +44 -9
- package/dist/model/walk.d.ts +18 -0
- package/package.json +6 -5
- package/typedoc/assets/hierarchy.js +1 -1
- package/typedoc/assets/main.js +4 -4
- package/typedoc/assets/navigation.js +1 -1
- package/typedoc/assets/search.js +1 -1
- package/typedoc/assets/style.css +6 -6
- package/typedoc/classes/BorderNode.html +1 -1
- package/typedoc/classes/Layout.html +45 -44
- package/typedoc/classes/Node.html +1 -1
- package/typedoc/classes/RowNode.html +1 -1
- package/typedoc/classes/TabNode.html +1 -1
- package/typedoc/classes/TabSetNode.html +1 -1
- package/typedoc/functions/findJsonNodeById.html +5 -0
- package/typedoc/functions/walkJsonModel.html +6 -0
- package/typedoc/hierarchy.html +1 -1
- package/typedoc/index.html +1 -1
- package/typedoc/interfaces/IBorderAttributes.html +1 -1
- package/typedoc/interfaces/IJsonBorderNode.html +1 -1
- package/typedoc/interfaces/IJsonRowNode.html +1 -1
- package/typedoc/interfaces/IJsonTabNode.html +1 -1
- package/typedoc/interfaces/IJsonTabSetNode.html +1 -1
- package/typedoc/interfaces/IRowAttributes.html +1 -1
- package/typedoc/interfaces/ITabAttributes.html +1 -1
- package/typedoc/interfaces/ITabSetAttributes.html +1 -1
- package/typedoc/types/DragRectRenderCallback.html +1 -1
- package/typedoc/types/JsonNode.html +1 -0
- package/typedoc/types/ModelVisitor.html +1 -0
- package/typedoc/types/NodeMouseEvent.html +1 -1
- package/typedoc/types/ShowOverflowMenuCallback.html +1 -1
- package/typedoc/types/TabSetPlaceHolderCallback.html +1 -1
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Layout | @aptre/flex-layout</title><meta name="description" content="Documentation for @aptre/flex-layout"/><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"><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">@aptre/flex-layout</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="../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="../index.html">@aptre/flex-layout</a></li><li><a href="Layout.html">Layout</a></li></ul><h1>Class Layout</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A React component that hosts a multi-tabbed layout</p>
|
|
2
2
|
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy" data-refl="56"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-signature-type">Component</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ILayoutProps.html" class="tsd-signature-type tsd-kind-interface">ILayoutProps</a><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">Layout</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-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="../assets/icons.svg#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="Layout.html#context" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>context</span></a>
|
|
3
3
|
<a href="Layout.html#props" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>props</span></a>
|
|
4
|
-
<a href="Layout.html#refs" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>refs</span></a>
|
|
5
4
|
<a href="Layout.html#state" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>state</span></a>
|
|
6
5
|
<a href="Layout.html#contexttype" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>context<wbr/>Type?</span></a>
|
|
6
|
+
<a href="Layout.html#proptypes" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prop<wbr/>Types?</span></a>
|
|
7
7
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="Layout.html#addtabtoactivetabset" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Tab<wbr/>To<wbr/>Active<wbr/>Tab<wbr/>Set</span></a>
|
|
8
8
|
<a href="Layout.html#addtabtotabset" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Tab<wbr/>To<wbr/>Tab<wbr/>Set</span></a>
|
|
9
9
|
<a href="Layout.html#addtabwithdraganddrop" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Tab<wbr/>With<wbr/>Drag<wbr/>And<wbr/>Drop</span></a>
|
|
@@ -32,13 +32,14 @@ Should be used with type annotation or static contextType.</p>
|
|
|
32
32
|
</code><button type="button">Copy</button></pre>
|
|
33
33
|
|
|
34
34
|
</div><div class="tsd-tag-see"><h4 class="tsd-anchor-link"><a id="see" class="tsd-anchor"></a>See<a href="#see" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://react.dev/reference/react/Component#context">React Docs</a></p>
|
|
35
|
-
</div></div><aside class="tsd-sources"><p>Inherited from React.Component.context</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="props" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>props</span><a href="#props" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">props</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ILayoutProps.html" class="tsd-signature-type tsd-kind-interface">ILayoutProps</a><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from React.Component.props</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="
|
|
36
|
-
</div></div><aside class="tsd-sources"><p>Inherited from React.Component.refs</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="state" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>state</span><a href="#state" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">state</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from React.Component.state</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="contexttype" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code> <code class="tsd-tag">Optional</code><span>context<wbr/>Type</span><a href="#contexttype" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">contextType</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Context</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>If set, <code>this.context</code> will be set at runtime to the current value of the given Context.</p>
|
|
35
|
+
</div></div><aside class="tsd-sources"><p>Inherited from React.Component.context</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="props" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>props</span><a href="#props" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">props</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ILayoutProps.html" class="tsd-signature-type tsd-kind-interface">ILayoutProps</a><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from React.Component.props</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="state" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>state</span><a href="#state" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">state</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from React.Component.state</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="contexttype" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code> <code class="tsd-tag">Optional</code><span>context<wbr/>Type</span><a href="#contexttype" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">contextType</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Context</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>If set, <code>this.context</code> will be set at runtime to the current value of the given Context.</p>
|
|
37
36
|
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example-1" class="tsd-anchor"></a>Example<a href="#example-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">type</span><span class="hl-1"> </span><span class="hl-5">MyContext</span><span class="hl-1"> = </span><span class="hl-5">number</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">Ctx</span><span class="hl-1"> = </span><span class="hl-0">React</span><span class="hl-1">.</span><span class="hl-7">createContext</span><span class="hl-1"><</span><span class="hl-5">MyContext</span><span class="hl-1">>(</span><span class="hl-8">0</span><span class="hl-1">)</span><br/><br/><span class="hl-3">class</span><span class="hl-1"> </span><span class="hl-5">Foo</span><span class="hl-1"> </span><span class="hl-3">extends</span><span class="hl-1"> </span><span class="hl-5">React</span><span class="hl-1">.</span><span class="hl-5">Component</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-3">static</span><span class="hl-1"> </span><span class="hl-0">contextType</span><span class="hl-1"> = </span><span class="hl-0">Ctx</span><br/><span class="hl-1"> </span><span class="hl-0">context</span><span class="hl-1">!: </span><span class="hl-5">React</span><span class="hl-1">.</span><span class="hl-5">ContextType</span><span class="hl-1"><</span><span class="hl-3">typeof</span><span class="hl-1"> </span><span class="hl-0">Ctx</span><span class="hl-1">></span><br/><span class="hl-1"> </span><span class="hl-7">render</span><span class="hl-1"> () {</span><br/><span class="hl-1"> </span><span class="hl-9">return</span><span class="hl-1"> <></span><span class="hl-0">My</span><span class="hl-1"> </span><span class="hl-0">context</span><span class="hl-10">'s value: {this.context}</></span><span class="hl-11">;</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
|
|
38
37
|
</code><button type="button">Copy</button></pre>
|
|
39
38
|
|
|
40
|
-
</div><div class="tsd-tag-see"><h4 class="tsd-anchor-link"><a id="see-
|
|
41
|
-
</div></div><aside class="tsd-sources"><p>Inherited from React.Component.contextType</p></aside></section
|
|
39
|
+
</div><div class="tsd-tag-see"><h4 class="tsd-anchor-link"><a id="see-1" class="tsd-anchor"></a>See<a href="#see-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://react.dev/reference/react/Component#static-contexttype">https://react.dev/reference/react/Component#static-contexttype</a></p>
|
|
40
|
+
</div></div><aside class="tsd-sources"><p>Inherited from React.Component.contextType</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="proptypes" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code> <code class="tsd-tag">Optional</code><span class="deprecated">prop<wbr/>Types</span><a href="#proptypes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">propTypes</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><div class="tsd-comment tsd-typography"><p>Ignored by React.</p>
|
|
41
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link"><a id="deprecated" class="tsd-anchor"></a>Deprecated<a href="#deprecated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Only kept in types for backwards compatibility. Will be removed in a future major release.</p>
|
|
42
|
+
</div></div><aside class="tsd-sources"><p>Inherited from React.Component.propTypes</p></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="addtabtoactivetabset" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Tab<wbr/>To<wbr/>Active<wbr/>Tab<wbr/>Set</span><a href="#addtabtoactivetabset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="addtabtoactivetabset-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">addTabToActiveTabSet</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">json</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/IJsonTabNode.html" class="tsd-signature-type tsd-kind-interface">IJsonTabNode</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <a href="TabNode.html" class="tsd-signature-type tsd-kind-class">TabNode</a><a href="#addtabtoactivetabset-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds a new tab to the active tabset (if there is one)</p>
|
|
42
43
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">json</span>: <a href="../interfaces/IJsonTabNode.html" class="tsd-signature-type tsd-kind-interface">IJsonTabNode</a></span><div class="tsd-comment tsd-typography"><p>the json for the new tab node</p>
|
|
43
44
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <a href="TabNode.html" class="tsd-signature-type tsd-kind-class">TabNode</a></h4><p>the added tab node or undefined</p>
|
|
44
45
|
<div class="tsd-comment tsd-typography"></div></li></ul></section><section class="tsd-panel tsd-member"><a id="addtabtotabset" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Tab<wbr/>To<wbr/>Tab<wbr/>Set</span><a href="#addtabtotabset" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="addtabtotabset-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">addTabToTabSet</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">tabsetId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">json</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/IJsonTabNode.html" class="tsd-signature-type tsd-kind-interface">IJsonTabNode</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <a href="TabNode.html" class="tsd-signature-type tsd-kind-class">TabNode</a><a href="#addtabtotabset-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds a new tab to the given tabset</p>
|
|
@@ -56,44 +57,44 @@ the entire component tree to unmount.</p>
|
|
|
56
57
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">Error</span></span></li><li><span><span class="tsd-kind-parameter">errorInfo</span>: <span class="tsd-signature-type">ErrorInfo</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from React.Component.componentDidCatch</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="componentdidmount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>component<wbr/>Did<wbr/>Mount</span><a href="#componentdidmount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="componentdidmount-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">componentDidMount</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#componentdidmount-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Called immediately after a component is mounted. Setting state here will trigger re-rendering.</p>
|
|
57
58
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from React.Component.componentDidMount</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="componentdidupdate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>component<wbr/>Did<wbr/>Update</span><a href="#componentdidupdate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="componentdidupdate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">componentDidUpdate</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">prevProps</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ILayoutProps.html" class="tsd-signature-type tsd-kind-interface">ILayoutProps</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">prevState</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">snapshot</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#componentdidupdate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Called immediately after updating occurs. Not called for the initial render.</p>
|
|
58
59
|
<p>The snapshot is only present if <a href="Layout.html#getsnapshotbeforeupdate" class="tsd-kind-method">getSnapshotBeforeUpdate</a> is present and returns non-null.</p>
|
|
59
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">prevProps</span>: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ILayoutProps.html" class="tsd-signature-type tsd-kind-interface">ILayoutProps</a><span class="tsd-signature-symbol">></span></span></li><li><span><span class="tsd-kind-parameter">prevState</span>: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">snapshot</span>: <span class="tsd-signature-type">any</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from React.Component.componentDidUpdate</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="componentwillmount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span class="deprecated">component<wbr/>Will<wbr/>Mount</span><a href="#componentwillmount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="componentwillmount-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">componentWillMount</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#componentwillmount-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Called immediately before mounting occurs, and before Component.render
|
|
60
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">prevProps</span>: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ILayoutProps.html" class="tsd-signature-type tsd-kind-interface">ILayoutProps</a><span class="tsd-signature-symbol">></span></span></li><li><span><span class="tsd-kind-parameter">prevState</span>: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">snapshot</span>: <span class="tsd-signature-type">any</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from React.Component.componentDidUpdate</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="componentwillmount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span class="deprecated">component<wbr/>Will<wbr/>Mount</span><a href="#componentwillmount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="componentwillmount-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">componentWillMount</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#componentwillmount-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Called immediately before mounting occurs, and before <a href="undefined">Component.render</a>.
|
|
60
61
|
Avoid introducing any side-effects or subscriptions in this method.</p>
|
|
61
|
-
<p>Note: the presence of NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate
|
|
62
|
-
or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents
|
|
62
|
+
<p>Note: the presence of <a href="undefined">NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate</a>
|
|
63
|
+
or <a href="undefined">StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps</a> prevents
|
|
63
64
|
this from being invoked.</p>
|
|
64
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link"><a id="deprecated-1" class="tsd-anchor"></a>Deprecated<a href="#deprecated-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>16.3, use ComponentLifecycle.componentDidMount componentDidMount or the constructor instead; will stop working in React 17</p>
|
|
65
|
-
</div><div class="tsd-tag-see"><h4 class="tsd-anchor-link"><a id="see-
|
|
65
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link"><a id="deprecated-1" class="tsd-anchor"></a>Deprecated<a href="#deprecated-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>16.3, use <a href="undefined">ComponentLifecycle.componentDidMount componentDidMount</a> or the constructor instead; will stop working in React 17</p>
|
|
66
|
+
</div><div class="tsd-tag-see"><h4 class="tsd-anchor-link"><a id="see-2" class="tsd-anchor"></a>See<a href="#see-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><ul>
|
|
66
67
|
<li><a href="https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state">https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</a></li>
|
|
67
68
|
<li><a href="https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path">https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</a></li>
|
|
68
69
|
</ul>
|
|
69
|
-
</div></div><aside class="tsd-sources"><p>Inherited from React.Component.componentWillMount</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="componentwillreceiveprops" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span class="deprecated">component<wbr/>Will<wbr/>Receive<wbr/>Props</span><a href="#componentwillreceiveprops" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="componentwillreceiveprops-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">componentWillReceiveProps</span><span class="tsd-signature-symbol">(</span><
|
|
70
|
+
</div></div><aside class="tsd-sources"><p>Inherited from React.Component.componentWillMount</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="componentwillreceiveprops" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span class="deprecated">component<wbr/>Will<wbr/>Receive<wbr/>Props</span><a href="#componentwillreceiveprops" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="componentwillreceiveprops-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">componentWillReceiveProps</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">nextProps</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ILayoutProps.html" class="tsd-signature-type tsd-kind-interface">ILayoutProps</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#componentwillreceiveprops-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Called when the component may be receiving new props.
|
|
70
71
|
React may call this even if props have not changed, so be sure to compare new and existing
|
|
71
72
|
props if you only want to handle changes.</p>
|
|
72
|
-
<p>Calling Component.setState generally does not trigger this method.</p>
|
|
73
|
-
<p>Note: the presence of NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate
|
|
74
|
-
or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents
|
|
73
|
+
<p>Calling <a href="undefined">Component.setState</a> generally does not trigger this method.</p>
|
|
74
|
+
<p>Note: the presence of <a href="undefined">NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate</a>
|
|
75
|
+
or <a href="undefined">StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps</a> prevents
|
|
75
76
|
this from being invoked.</p>
|
|
76
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">nextProps</span>: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ILayoutProps.html" class="tsd-signature-type tsd-kind-interface">ILayoutProps</a><span class="tsd-signature-symbol">></span></span></li
|
|
77
|
-
</div><div class="tsd-tag-see"><h4 class="tsd-anchor-link"><a id="see-
|
|
77
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">nextProps</span>: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ILayoutProps.html" class="tsd-signature-type tsd-kind-interface">ILayoutProps</a><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link"><a id="deprecated-2" class="tsd-anchor"></a>Deprecated<a href="#deprecated-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>16.3, use static <a href="undefined">StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps</a> instead; will stop working in React 17</p>
|
|
78
|
+
</div><div class="tsd-tag-see"><h4 class="tsd-anchor-link"><a id="see-3" class="tsd-anchor"></a>See<a href="#see-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><ul>
|
|
78
79
|
<li><a href="https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props">https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</a></li>
|
|
79
80
|
<li><a href="https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path">https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</a></li>
|
|
80
81
|
</ul>
|
|
81
82
|
</div></div><aside class="tsd-sources"><p>Inherited from React.Component.componentWillReceiveProps</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="componentwillunmount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>component<wbr/>Will<wbr/>Unmount</span><a href="#componentwillunmount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="componentwillunmount-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">componentWillUnmount</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#componentwillunmount-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as
|
|
82
83
|
cancelled network requests, or cleaning up any DOM elements created in <code>componentDidMount</code>.</p>
|
|
83
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from React.Component.componentWillUnmount</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="componentwillupdate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span class="deprecated">component<wbr/>Will<wbr/>Update</span><a href="#componentwillupdate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="componentwillupdate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">componentWillUpdate</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">nextProps</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ILayoutProps.html" class="tsd-signature-type tsd-kind-interface">ILayoutProps</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">nextState</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br
|
|
84
|
-
<p>Note: You cannot call Component.setState here.</p>
|
|
85
|
-
<p>Note: the presence of NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate
|
|
86
|
-
or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents
|
|
84
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from React.Component.componentWillUnmount</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="componentwillupdate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span class="deprecated">component<wbr/>Will<wbr/>Update</span><a href="#componentwillupdate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="componentwillupdate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">componentWillUpdate</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">nextProps</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ILayoutProps.html" class="tsd-signature-type tsd-kind-interface">ILayoutProps</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">nextState</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#componentwillupdate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Called immediately before rendering when new props or state is received. Not called for the initial render.</p>
|
|
85
|
+
<p>Note: You cannot call <a href="undefined">Component.setState</a> here.</p>
|
|
86
|
+
<p>Note: the presence of <a href="undefined">NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate</a>
|
|
87
|
+
or <a href="undefined">StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps</a> prevents
|
|
87
88
|
this from being invoked.</p>
|
|
88
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">nextProps</span>: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ILayoutProps.html" class="tsd-signature-type tsd-kind-interface">ILayoutProps</a><span class="tsd-signature-symbol">></span></span></li><li><span><span class="tsd-kind-parameter">nextState</span>: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span></span></li
|
|
89
|
-
</div><div class="tsd-tag-see"><h4 class="tsd-anchor-link"><a id="see-
|
|
89
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">nextProps</span>: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ILayoutProps.html" class="tsd-signature-type tsd-kind-interface">ILayoutProps</a><span class="tsd-signature-symbol">></span></span></li><li><span><span class="tsd-kind-parameter">nextState</span>: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link"><a id="deprecated-3" class="tsd-anchor"></a>Deprecated<a href="#deprecated-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
|
90
|
+
</div><div class="tsd-tag-see"><h4 class="tsd-anchor-link"><a id="see-4" class="tsd-anchor"></a>See<a href="#see-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><ul>
|
|
90
91
|
<li><a href="https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update">https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</a></li>
|
|
91
92
|
<li><a href="https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path">https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</a></li>
|
|
92
93
|
</ul>
|
|
93
94
|
</div></div><aside class="tsd-sources"><p>Inherited from React.Component.componentWillUpdate</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="forceupdate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>force<wbr/>Update</span><a href="#forceupdate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="forceupdate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">forceUpdate</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#forceupdate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">callback</span>: <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from React.Component.forceUpdate</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getrootdiv" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Root<wbr/>Div</span><a href="#getrootdiv" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getrootdiv-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getRootDiv</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">HTMLDivElement</span><a href="#getrootdiv-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the root div element of the layout</p>
|
|
94
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">HTMLDivElement</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="getsnapshotbeforeupdate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>get<wbr/>Snapshot<wbr/>Before<wbr/>Update</span><a href="#getsnapshotbeforeupdate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="getsnapshotbeforeupdate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getSnapshotBeforeUpdate</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">prevProps</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ILayoutProps.html" class="tsd-signature-type tsd-kind-interface">ILayoutProps</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">prevState</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><a href="#getsnapshotbeforeupdate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Runs before React applies the result of Component.render render to the document, and
|
|
95
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">HTMLDivElement</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="getsnapshotbeforeupdate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>get<wbr/>Snapshot<wbr/>Before<wbr/>Update</span><a href="#getsnapshotbeforeupdate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="getsnapshotbeforeupdate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getSnapshotBeforeUpdate</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">prevProps</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ILayoutProps.html" class="tsd-signature-type tsd-kind-interface">ILayoutProps</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">prevState</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><a href="#getsnapshotbeforeupdate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Runs before React applies the result of <a href="undefined">Component.render render</a> to the document, and
|
|
95
96
|
returns an object to be given to <a href="Layout.html#componentdidupdate" class="tsd-kind-method">componentDidUpdate</a>. Useful for saving
|
|
96
|
-
things such as scroll position before Component.render render causes changes to it.</p>
|
|
97
|
+
things such as scroll position before <a href="undefined">Component.render render</a> causes changes to it.</p>
|
|
97
98
|
<p>Note: the presence of this method prevents any of the deprecated
|
|
98
99
|
lifecycle events from running.</p>
|
|
99
100
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">prevProps</span>: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ILayoutProps.html" class="tsd-signature-type tsd-kind-interface">ILayoutProps</a><span class="tsd-signature-symbol">></span></span></li><li><span><span class="tsd-kind-parameter">prevState</span>: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from React.Component.getSnapshotBeforeUpdate</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="movetabwithdraganddrop" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>move<wbr/>Tab<wbr/>With<wbr/>Drag<wbr/>And<wbr/>Drop</span><a href="#movetabwithdraganddrop" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="movetabwithdraganddrop-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">moveTabWithDragAndDrop</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DragEvent</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">node</span><span class="tsd-signature-symbol">:</span> <a href="TabSetNode.html" class="tsd-signature-type tsd-kind-class">TabSetNode</a> <span class="tsd-signature-symbol">|</span> <a href="TabNode.html" class="tsd-signature-type tsd-kind-class">TabNode</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#movetabwithdraganddrop-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Move a tab/tabset using drag and drop, must be called from within an HTML
|
|
@@ -106,45 +107,45 @@ drag start handler</p>
|
|
|
106
107
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">component</span>: <span class="tsd-signature-type">ReactNode</span></span><div class="tsd-comment tsd-typography"><p>the react component to be used for the drag image</p>
|
|
107
108
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">x</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>the x position of the drag cursor on the image</p>
|
|
108
109
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">y</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>the x position of the drag cursor on the image</p>
|
|
109
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="setstate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>State</span><a href="#setstate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="setstate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setState</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Layout.html#setstatek">K</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">state</span><span class="tsd-signature-symbol">:</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{}</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">prevState</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ILayoutProps.html" class="tsd-signature-type tsd-kind-interface">ILayoutProps</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{}</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="Layout.html#setstatek">K</a><span class="tsd-signature-symbol">></span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="Layout.html#setstatek">K</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#setstate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="setstatek" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">K</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">never</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">state</span>: <br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{}</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">prevState</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ILayoutProps.html" class="tsd-signature-type tsd-kind-interface">ILayoutProps</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{}</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="Layout.html#setstatek">K</a><span class="tsd-signature-symbol">></span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="Layout.html#setstatek">K</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">callback</span>: <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from React.Component.setState</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="shouldcomponentupdate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>should<wbr/>Component<wbr/>Update</span><a href="#shouldcomponentupdate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="shouldcomponentupdate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">shouldComponentUpdate</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">nextProps</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ILayoutProps.html" class="tsd-signature-type tsd-kind-interface">ILayoutProps</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">nextState</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br
|
|
110
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="setstate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>State</span><a href="#setstate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="setstate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setState</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Layout.html#setstatek">K</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">state</span><span class="tsd-signature-symbol">:</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{}</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">prevState</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ILayoutProps.html" class="tsd-signature-type tsd-kind-interface">ILayoutProps</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{}</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="Layout.html#setstatek">K</a><span class="tsd-signature-symbol">></span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="Layout.html#setstatek">K</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#setstate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="setstatek" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">K</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">never</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">state</span>: <br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{}</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">prevState</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ILayoutProps.html" class="tsd-signature-type tsd-kind-interface">ILayoutProps</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{}</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="Layout.html#setstatek">K</a><span class="tsd-signature-symbol">></span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="Layout.html#setstatek">K</a><span class="tsd-signature-symbol">></span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">callback</span>: <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from React.Component.setState</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="shouldcomponentupdate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>should<wbr/>Component<wbr/>Update</span><a href="#shouldcomponentupdate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="shouldcomponentupdate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">shouldComponentUpdate</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">nextProps</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ILayoutProps.html" class="tsd-signature-type tsd-kind-interface">ILayoutProps</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">nextState</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#shouldcomponentupdate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Called to determine whether the change in props and state should trigger a re-render.</p>
|
|
110
111
|
<p><code>Component</code> always returns true.
|
|
111
112
|
<code>PureComponent</code> implements a shallow comparison on props and state and returns true if any
|
|
112
113
|
props or states have changed.</p>
|
|
113
|
-
<p>If false is returned, Component.render
|
|
114
|
+
<p>If false is returned, <a href="undefined">Component.render</a>, <code>componentWillUpdate</code>
|
|
114
115
|
and <code>componentDidUpdate</code> will not be called.</p>
|
|
115
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">nextProps</span>: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ILayoutProps.html" class="tsd-signature-type tsd-kind-interface">ILayoutProps</a><span class="tsd-signature-symbol">></span></span></li><li><span><span class="tsd-kind-parameter">nextState</span>: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span></span></li
|
|
116
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">nextProps</span>: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ILayoutProps.html" class="tsd-signature-type tsd-kind-interface">ILayoutProps</a><span class="tsd-signature-symbol">></span></span></li><li><span><span class="tsd-kind-parameter">nextState</span>: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from React.Component.shouldComponentUpdate</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="unsafe_componentwillmount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span class="deprecated">UNSAFE_<wbr/>component<wbr/>Will<wbr/>Mount</span><a href="#unsafe_componentwillmount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="unsafe_componentwillmount-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">UNSAFE_componentWillMount</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#unsafe_componentwillmount-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Called immediately before mounting occurs, and before <a href="undefined">Component.render</a>.
|
|
116
117
|
Avoid introducing any side-effects or subscriptions in this method.</p>
|
|
117
118
|
<p>This method will not stop working in React 17.</p>
|
|
118
|
-
<p>Note: the presence of NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate
|
|
119
|
-
or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents
|
|
119
|
+
<p>Note: the presence of <a href="undefined">NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate</a>
|
|
120
|
+
or <a href="undefined">StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps</a> prevents
|
|
120
121
|
this from being invoked.</p>
|
|
121
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link"><a id="deprecated-4" class="tsd-anchor"></a>Deprecated<a href="#deprecated-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>16.3, use ComponentLifecycle.componentDidMount componentDidMount or the constructor instead</p>
|
|
122
|
-
</div><div class="tsd-tag-see"><h4 class="tsd-anchor-link"><a id="see-
|
|
122
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link"><a id="deprecated-4" class="tsd-anchor"></a>Deprecated<a href="#deprecated-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>16.3, use <a href="undefined">ComponentLifecycle.componentDidMount componentDidMount</a> or the constructor instead</p>
|
|
123
|
+
</div><div class="tsd-tag-see"><h4 class="tsd-anchor-link"><a id="see-5" class="tsd-anchor"></a>See<a href="#see-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><ul>
|
|
123
124
|
<li><a href="https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state">https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</a></li>
|
|
124
125
|
<li><a href="https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path">https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</a></li>
|
|
125
126
|
</ul>
|
|
126
|
-
</div></div><aside class="tsd-sources"><p>Inherited from React.Component.UNSAFE_componentWillMount</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="unsafe_componentwillreceiveprops" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span class="deprecated">UNSAFE_<wbr/>component<wbr/>Will<wbr/>Receive<wbr/>Props</span><a href="#unsafe_componentwillreceiveprops" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="unsafe_componentwillreceiveprops-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">UNSAFE_componentWillReceiveProps</span><span class="tsd-signature-symbol">(</span><
|
|
127
|
+
</div></div><aside class="tsd-sources"><p>Inherited from React.Component.UNSAFE_componentWillMount</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="unsafe_componentwillreceiveprops" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span class="deprecated">UNSAFE_<wbr/>component<wbr/>Will<wbr/>Receive<wbr/>Props</span><a href="#unsafe_componentwillreceiveprops" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="unsafe_componentwillreceiveprops-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">UNSAFE_componentWillReceiveProps</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">nextProps</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ILayoutProps.html" class="tsd-signature-type tsd-kind-interface">ILayoutProps</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#unsafe_componentwillreceiveprops-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Called when the component may be receiving new props.
|
|
127
128
|
React may call this even if props have not changed, so be sure to compare new and existing
|
|
128
129
|
props if you only want to handle changes.</p>
|
|
129
|
-
<p>Calling Component.setState generally does not trigger this method.</p>
|
|
130
|
+
<p>Calling <a href="undefined">Component.setState</a> generally does not trigger this method.</p>
|
|
130
131
|
<p>This method will not stop working in React 17.</p>
|
|
131
|
-
<p>Note: the presence of NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate
|
|
132
|
-
or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents
|
|
132
|
+
<p>Note: the presence of <a href="undefined">NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate</a>
|
|
133
|
+
or <a href="undefined">StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps</a> prevents
|
|
133
134
|
this from being invoked.</p>
|
|
134
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">nextProps</span>: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ILayoutProps.html" class="tsd-signature-type tsd-kind-interface">ILayoutProps</a><span class="tsd-signature-symbol">></span></span></li
|
|
135
|
-
</div><div class="tsd-tag-see"><h4 class="tsd-anchor-link"><a id="see-
|
|
135
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">nextProps</span>: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ILayoutProps.html" class="tsd-signature-type tsd-kind-interface">ILayoutProps</a><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link"><a id="deprecated-5" class="tsd-anchor"></a>Deprecated<a href="#deprecated-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>16.3, use static <a href="undefined">StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps</a> instead</p>
|
|
136
|
+
</div><div class="tsd-tag-see"><h4 class="tsd-anchor-link"><a id="see-6" class="tsd-anchor"></a>See<a href="#see-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><ul>
|
|
136
137
|
<li><a href="https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props">https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</a></li>
|
|
137
138
|
<li><a href="https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path">https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</a></li>
|
|
138
139
|
</ul>
|
|
139
|
-
</div></div><aside class="tsd-sources"><p>Inherited from React.Component.UNSAFE_componentWillReceiveProps</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="unsafe_componentwillupdate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span class="deprecated">UNSAFE_<wbr/>component<wbr/>Will<wbr/>Update</span><a href="#unsafe_componentwillupdate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="unsafe_componentwillupdate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">UNSAFE_componentWillUpdate</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">nextProps</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ILayoutProps.html" class="tsd-signature-type tsd-kind-interface">ILayoutProps</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">nextState</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br
|
|
140
|
-
<p>Note: You cannot call Component.setState here.</p>
|
|
140
|
+
</div></div><aside class="tsd-sources"><p>Inherited from React.Component.UNSAFE_componentWillReceiveProps</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="unsafe_componentwillupdate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span class="deprecated">UNSAFE_<wbr/>component<wbr/>Will<wbr/>Update</span><a href="#unsafe_componentwillupdate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="unsafe_componentwillupdate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">UNSAFE_componentWillUpdate</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">nextProps</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ILayoutProps.html" class="tsd-signature-type tsd-kind-interface">ILayoutProps</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">nextState</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#unsafe_componentwillupdate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Called immediately before rendering when new props or state is received. Not called for the initial render.</p>
|
|
141
|
+
<p>Note: You cannot call <a href="undefined">Component.setState</a> here.</p>
|
|
141
142
|
<p>This method will not stop working in React 17.</p>
|
|
142
|
-
<p>Note: the presence of NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate
|
|
143
|
-
or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents
|
|
143
|
+
<p>Note: the presence of <a href="undefined">NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate</a>
|
|
144
|
+
or <a href="undefined">StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps</a> prevents
|
|
144
145
|
this from being invoked.</p>
|
|
145
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">nextProps</span>: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ILayoutProps.html" class="tsd-signature-type tsd-kind-interface">ILayoutProps</a><span class="tsd-signature-symbol">></span></span></li><li><span><span class="tsd-kind-parameter">nextState</span>: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span></span></li
|
|
146
|
-
</div><div class="tsd-tag-see"><h4 class="tsd-anchor-link"><a id="see-
|
|
146
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">nextProps</span>: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ILayoutProps.html" class="tsd-signature-type tsd-kind-interface">ILayoutProps</a><span class="tsd-signature-symbol">></span></span></li><li><span><span class="tsd-kind-parameter">nextState</span>: <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link"><a id="deprecated-6" class="tsd-anchor"></a>Deprecated<a href="#deprecated-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>16.3, use getSnapshotBeforeUpdate instead</p>
|
|
147
|
+
</div><div class="tsd-tag-see"><h4 class="tsd-anchor-link"><a id="see-7" class="tsd-anchor"></a>See<a href="#see-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><ul>
|
|
147
148
|
<li><a href="https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update">https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</a></li>
|
|
148
149
|
<li><a href="https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path">https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</a></li>
|
|
149
150
|
</ul>
|
|
150
|
-
</div></div><aside class="tsd-sources"><p>Inherited from React.Component.UNSAFE_componentWillUpdate</p></aside></li></ul></section></section></details></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"><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-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"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#context" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>context</span></a><a href="#props" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>props</span></a><a href="#
|
|
151
|
+
</div></div><aside class="tsd-sources"><p>Inherited from React.Component.UNSAFE_componentWillUpdate</p></aside></li></ul></section></section></details></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"><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-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"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#context" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>context</span></a><a href="#props" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>props</span></a><a href="#state" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>state</span></a><a href="#contexttype" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>context<wbr/>Type</span></a><a href="#proptypes" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prop<wbr/>Types</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#addtabtoactivetabset" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Tab<wbr/>To<wbr/>Active<wbr/>Tab<wbr/>Set</span></a><a href="#addtabtotabset" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Tab<wbr/>To<wbr/>Tab<wbr/>Set</span></a><a href="#addtabwithdraganddrop" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Tab<wbr/>With<wbr/>Drag<wbr/>And<wbr/>Drop</span></a><a href="#componentdidcatch" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>component<wbr/>Did<wbr/>Catch</span></a><a href="#componentdidmount" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>component<wbr/>Did<wbr/>Mount</span></a><a href="#componentdidupdate" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>component<wbr/>Did<wbr/>Update</span></a><a href="#componentwillmount" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>component<wbr/>Will<wbr/>Mount</span></a><a href="#componentwillreceiveprops" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>component<wbr/>Will<wbr/>Receive<wbr/>Props</span></a><a href="#componentwillunmount" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>component<wbr/>Will<wbr/>Unmount</span></a><a href="#componentwillupdate" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>component<wbr/>Will<wbr/>Update</span></a><a href="#forceupdate" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>force<wbr/>Update</span></a><a href="#getrootdiv" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Root<wbr/>Div</span></a><a href="#getsnapshotbeforeupdate" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Snapshot<wbr/>Before<wbr/>Update</span></a><a href="#movetabwithdraganddrop" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>move<wbr/>Tab<wbr/>With<wbr/>Drag<wbr/>And<wbr/>Drop</span></a><a href="#redraw" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>redraw</span></a><a href="#setdragcomponent" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Drag<wbr/>Component</span></a><a href="#setstate" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>State</span></a><a href="#shouldcomponentupdate" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>should<wbr/>Component<wbr/>Update</span></a><a href="#unsafe_componentwillmount" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>UNSAFE_<wbr/>component<wbr/>Will<wbr/>Mount</span></a><a href="#unsafe_componentwillreceiveprops" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>UNSAFE_<wbr/>component<wbr/>Will<wbr/>Receive<wbr/>Props</span></a><a href="#unsafe_componentwillupdate" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>UNSAFE_<wbr/>component<wbr/>Will<wbr/>Update</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html">@aptre/flex-layout</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>
|