@aptre/flex-layout 0.3.4 → 0.4.0
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 +13 -0
- package/dist/Layout.e2e.test.d.ts +1 -0
- package/dist/Layout.test.d.ts +1 -0
- package/dist/OptimizedLayout.e2e.test.d.ts +1 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.mjs +199 -52
- package/dist/model/IJsonModel.d.ts +4 -4
- package/dist/test/setup.d.ts +8 -0
- package/dist/test/unit-setup.d.ts +1 -0
- package/dist/view/Layout.d.ts +2 -0
- package/dist/view/OptimizedLayout.d.ts +29 -0
- package/package.json +119 -102
- package/tsconfig.json +18 -18
- package/typedoc/assets/hierarchy.js +1 -1
- package/typedoc/assets/main.js +5 -5
- package/typedoc/assets/navigation.js +1 -1
- package/typedoc/assets/search.js +1 -1
- package/typedoc/assets/style.css +251 -228
- package/typedoc/classes/Action.html +4 -4
- package/typedoc/classes/Actions.html +74 -74
- package/typedoc/classes/BorderNode.html +25 -25
- package/typedoc/classes/BorderSet.html +2 -2
- package/typedoc/classes/DockLocation.html +10 -10
- package/typedoc/classes/DropInfo.html +7 -7
- package/typedoc/classes/Layout.html +96 -96
- package/typedoc/classes/LayoutWindow.html +12 -12
- package/typedoc/classes/Model.html +42 -42
- package/typedoc/classes/Node.html +12 -12
- package/typedoc/classes/Orientation.html +6 -6
- package/typedoc/classes/Rect.html +26 -26
- package/typedoc/classes/RowNode.html +16 -16
- package/typedoc/classes/TabNode.html +39 -39
- package/typedoc/classes/TabSetNode.html +39 -39
- package/typedoc/enums/CLASSES.html +94 -94
- package/typedoc/enums/I18nLabel.html +11 -11
- package/typedoc/enums/ICloseType.html +4 -4
- package/typedoc/functions/OptimizedLayout.html +18 -0
- package/typedoc/functions/findJsonNodeById.html +4 -4
- package/typedoc/functions/walkJsonModel.html +3 -3
- package/typedoc/hierarchy.html +1 -1
- package/typedoc/index.html +1 -1
- package/typedoc/interfaces/IBorderAttributes.html +25 -25
- package/typedoc/interfaces/IDraggable.html +1 -1
- package/typedoc/interfaces/IDropTarget.html +1 -1
- package/typedoc/interfaces/IGlobalAttributes.html +99 -99
- package/typedoc/interfaces/IIcons.html +9 -9
- package/typedoc/interfaces/IJsonBorderNode.html +27 -27
- package/typedoc/interfaces/IJsonModel.html +5 -5
- package/typedoc/interfaces/IJsonPopout.html +3 -3
- package/typedoc/interfaces/IJsonRect.html +5 -5
- package/typedoc/interfaces/IJsonRowNode.html +8 -8
- package/typedoc/interfaces/IJsonTabNode.html +53 -53
- package/typedoc/interfaces/IJsonTabSetNode.html +52 -52
- package/typedoc/interfaces/ILayoutProps.html +41 -39
- package/typedoc/interfaces/IOptimizedLayoutProps.html +42 -0
- package/typedoc/interfaces/IRowAttributes.html +7 -7
- package/typedoc/interfaces/ITabAttributes.html +53 -53
- package/typedoc/interfaces/ITabRenderValues.html +7 -7
- package/typedoc/interfaces/ITabSetAttributes.html +47 -47
- package/typedoc/interfaces/ITabSetRenderValues.html +7 -7
- package/typedoc/interfaces/VisitorResult.html +5 -5
- package/typedoc/types/DragRectRenderCallback.html +1 -1
- package/typedoc/types/IBorderLocation.html +1 -1
- package/typedoc/types/ITabLocation.html +1 -1
- package/typedoc/types/JsonNode.html +2 -2
- package/typedoc/types/ModelVisitor.html +5 -5
- package/typedoc/types/NodeMouseEvent.html +1 -1
- package/typedoc/types/ShowOverflowMenuCallback.html +1 -1
- package/typedoc/types/TabSetPlaceHolderCallback.html +1 -1
- package/typedoc/variables/FlexLayoutVersion.html +1 -1
|
@@ -0,0 +1,42 @@
|
|
|
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>IOptimizedLayoutProps | @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">IOptimizedLayoutProps</a></li></ul><h1>Interface IOptimizedLayoutProps</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Props for OptimizedLayout - similar to Layout but with <code>renderTab</code> instead of <code>factory</code></p>
|
|
2
|
+
</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">IOptimizedLayoutProps</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#classnamemapper">classNameMapper</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">defaultClassName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#i18nmapper">i18nMapper</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <a href="../enums/I18nLabel.html" class="tsd-signature-type tsd-kind-enum">I18nLabel</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">param</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#icons">icons</a><span class="tsd-signature-symbol">?:</span> <a href="IIcons.html" class="tsd-signature-type tsd-kind-interface">IIcons</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#model">model</a><span class="tsd-signature-symbol">:</span> <a href="../classes/Model.html" class="tsd-signature-type tsd-kind-class">Model</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#onaction">onAction</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">action</span><span class="tsd-signature-symbol">:</span> <a href="../classes/Action.html" class="tsd-signature-type tsd-kind-class">Action</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <a href="../classes/Action.html" class="tsd-signature-type tsd-kind-class">Action</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#onauxmouseclick">onAuxMouseClick</a><span class="tsd-signature-symbol">?:</span> <a href="../types/NodeMouseEvent.html" class="tsd-signature-type tsd-kind-type-alias">NodeMouseEvent</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#oncontextmenu">onContextMenu</a><span class="tsd-signature-symbol">?:</span> <a href="../types/NodeMouseEvent.html" class="tsd-signature-type tsd-kind-type-alias">NodeMouseEvent</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#ondragstatechange">onDragStateChange</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">isDragging</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</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/> <a class="tsd-kind-property" href="#onexternaldrag">onExternalDrag</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><br/> <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><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-property">json</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">onDrop</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">node</span><span class="tsd-signature-symbol">?:</span> <a href="../classes/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 class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#onmodelchange">onModelChange</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">model</span><span class="tsd-signature-symbol">:</span> <a href="../classes/Model.html" class="tsd-signature-type tsd-kind-class">Model</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">action</span><span class="tsd-signature-symbol">:</span> <a href="../classes/Action.html" class="tsd-signature-type tsd-kind-class">Action</a><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/> <a class="tsd-kind-property" href="#onrenderdragrect">onRenderDragRect</a><span class="tsd-signature-symbol">?:</span> <a href="../types/DragRectRenderCallback.html" class="tsd-signature-type tsd-kind-type-alias">DragRectRenderCallback</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#onrendertab">onRenderTab</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">node</span><span class="tsd-signature-symbol">:</span> <a href="../classes/TabNode.html" class="tsd-signature-type tsd-kind-class">TabNode</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">renderValues</span><span class="tsd-signature-symbol">:</span> <a href="ITabRenderValues.html" class="tsd-signature-type tsd-kind-interface">ITabRenderValues</a><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/> <a class="tsd-kind-property" href="#onrendertabset">onRenderTabSet</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">tabSetNode</span><span class="tsd-signature-symbol">:</span> <a href="../classes/TabSetNode.html" class="tsd-signature-type tsd-kind-class">TabSetNode</a> <span class="tsd-signature-symbol">|</span> <a href="../classes/BorderNode.html" class="tsd-signature-type tsd-kind-class">BorderNode</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">renderValues</span><span class="tsd-signature-symbol">:</span> <a href="ITabSetRenderValues.html" class="tsd-signature-type tsd-kind-interface">ITabSetRenderValues</a><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><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#onshowoverflowmenu">onShowOverflowMenu</a><span class="tsd-signature-symbol">?:</span> <a href="../types/ShowOverflowMenuCallback.html" class="tsd-signature-type tsd-kind-type-alias">ShowOverflowMenuCallback</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#ontabsetplaceholder">onTabSetPlaceHolder</a><span class="tsd-signature-symbol">?:</span> <a href="../types/TabSetPlaceHolderCallback.html" class="tsd-signature-type tsd-kind-type-alias">TabSetPlaceHolderCallback</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#popouturl">popoutURL</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#popoutwindowname">popoutWindowName</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#realtimeresize">realtimeResize</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#rendertab">renderTab</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">node</span><span class="tsd-signature-symbol">:</span> <a href="../classes/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">ReactNode</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#supportspopout">supportsPopout</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy" data-refl="524"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><a href="ILayoutProps.html" class="tsd-signature-type tsd-kind-interface">ILayoutProps</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">"factory"</span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">IOptimizedLayoutProps</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="#classnamemapper" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>class<wbr/>Name<wbr/>Mapper?</span></a>
|
|
3
|
+
<a href="#i18nmapper" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>i18n<wbr/>Mapper?</span></a>
|
|
4
|
+
<a href="#icons" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>icons?</span></a>
|
|
5
|
+
<a href="#model" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>model</span></a>
|
|
6
|
+
<a href="#onaction" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Action?</span></a>
|
|
7
|
+
<a href="#onauxmouseclick" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Aux<wbr/>Mouse<wbr/>Click?</span></a>
|
|
8
|
+
<a href="#oncontextmenu" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Context<wbr/>Menu?</span></a>
|
|
9
|
+
<a href="#ondragstatechange" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Drag<wbr/>State<wbr/>Change?</span></a>
|
|
10
|
+
<a href="#onexternaldrag" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>External<wbr/>Drag?</span></a>
|
|
11
|
+
<a href="#onmodelchange" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Model<wbr/>Change?</span></a>
|
|
12
|
+
<a href="#onrenderdragrect" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Render<wbr/>Drag<wbr/>Rect?</span></a>
|
|
13
|
+
<a href="#onrendertab" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Render<wbr/>Tab?</span></a>
|
|
14
|
+
<a href="#onrendertabset" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Render<wbr/>Tab<wbr/>Set?</span></a>
|
|
15
|
+
<a href="#onshowoverflowmenu" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Show<wbr/>Overflow<wbr/>Menu?</span></a>
|
|
16
|
+
<a href="#ontabsetplaceholder" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Tab<wbr/>Set<wbr/>Place<wbr/>Holder?</span></a>
|
|
17
|
+
<a href="#popouturl" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>popout<wbr/>URL?</span></a>
|
|
18
|
+
<a href="#popoutwindowname" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>popout<wbr/>Window<wbr/>Name?</span></a>
|
|
19
|
+
<a href="#realtimeresize" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>realtime<wbr/>Resize?</span></a>
|
|
20
|
+
<a href="#rendertab" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>render<wbr/>Tab</span></a>
|
|
21
|
+
<a href="#supportspopout" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>supports<wbr/>Popout?</span></a>
|
|
22
|
+
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><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><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="classnamemapper"><code class="tsd-tag">Optional</code><span>class<wbr/>Name<wbr/>Mapper</span><a href="#classnamemapper" 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">classNameMapper</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">defaultClassName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>function called with default css class name, return value is class name that will be used. Mainly for use with css modules.</p>
|
|
23
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="ILayoutProps.html">ILayoutProps</a>.<a href="ILayoutProps.html#classnamemapper">classNameMapper</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="i18nmapper"><code class="tsd-tag">Optional</code><span>i18n<wbr/>Mapper</span><a href="#i18nmapper" 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">i18nMapper</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <a href="../enums/I18nLabel.html" class="tsd-signature-type tsd-kind-enum">I18nLabel</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">param</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></div><div class="tsd-comment tsd-typography"><p>function called for each I18nLabel to allow user translation, currently used for tab and tabset move messages, return undefined to use default values</p>
|
|
24
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="ILayoutProps.html">ILayoutProps</a>.<a href="ILayoutProps.html#i18nmapper">i18nMapper</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="icons"><code class="tsd-tag">Optional</code><span>icons</span><a href="#icons" 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">icons</span><span class="tsd-signature-symbol">?:</span> <a href="IIcons.html" class="tsd-signature-type tsd-kind-interface">IIcons</a></div><div class="tsd-comment tsd-typography"><p>object mapping keys among close, maximize, restore, more, popout to React nodes to use in place of the default icons, can alternatively return functions for creating the React nodes</p>
|
|
25
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="ILayoutProps.html">ILayoutProps</a>.<a href="ILayoutProps.html#icons">icons</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="model"><span>model</span><a href="#model" 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">model</span><span class="tsd-signature-symbol">:</span> <a href="../classes/Model.html" class="tsd-signature-type tsd-kind-class">Model</a></div><div class="tsd-comment tsd-typography"><p>the model for this layout</p>
|
|
26
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="ILayoutProps.html">ILayoutProps</a>.<a href="ILayoutProps.html#model">model</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="onaction"><code class="tsd-tag">Optional</code><span>on<wbr/>Action</span><a href="#onaction" 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">onAction</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">action</span><span class="tsd-signature-symbol">:</span> <a href="../classes/Action.html" class="tsd-signature-type tsd-kind-class">Action</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <a href="../classes/Action.html" class="tsd-signature-type tsd-kind-class">Action</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></div><div class="tsd-comment tsd-typography"><p>function called whenever the layout generates an action to update the model (allows for intercepting actions before they are dispatched to the model, for example, asking the user to confirm a tab close.) Returning undefined from the function will halt the action, otherwise return the action to continue</p>
|
|
27
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="ILayoutProps.html">ILayoutProps</a>.<a href="ILayoutProps.html#onaction">onAction</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="onauxmouseclick"><code class="tsd-tag">Optional</code><span>on<wbr/>Aux<wbr/>Mouse<wbr/>Click</span><a href="#onauxmouseclick" 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">onAuxMouseClick</span><span class="tsd-signature-symbol">?:</span> <a href="../types/NodeMouseEvent.html" class="tsd-signature-type tsd-kind-type-alias">NodeMouseEvent</a></div><div class="tsd-comment tsd-typography"><p>callback for handling mouse clicks on tabs and tabsets with alt, meta, shift keys, also handles center mouse clicks</p>
|
|
28
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="ILayoutProps.html">ILayoutProps</a>.<a href="ILayoutProps.html#onauxmouseclick">onAuxMouseClick</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="oncontextmenu"><code class="tsd-tag">Optional</code><span>on<wbr/>Context<wbr/>Menu</span><a href="#oncontextmenu" 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">onContextMenu</span><span class="tsd-signature-symbol">?:</span> <a href="../types/NodeMouseEvent.html" class="tsd-signature-type tsd-kind-type-alias">NodeMouseEvent</a></div><div class="tsd-comment tsd-typography"><p>callback for handling context actions on tabs and tabsets</p>
|
|
29
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="ILayoutProps.html">ILayoutProps</a>.<a href="ILayoutProps.html#oncontextmenu">onContextMenu</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="ondragstatechange"><code class="tsd-tag">Optional</code><span>on<wbr/>Drag<wbr/>State<wbr/>Change</span><a href="#ondragstatechange" 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">onDragStateChange</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">isDragging</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>callback for when drag state changes, useful for OptimizedLayout to set pointer-events: none on external tab container during drag</p>
|
|
30
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="ILayoutProps.html">ILayoutProps</a>.<a href="ILayoutProps.html#ondragstatechange">onDragStateChange</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="onexternaldrag"><code class="tsd-tag">Optional</code><span>on<wbr/>External<wbr/>Drag</span><a href="#onexternaldrag" 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">onExternalDrag</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><br/> <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><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-property">json</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">onDrop</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">node</span><span class="tsd-signature-symbol">?:</span> <a href="../classes/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 class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></div><div class="tsd-comment tsd-typography"><p>function called when an external object (not a tab) gets dragged onto the layout, with a single dragenter argument. Should return either undefined to reject the drag/drop or an object with keys dragText, jsonDrop, to create a tab via drag (similar to a call to addTabToTabSet). Function onDropis passed the added tabNodeand thedrop DragEvent`, unless the drag was canceled.</p>
|
|
31
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="ILayoutProps.html">ILayoutProps</a>.<a href="ILayoutProps.html#onexternaldrag">onExternalDrag</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="onmodelchange"><code class="tsd-tag">Optional</code><span>on<wbr/>Model<wbr/>Change</span><a href="#onmodelchange" 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">onModelChange</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">model</span><span class="tsd-signature-symbol">:</span> <a href="../classes/Model.html" class="tsd-signature-type tsd-kind-class">Model</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">action</span><span class="tsd-signature-symbol">:</span> <a href="../classes/Action.html" class="tsd-signature-type tsd-kind-class">Action</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>function called when model has changed</p>
|
|
32
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="ILayoutProps.html">ILayoutProps</a>.<a href="ILayoutProps.html#onmodelchange">onModelChange</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="onrenderdragrect"><code class="tsd-tag">Optional</code><span>on<wbr/>Render<wbr/>Drag<wbr/>Rect</span><a href="#onrenderdragrect" 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">onRenderDragRect</span><span class="tsd-signature-symbol">?:</span> <a href="../types/DragRectRenderCallback.html" class="tsd-signature-type tsd-kind-type-alias">DragRectRenderCallback</a></div><div class="tsd-comment tsd-typography"><p>callback for rendering the drag rectangles</p>
|
|
33
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="ILayoutProps.html">ILayoutProps</a>.<a href="ILayoutProps.html#onrenderdragrect">onRenderDragRect</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="onrendertab"><code class="tsd-tag">Optional</code><span>on<wbr/>Render<wbr/>Tab</span><a href="#onrendertab" 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">onRenderTab</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">node</span><span class="tsd-signature-symbol">:</span> <a href="../classes/TabNode.html" class="tsd-signature-type tsd-kind-class">TabNode</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">renderValues</span><span class="tsd-signature-symbol">:</span> <a href="ITabRenderValues.html" class="tsd-signature-type tsd-kind-interface">ITabRenderValues</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>function called when rendering a tab, allows leading (icon), content section, buttons and name used in overflow menu to be customized</p>
|
|
34
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="ILayoutProps.html">ILayoutProps</a>.<a href="ILayoutProps.html#onrendertab">onRenderTab</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="onrendertabset"><code class="tsd-tag">Optional</code><span>on<wbr/>Render<wbr/>Tab<wbr/>Set</span><a href="#onrendertabset" 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">onRenderTabSet</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">tabSetNode</span><span class="tsd-signature-symbol">:</span> <a href="../classes/TabSetNode.html" class="tsd-signature-type tsd-kind-class">TabSetNode</a> <span class="tsd-signature-symbol">|</span> <a href="../classes/BorderNode.html" class="tsd-signature-type tsd-kind-class">BorderNode</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">renderValues</span><span class="tsd-signature-symbol">:</span> <a href="ITabSetRenderValues.html" class="tsd-signature-type tsd-kind-interface">ITabSetRenderValues</a><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></div><div class="tsd-comment tsd-typography"><p>function called when rendering a tabset, allows header and buttons to be customized</p>
|
|
35
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="ILayoutProps.html">ILayoutProps</a>.<a href="ILayoutProps.html#onrendertabset">onRenderTabSet</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="onshowoverflowmenu"><code class="tsd-tag">Optional</code><span>on<wbr/>Show<wbr/>Overflow<wbr/>Menu</span><a href="#onshowoverflowmenu" 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">onShowOverflowMenu</span><span class="tsd-signature-symbol">?:</span> <a href="../types/ShowOverflowMenuCallback.html" class="tsd-signature-type tsd-kind-type-alias">ShowOverflowMenuCallback</a></div><div class="tsd-comment tsd-typography"><p>callback for handling the display of the tab overflow menu</p>
|
|
36
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="ILayoutProps.html">ILayoutProps</a>.<a href="ILayoutProps.html#onshowoverflowmenu">onShowOverflowMenu</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="ontabsetplaceholder"><code class="tsd-tag">Optional</code><span>on<wbr/>Tab<wbr/>Set<wbr/>Place<wbr/>Holder</span><a href="#ontabsetplaceholder" 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">onTabSetPlaceHolder</span><span class="tsd-signature-symbol">?:</span> <a href="../types/TabSetPlaceHolderCallback.html" class="tsd-signature-type tsd-kind-type-alias">TabSetPlaceHolderCallback</a></div><div class="tsd-comment tsd-typography"><p>callback for rendering a placeholder when a tabset is empty</p>
|
|
37
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="ILayoutProps.html">ILayoutProps</a>.<a href="ILayoutProps.html#ontabsetplaceholder">onTabSetPlaceHolder</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="popouturl"><code class="tsd-tag">Optional</code><span>popout<wbr/>URL</span><a href="#popouturl" 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">popoutURL</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>URL of popout window relative to origin, defaults to popout.html</p>
|
|
38
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="ILayoutProps.html">ILayoutProps</a>.<a href="ILayoutProps.html#popouturl">popoutURL</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="popoutwindowname"><code class="tsd-tag">Optional</code><span>popout<wbr/>Window<wbr/>Name</span><a href="#popoutwindowname" 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">popoutWindowName</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Name given to popout windows, defaults to 'Popout Window'</p>
|
|
39
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="ILayoutProps.html">ILayoutProps</a>.<a href="ILayoutProps.html#popoutwindowname">popoutWindowName</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="realtimeresize"><code class="tsd-tag">Optional</code><span>realtime<wbr/>Resize</span><a href="#realtimeresize" 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">realtimeResize</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>boolean value, defaults to false, resize tabs as splitters are dragged. Warning: this can cause resizing to become choppy when tabs are slow to draw</p>
|
|
40
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="ILayoutProps.html">ILayoutProps</a>.<a href="ILayoutProps.html#realtimeresize">realtimeResize</a></p></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="rendertab"><span>render<wbr/>Tab</span><a href="#rendertab" 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">renderTab</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">node</span><span class="tsd-signature-symbol">:</span> <a href="../classes/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">ReactNode</span></div><div class="tsd-comment tsd-typography"><p>Function to render tab content - receives TabNode, returns React element</p>
|
|
41
|
+
</div></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="supportspopout"><code class="tsd-tag">Optional</code><span>supports<wbr/>Popout</span><a href="#supportspopout" 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">supportsPopout</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>if left undefined will do simple check based on userAgent</p>
|
|
42
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="ILayoutProps.html">ILayoutProps</a>.<a href="ILayoutProps.html#supportspopout">supportsPopout</a></p></aside></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="#classnamemapper" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>class<wbr/>Name<wbr/>Mapper</span></a><a href="#i18nmapper" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>i18n<wbr/>Mapper</span></a><a href="#icons" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>icons</span></a><a href="#model" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>model</span></a><a href="#onaction" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Action</span></a><a href="#onauxmouseclick" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Aux<wbr/>Mouse<wbr/>Click</span></a><a href="#oncontextmenu" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Context<wbr/>Menu</span></a><a href="#ondragstatechange" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Drag<wbr/>State<wbr/>Change</span></a><a href="#onexternaldrag" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>External<wbr/>Drag</span></a><a href="#onmodelchange" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Model<wbr/>Change</span></a><a href="#onrenderdragrect" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Render<wbr/>Drag<wbr/>Rect</span></a><a href="#onrendertab" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Render<wbr/>Tab</span></a><a href="#onrendertabset" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Render<wbr/>Tab<wbr/>Set</span></a><a href="#onshowoverflowmenu" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Show<wbr/>Overflow<wbr/>Menu</span></a><a href="#ontabsetplaceholder" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Tab<wbr/>Set<wbr/>Place<wbr/>Holder</span></a><a href="#popouturl" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>popout<wbr/>URL</span></a><a href="#popoutwindowname" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>popout<wbr/>Window<wbr/>Name</span></a><a href="#realtimeresize" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>realtime<wbr/>Resize</span></a><a href="#rendertab"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>render<wbr/>Tab</span></a><a href="#supportspopout" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>supports<wbr/>Popout</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>
|
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="
|
|
2
|
-
<a href="
|
|
3
|
-
<a href="
|
|
4
|
-
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><
|
|
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>IRowAttributes | @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">IRowAttributes</a></li></ul><h1>Interface IRowAttributes</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">IRowAttributes</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#id">id</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#type">type</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"row"</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#weight">weight</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy" data-refl="1061"><h4>Hierarchy (<a href="../hierarchy.html#IRowAttributes">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">IRowAttributes</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="IJsonRowNode.html" class="tsd-signature-type tsd-kind-interface">IJsonRowNode</a></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="#id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id?</span></a>
|
|
2
|
+
<a href="#type" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a>
|
|
3
|
+
<a href="#weight" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>weight?</span></a>
|
|
4
|
+
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><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><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="id"><code class="tsd-tag">Optional</code><span>id</span><a href="#id" 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">id</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>the unique id of the row, if left undefined a uuid will be assigned</p>
|
|
5
5
|
<p>Default: undefined</p>
|
|
6
|
-
</div
|
|
7
|
-
</div
|
|
6
|
+
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="type"><span>type</span><a href="#type" 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">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"row"</span></div><div class="tsd-comment tsd-typography"><p>The type of this node (always "row")</p>
|
|
7
|
+
</div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="weight"><code class="tsd-tag">Optional</code><span>weight</span><a href="#weight" 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">weight</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>relative weight for sizing of this row in parent row</p>
|
|
8
8
|
<p>Default: 100</p>
|
|
9
|
-
</div
|
|
9
|
+
</div></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="#id"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a><a href="#type"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a><a href="#weight"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>weight</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>
|