@aptre/flex-layout 0.5.13 → 0.6.1
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/README.md +11 -59
- package/dist/I18nLabel.d.ts +0 -1
- package/dist/Types.d.ts +0 -7
- package/dist/index.d.ts +0 -1
- package/dist/index.mjs +595 -1208
- package/dist/model/Action.d.ts +1 -34
- package/dist/model/Actions.d.ts +1 -30
- package/dist/model/IJsonModel.d.ts +0 -55
- package/dist/model/Model.d.ts +4 -7
- package/dist/model/RowNode.d.ts +0 -1
- package/dist/model/TabNode.d.ts +0 -6
- package/dist/model/TabSetNode.d.ts +1 -1
- package/dist/view/BorderTab.d.ts +1 -2
- package/dist/view/Icons.d.ts +6 -8
- package/dist/view/Layout.d.ts +25 -32
- package/dist/view/OptimizedLayout.d.ts +3 -3
- package/dist/view/SizeTracker.d.ts +3 -3
- package/dist/view/Utils.d.ts +2 -8
- package/package.json +31 -31
- package/tsconfig.json +1 -1
- package/typedoc/assets/hierarchy.js +1 -1
- package/typedoc/assets/navigation.js +1 -1
- package/typedoc/assets/search.js +1 -1
- package/typedoc/classes/Actions.html +4 -21
- package/typedoc/classes/BorderNode.html +1 -1
- package/typedoc/classes/Layout.html +17 -17
- package/typedoc/classes/Model.html +9 -11
- package/typedoc/classes/Node.html +1 -1
- package/typedoc/classes/RowNode.html +2 -3
- package/typedoc/classes/TabNode.html +2 -8
- package/typedoc/classes/TabSetNode.html +1 -1
- package/typedoc/enums/CLASSES.html +1 -8
- package/typedoc/enums/I18nLabel.html +1 -2
- package/typedoc/hierarchy.html +1 -1
- package/typedoc/index.html +1 -1
- package/typedoc/interfaces/ActionDataMap.html +2 -6
- package/typedoc/interfaces/IBorderAttributes.html +1 -1
- package/typedoc/interfaces/IGlobalAttributes.html +2 -15
- package/typedoc/interfaces/IIcons.html +2 -3
- package/typedoc/interfaces/IJsonBorderNode.html +1 -1
- package/typedoc/interfaces/IJsonModel.html +2 -3
- package/typedoc/interfaces/IJsonRowNode.html +1 -1
- package/typedoc/interfaces/IJsonTabNode.html +4 -17
- package/typedoc/interfaces/IJsonTabSetNode.html +1 -1
- package/typedoc/interfaces/ILayoutProps.html +3 -9
- package/typedoc/interfaces/IOptimizedLayoutProps.html +4 -10
- package/typedoc/interfaces/IRowAttributes.html +1 -1
- package/typedoc/interfaces/ITabAttributes.html +2 -15
- package/typedoc/interfaces/ITabSetAttributes.html +1 -1
- package/typedoc/types/Action.html +1 -1
- package/typedoc/types/DragRectRenderCallback.html +1 -1
- package/typedoc/types/NodeMouseEvent.html +1 -1
- package/typedoc/types/ShowOverflowMenuCallback.html +1 -1
- package/typedoc/types/TabSetPlaceHolderCallback.html +1 -1
- package/typedoc/variables/ActionType.html +2 -2
- package/dist/model/LayoutWindow.d.ts +0 -28
- package/dist/view/PopoutWindow.d.ts +0 -1
- package/typedoc/classes/LayoutWindow.html +0 -12
- package/typedoc/interfaces/CloseWindowData.html +0 -2
- package/typedoc/interfaces/CreateWindowData.html +0 -3
- package/typedoc/interfaces/IJsonPopout.html +0 -3
- package/typedoc/interfaces/PopoutTabData.html +0 -2
- package/typedoc/interfaces/PopoutTabsetData.html +0 -2
|
@@ -1,5 +1,5 @@
|
|
|
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(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@aptre/flex-layout</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">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
|
-
</div></section><section class="tsd-panel tsd-hierarchy" data-refl="
|
|
2
|
+
</div></section><section class="tsd-panel tsd-hierarchy" data-refl="57"><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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">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="#context" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>context</span></a>
|
|
3
3
|
<a href="#props" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>props</span></a>
|
|
4
4
|
<a href="#state" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>state</span></a>
|
|
5
5
|
<a href="#contexttype" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>context<wbr/>Type?</span></a>
|
|
@@ -32,14 +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" id="see">See<a href="#see" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><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
|
|
35
|
+
</div></div><aside class="tsd-sources"><p>Inherited from Component.context</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="props"><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" aria-hidden="true"><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><span class="tsd-signature-type tsd-kind-type-parameter">P</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from Component.props</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="state"><span>state</span><a href="#state" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><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-type tsd-kind-type-parameter">S</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from Component.state</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="contexttype"><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" aria-hidden="true"><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>
|
|
36
36
|
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-1">Example<a href="#example-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><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>
|
|
37
37
|
</code><button type="button">Copy</button></pre>
|
|
38
38
|
|
|
39
39
|
</div><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-1">See<a href="#see-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><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
|
|
40
|
+
</div></div><aside class="tsd-sources"><p>Inherited from Component.contextType</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="proptypes"><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" aria-hidden="true"><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
41
|
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated">Deprecated<a href="#deprecated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><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
|
|
42
|
+
</div></div><aside class="tsd-sources"><p>Inherited from 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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="addtabtoactivetabset"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="addtabtoactivetabset-1"><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> <a href="TabNode.html" class="tsd-signature-type tsd-kind-class">TabNode</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><a href="#addtabtoactivetabset-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds a new tab to the active tabset (if there is one)</p>
|
|
43
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>
|
|
44
44
|
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="TabNode.html" class="tsd-signature-type tsd-kind-class">TabNode</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></h4><p>the added tab node or undefined</p>
|
|
45
45
|
</div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="addtabtotabset"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="addtabtotabset-1"><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> <a href="TabNode.html" class="tsd-signature-type tsd-kind-class">TabNode</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><a href="#addtabtotabset-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds a new tab to the given tabset</p>
|
|
@@ -54,10 +54,10 @@ method.</p>
|
|
|
54
54
|
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">onDrop</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">node</span><span class="tsd-signature-symbol">?:</span> <a href="Node.html" class="tsd-signature-type tsd-kind-class">Node</a><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-signature-type">HTMLElement</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><div class="tsd-comment tsd-typography"><p>a callback to call when the drag is complete</p>
|
|
55
55
|
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="componentdidcatch"><code class="tsd-tag">Optional</code><span>component<wbr/>Did<wbr/>Catch</span><a href="#componentdidcatch" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="componentdidcatch-1"><span class="tsd-kind-call-signature">componentDidCatch</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">errorInfo</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ErrorInfo</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#componentdidcatch-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Catches exceptions generated in descendant components. Unhandled exceptions will cause
|
|
56
56
|
the entire component tree to unmount.</p>
|
|
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><aside class="tsd-sources"><p>Inherited from
|
|
58
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from
|
|
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><aside class="tsd-sources"><p>Inherited from Component.componentDidCatch</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="componentdidmount"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="componentdidmount-1"><span class="tsd-kind-call-signature">componentDidMount</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><a href="#componentdidmount-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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>
|
|
58
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from Component.componentDidMount</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="componentdidupdate"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="componentdidupdate-1"><span class="tsd-kind-call-signature">componentDidUpdate</span><span class="tsd-signature-symbol">?</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><span class="tsd-signature-type tsd-kind-type-parameter">P</span><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-type tsd-kind-type-parameter">S</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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Called immediately after updating occurs. Not called for the initial render.</p>
|
|
59
59
|
<p>The snapshot is only present if <a href="#getsnapshotbeforeupdate" class="tsd-kind-method">getSnapshotBeforeUpdate</a> is present and returns non-null.</p>
|
|
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><span class="tsd-signature-type tsd-kind-type-parameter">P</span><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-type tsd-kind-type-parameter">S</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><aside class="tsd-sources"><p>Inherited from
|
|
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><span class="tsd-signature-type tsd-kind-type-parameter">P</span><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-type tsd-kind-type-parameter">S</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><aside class="tsd-sources"><p>Inherited from Component.componentDidUpdate</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="componentwillmount"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="componentwillmount-1"><span class="tsd-kind-call-signature">componentWillMount</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><a href="#componentwillmount-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Called immediately before mounting occurs, and before Component.render.
|
|
61
61
|
Avoid introducing any side-effects or subscriptions in this method.</p>
|
|
62
62
|
<p>Note: the presence of NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate
|
|
63
63
|
or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents
|
|
@@ -67,7 +67,7 @@ this from being invoked.</p>
|
|
|
67
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>
|
|
68
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>
|
|
69
69
|
</ul>
|
|
70
|
-
</div></div><aside class="tsd-sources"><p>Inherited from
|
|
70
|
+
</div></div><aside class="tsd-sources"><p>Inherited from Component.componentWillMount</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="componentwillreceiveprops"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="componentwillreceiveprops-1"><span class="tsd-kind-call-signature">componentWillReceiveProps</span><span class="tsd-signature-symbol">?</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><span class="tsd-signature-type tsd-kind-type-parameter">P</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">nextContext</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Called when the component may be receiving new props.
|
|
71
71
|
React may call this even if props have not changed, so be sure to compare new and existing
|
|
72
72
|
props if you only want to handle changes.</p>
|
|
73
73
|
<p>Calling Component.setState generally does not trigger this method.</p>
|
|
@@ -79,9 +79,9 @@ this from being invoked.</p>
|
|
|
79
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>
|
|
80
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>
|
|
81
81
|
</ul>
|
|
82
|
-
</div></div><aside class="tsd-sources"><p>Inherited from
|
|
82
|
+
</div></div><aside class="tsd-sources"><p>Inherited from Component.componentWillReceiveProps</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="componentwillunmount"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="componentwillunmount-1"><span class="tsd-kind-call-signature">componentWillUnmount</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><a href="#componentwillunmount-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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
|
|
83
83
|
cancelled network requests, or cleaning up any DOM elements created in <code>componentDidMount</code>.</p>
|
|
84
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from
|
|
84
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from Component.componentWillUnmount</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="componentwillupdate"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="componentwillupdate-1"><span class="tsd-kind-call-signature">componentWillUpdate</span><span class="tsd-signature-symbol">?</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><span class="tsd-signature-type tsd-kind-type-parameter">P</span><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-type tsd-kind-type-parameter">S</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">nextContext</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="#componentwillupdate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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
85
|
<p>Note: You cannot call Component.setState here.</p>
|
|
86
86
|
<p>Note: the presence of NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate
|
|
87
87
|
or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents
|
|
@@ -91,13 +91,13 @@ this from being invoked.</p>
|
|
|
91
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>
|
|
92
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>
|
|
93
93
|
</ul>
|
|
94
|
-
</div></div><aside class="tsd-sources"><p>Inherited from
|
|
94
|
+
</div></div><aside class="tsd-sources"><p>Inherited from Component.componentWillUpdate</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="forceupdate"><span>force<wbr/>Update</span><a href="#forceupdate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="forceupdate-1"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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 Component.forceUpdate</p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getrootdiv"><span>get<wbr/>Root<wbr/>Div</span><a href="#getrootdiv" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getrootdiv-1"><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">HTMLDivElement</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><a href="#getrootdiv-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the root div element of the layout</p>
|
|
95
95
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">HTMLDivElement</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></h4></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="getsnapshotbeforeupdate"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="getsnapshotbeforeupdate-1"><span class="tsd-kind-call-signature">getSnapshotBeforeUpdate</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">(</span><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><span class="tsd-signature-type tsd-kind-type-parameter">P</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <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-type tsd-kind-type-parameter">S</span><span class="tsd-signature-symbol">></span><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Runs before React applies the result of Component.render render to the document, and
|
|
96
96
|
returns an object to be given to <a href="#componentdidupdate" class="tsd-kind-method">componentDidUpdate</a>. Useful for saving
|
|
97
97
|
things such as scroll position before Component.render render causes changes to it.</p>
|
|
98
98
|
<p>Note: the presence of this method prevents any of the deprecated
|
|
99
99
|
lifecycle events from running.</p>
|
|
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><span class="tsd-signature-type tsd-kind-type-parameter">P</span><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-type tsd-kind-type-parameter">S</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><aside class="tsd-sources"><p>Inherited from
|
|
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><span class="tsd-signature-type tsd-kind-type-parameter">P</span><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-type tsd-kind-type-parameter">S</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><aside class="tsd-sources"><p>Inherited from Component.getSnapshotBeforeUpdate</p></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="movetabwithdraganddrop"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="movetabwithdraganddrop-1"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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
|
|
101
101
|
drag start handler</p>
|
|
102
102
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">DragEvent</span></span><div class="tsd-comment tsd-typography"><p>the drag start event</p>
|
|
103
103
|
</div></li><li><span><span class="tsd-kind-parameter">node</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><div class="tsd-comment tsd-typography"><p>the tab or tabset to drag</p>
|
|
@@ -107,13 +107,13 @@ drag start handler</p>
|
|
|
107
107
|
</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>
|
|
108
108
|
</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>
|
|
109
109
|
</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>
|
|
110
|
-
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="setstate"><span>set<wbr/>State</span><a href="#setstate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="setstate-1"><span class="tsd-kind-call-signature">setState</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#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-symbol">{}</span><br/> <span class="tsd-signature-symbol">|</span> (<br/> <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-type tsd-kind-type-parameter">S</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><span class="tsd-signature-type tsd-kind-type-parameter">P</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-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="#setstatek">K</a><span class="tsd-signature-symbol">></span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><br/> )<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="#setstatek">K</a><span class="tsd-signature-symbol">></span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="setstatek"><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-symbol">{}</span><br/> <span class="tsd-signature-symbol">|</span> (<span class="tsd-signature-symbol">(</span><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-type tsd-kind-type-parameter">S</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <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><span class="tsd-signature-type tsd-kind-type-parameter">P</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> <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="#setstatek">K</a><span class="tsd-signature-symbol">></span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</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="#setstatek">K</a><span class="tsd-signature-symbol">></span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</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
|
|
110
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="setstate"><span>set<wbr/>State</span><a href="#setstate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="setstate-1"><span class="tsd-kind-call-signature">setState</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#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-symbol">{}</span><br/> <span class="tsd-signature-symbol">|</span> (<br/> <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-type tsd-kind-type-parameter">S</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><span class="tsd-signature-type tsd-kind-type-parameter">P</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-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="#setstatek">K</a><span class="tsd-signature-symbol">></span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><br/> )<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="#setstatek">K</a><span class="tsd-signature-symbol">></span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="setstatek"><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-symbol">{}</span><br/> <span class="tsd-signature-symbol">|</span> (<span class="tsd-signature-symbol">(</span><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-type tsd-kind-type-parameter">S</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <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><span class="tsd-signature-type tsd-kind-type-parameter">P</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> <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="#setstatek">K</a><span class="tsd-signature-symbol">></span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</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="#setstatek">K</a><span class="tsd-signature-symbol">></span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</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 Component.setState</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="shouldcomponentupdate"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="shouldcomponentupdate-1"><span class="tsd-kind-call-signature">shouldComponentUpdate</span><span class="tsd-signature-symbol">?</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><span class="tsd-signature-type tsd-kind-type-parameter">P</span><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-type tsd-kind-type-parameter">S</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">nextContext</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">boolean</span><a href="#shouldcomponentupdate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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>
|
|
111
111
|
<p><code>Component</code> always returns true.
|
|
112
112
|
<code>PureComponent</code> implements a shallow comparison on props and state and returns true if any
|
|
113
113
|
props or states have changed.</p>
|
|
114
114
|
<p>If false is returned, Component.render, <code>componentWillUpdate</code>
|
|
115
115
|
and <code>componentDidUpdate</code> will not be called.</p>
|
|
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><span class="tsd-signature-type tsd-kind-type-parameter">P</span><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-type tsd-kind-type-parameter">S</span><span class="tsd-signature-symbol">></span></span></li><li><span><span class="tsd-kind-parameter">nextContext</span>: <span class="tsd-signature-type">any</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"><p>Inherited from
|
|
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><span class="tsd-signature-type tsd-kind-type-parameter">P</span><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-type tsd-kind-type-parameter">S</span><span class="tsd-signature-symbol">></span></span></li><li><span><span class="tsd-kind-parameter">nextContext</span>: <span class="tsd-signature-type">any</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"><p>Inherited from Component.shouldComponentUpdate</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="unsafe_componentwillmount"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="unsafe_componentwillmount-1"><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-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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Called immediately before mounting occurs, and before Component.render.
|
|
117
117
|
Avoid introducing any side-effects or subscriptions in this method.</p>
|
|
118
118
|
<p>This method will not stop working in React 17.</p>
|
|
119
119
|
<p>Note: the presence of NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate
|
|
@@ -124,7 +124,7 @@ this from being invoked.</p>
|
|
|
124
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>
|
|
125
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>
|
|
126
126
|
</ul>
|
|
127
|
-
</div></div><aside class="tsd-sources"><p>Inherited from
|
|
127
|
+
</div></div><aside class="tsd-sources"><p>Inherited from Component.UNSAFE_componentWillMount</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="unsafe_componentwillreceiveprops"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="unsafe_componentwillreceiveprops-1"><span class="tsd-kind-call-signature">UNSAFE_componentWillReceiveProps</span><span class="tsd-signature-symbol">?</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><span class="tsd-signature-type tsd-kind-type-parameter">P</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">nextContext</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="#unsafe_componentwillreceiveprops-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Called when the component may be receiving new props.
|
|
128
128
|
React may call this even if props have not changed, so be sure to compare new and existing
|
|
129
129
|
props if you only want to handle changes.</p>
|
|
130
130
|
<p>Calling Component.setState generally does not trigger this method.</p>
|
|
@@ -137,7 +137,7 @@ this from being invoked.</p>
|
|
|
137
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>
|
|
138
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>
|
|
139
139
|
</ul>
|
|
140
|
-
</div></div><aside class="tsd-sources"><p>Inherited from
|
|
140
|
+
</div></div><aside class="tsd-sources"><p>Inherited from Component.UNSAFE_componentWillReceiveProps</p></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="unsafe_componentwillupdate"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="unsafe_componentwillupdate-1"><span class="tsd-kind-call-signature">UNSAFE_componentWillUpdate</span><span class="tsd-signature-symbol">?</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><span class="tsd-signature-type tsd-kind-type-parameter">P</span><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-type tsd-kind-type-parameter">S</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">nextContext</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="#unsafe_componentwillupdate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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
141
|
<p>Note: You cannot call Component.setState here.</p>
|
|
142
142
|
<p>This method will not stop working in React 17.</p>
|
|
143
143
|
<p>Note: the presence of NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate
|
|
@@ -148,4 +148,4 @@ this from being invoked.</p>
|
|
|
148
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>
|
|
149
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>
|
|
150
150
|
</ul>
|
|
151
|
-
</div></div><aside class="tsd-sources"><p>Inherited from
|
|
151
|
+
</div></div><aside class="tsd-sources"><p>Inherited from Component.UNSAFE_componentWillUpdate</p></aside></div></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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>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" aria-hidden="true"><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" aria-label="Property"><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" aria-label="Property"><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" aria-label="Property"><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" aria-label="Property"><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" aria-label="Property"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#addtabtoactivetabset"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><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"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Tab<wbr/>To<wbr/>Tab<wbr/>Set</span></a><a href="#addtabwithdraganddrop"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>force<wbr/>Update</span></a><a href="#getrootdiv"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><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" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Snapshot<wbr/>Before<wbr/>Update</span></a><a href="#movetabwithdraganddrop"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><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"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>redraw</span></a><a href="#setdragcomponent"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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>
|