uiconfig-blueprint 0.1.0-dev.13 → 0.1.0-dev.14

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.
Files changed (165) hide show
  1. package/dist/ConfigObject.d.ts +3 -1
  2. package/dist/{allPaths-Dbwyd6G0.js → allPaths-DANRR6MZ.js} +5 -5
  3. package/dist/{allPaths-Dbwyd6G0.js.map → allPaths-DANRR6MZ.js.map} +1 -1
  4. package/dist/{allPathsLoader-B9DtnPQs.js → allPathsLoader-BdHGVD6B.js} +4 -4
  5. package/dist/{allPathsLoader-B9DtnPQs.js.map → allPathsLoader-BdHGVD6B.js.map} +1 -1
  6. package/dist/bpComponents/BPColorInputComponent.d.ts +1 -0
  7. package/dist/bpComponents/BPComponent.d.ts +2 -0
  8. package/dist/bpComponents/BPContainerComponent.d.ts +10 -2
  9. package/dist/bpComponents/BPFileComponent.d.ts +12 -10
  10. package/dist/bpComponents/BPFolderComponent.d.ts +13 -4
  11. package/dist/bpComponents/BPPanelComponent.d.ts +3 -3
  12. package/dist/bpComponents/BPTextInputComponent.d.ts +4 -0
  13. package/dist/bpComponents/BPValueComponent.d.ts +2 -2
  14. package/dist/bpComponents/BPVectorInputComponent.d.ts +11 -5
  15. package/dist/bpComponents/InputGroup2.d.ts +25 -0
  16. package/dist/components/DialogContext.d.ts +10 -3
  17. package/dist/components/DraggableIcon.d.ts +4 -3
  18. package/dist/components/FileComponent.d.ts +13 -6
  19. package/dist/components/FormGroupComponent.d.ts +3 -2
  20. package/dist/components/InspectorStackComponent.d.ts +11 -2
  21. package/dist/index-6kveHKKU.js +695 -0
  22. package/dist/index-6kveHKKU.js.map +1 -0
  23. package/dist/index-D9WNL8Mc.js +695 -0
  24. package/dist/index-D9WNL8Mc.js.map +1 -0
  25. package/dist/index-t3WzvX5M.js +13501 -0
  26. package/dist/index-t3WzvX5M.js.map +1 -0
  27. package/dist/index.js +28 -41
  28. package/dist/index.js.map +1 -1
  29. package/dist/index.mjs +2 -2
  30. package/dist/lib.d.ts +2 -3
  31. package/dist/{splitPathsBySizeLoader-Dii-Xb62.js → splitPathsBySizeLoader-Bhwx_O-M.js} +5 -5
  32. package/dist/{splitPathsBySizeLoader-Dii-Xb62.js.map → splitPathsBySizeLoader-Bhwx_O-M.js.map} +1 -1
  33. package/dist/utils/pointerLock.d.ts +44 -0
  34. package/docs/classes/UI.html +3 -3
  35. package/docs/classes/UiConfigRendererBlueprint.html +3 -3
  36. package/lib/css/renderer.css +35 -103
  37. package/lib/css/renderer.css.map +1 -1
  38. package/lib/esm/ConfigObject.d.ts +3 -1
  39. package/lib/esm/ConfigObject.js +5 -4
  40. package/lib/esm/ConfigObject.js.map +1 -1
  41. package/lib/esm/UiConfigRendererBlueprint.js +2 -1
  42. package/lib/esm/UiConfigRendererBlueprint.js.map +1 -1
  43. package/lib/esm/bpComponents/BPButtonComponent.js +1 -1
  44. package/lib/esm/bpComponents/BPButtonComponent.js.map +1 -1
  45. package/lib/esm/bpComponents/BPColorInputComponent.d.ts +1 -0
  46. package/lib/esm/bpComponents/BPColorInputComponent.js +17 -4
  47. package/lib/esm/bpComponents/BPColorInputComponent.js.map +1 -1
  48. package/lib/esm/bpComponents/BPComponent.d.ts +2 -0
  49. package/lib/esm/bpComponents/BPComponent.js +4 -4
  50. package/lib/esm/bpComponents/BPComponent.js.map +1 -1
  51. package/lib/esm/bpComponents/BPContainerComponent.d.ts +10 -2
  52. package/lib/esm/bpComponents/BPContainerComponent.js +4 -1
  53. package/lib/esm/bpComponents/BPContainerComponent.js.map +1 -1
  54. package/lib/esm/bpComponents/BPDropdownInputComponent.js +4 -3
  55. package/lib/esm/bpComponents/BPDropdownInputComponent.js.map +1 -1
  56. package/lib/esm/bpComponents/BPFileComponent.d.ts +12 -10
  57. package/lib/esm/bpComponents/BPFileComponent.js +10 -8
  58. package/lib/esm/bpComponents/BPFileComponent.js.map +1 -1
  59. package/lib/esm/bpComponents/BPFolderComponent.d.ts +13 -4
  60. package/lib/esm/bpComponents/BPFolderComponent.js +58 -13
  61. package/lib/esm/bpComponents/BPFolderComponent.js.map +1 -1
  62. package/lib/esm/bpComponents/BPInputComponent.js +1 -1
  63. package/lib/esm/bpComponents/BPInputComponent.js.map +1 -1
  64. package/lib/esm/bpComponents/BPPanelComponent.d.ts +3 -3
  65. package/lib/esm/bpComponents/BPPanelComponent.js +1 -1
  66. package/lib/esm/bpComponents/BPPanelComponent.js.map +1 -1
  67. package/lib/esm/bpComponents/BPTextInputComponent.d.ts +4 -0
  68. package/lib/esm/bpComponents/BPTextInputComponent.js +34 -3
  69. package/lib/esm/bpComponents/BPTextInputComponent.js.map +1 -1
  70. package/lib/esm/bpComponents/BPTreeComponent.d.ts +4 -4
  71. package/lib/esm/bpComponents/BPTreeComponent.js +2 -2
  72. package/lib/esm/bpComponents/BPTreeComponent.js.map +1 -1
  73. package/lib/esm/bpComponents/BPValueComponent.d.ts +2 -2
  74. package/lib/esm/bpComponents/BPValueComponent.js +5 -4
  75. package/lib/esm/bpComponents/BPValueComponent.js.map +1 -1
  76. package/lib/esm/bpComponents/BPVectorInputComponent.d.ts +11 -5
  77. package/lib/esm/bpComponents/BPVectorInputComponent.js +47 -6
  78. package/lib/esm/bpComponents/BPVectorInputComponent.js.map +1 -1
  79. package/lib/esm/bpComponents/InputGroup2.d.ts +25 -0
  80. package/lib/esm/bpComponents/InputGroup2.js +93 -0
  81. package/lib/esm/bpComponents/InputGroup2.js.map +1 -0
  82. package/lib/esm/components/ConfigurationPanelComponent.js +1 -1
  83. package/lib/esm/components/ConfigurationPanelComponent.js.map +1 -1
  84. package/lib/esm/components/DialogContext.d.ts +10 -3
  85. package/lib/esm/components/DialogContext.js +14 -13
  86. package/lib/esm/components/DialogContext.js.map +1 -1
  87. package/lib/esm/components/DraggableIcon.d.ts +4 -3
  88. package/lib/esm/components/DraggableIcon.js +41 -39
  89. package/lib/esm/components/DraggableIcon.js.map +1 -1
  90. package/lib/esm/components/ExtendedNumericInput.js +1 -1
  91. package/lib/esm/components/ExtendedNumericInput.js.map +1 -1
  92. package/lib/esm/components/FileComponent.d.ts +13 -6
  93. package/lib/esm/components/FileComponent.js +15 -6
  94. package/lib/esm/components/FileComponent.js.map +1 -1
  95. package/lib/esm/components/FormGroupComponent.d.ts +3 -2
  96. package/lib/esm/components/FormGroupComponent.js +1 -6
  97. package/lib/esm/components/FormGroupComponent.js.map +1 -1
  98. package/lib/esm/components/InspectorStackComponent.d.ts +11 -2
  99. package/lib/esm/components/InspectorStackComponent.js +14 -4
  100. package/lib/esm/components/InspectorStackComponent.js.map +1 -1
  101. package/lib/esm/components/NumericInput.js +3 -2
  102. package/lib/esm/components/NumericInput.js.map +1 -1
  103. package/lib/esm/components/TreeNode2.d.ts +1 -1
  104. package/lib/esm/components/TreeNode2.js +4 -2
  105. package/lib/esm/components/TreeNode2.js.map +1 -1
  106. package/lib/esm/components/treeTypes.d.ts +2 -1
  107. package/lib/esm/lib.d.ts +2 -3
  108. package/lib/esm/lib.js +2 -3
  109. package/lib/esm/lib.js.map +1 -1
  110. package/lib/esm/renderer.css.js +1 -1
  111. package/lib/esm/utils/pointerLock.d.ts +44 -0
  112. package/lib/esm/utils/pointerLock.js +215 -0
  113. package/lib/esm/utils/pointerLock.js.map +1 -0
  114. package/lib/esm/utils.js +6 -1
  115. package/lib/esm/utils.js.map +1 -1
  116. package/package.json +10 -12
  117. package/src/ConfigObject.tsx +11 -5
  118. package/src/UiConfigRendererBlueprint.tsx +1 -1
  119. package/src/bpComponents/BPButtonComponent.tsx +1 -1
  120. package/src/bpComponents/BPColorInputComponent.tsx +13 -4
  121. package/src/bpComponents/BPComponent.tsx +4 -3
  122. package/src/bpComponents/BPContainerComponent.tsx +20 -3
  123. package/src/bpComponents/BPDropdownInputComponent.tsx +4 -3
  124. package/src/bpComponents/BPFileComponent.tsx +29 -20
  125. package/src/bpComponents/BPFolderComponent.scss +11 -6
  126. package/src/bpComponents/BPFolderComponent.tsx +122 -24
  127. package/src/bpComponents/BPInputComponent.tsx +1 -0
  128. package/src/bpComponents/BPPanelComponent.tsx +4 -4
  129. package/src/bpComponents/BPTextInputComponent.tsx +38 -5
  130. package/src/bpComponents/BPValueComponent.tsx +4 -4
  131. package/src/bpComponents/BPVectorInputComponent.tsx +80 -10
  132. package/src/bpComponents/InputGroup2.tsx +175 -0
  133. package/src/bpComponents/index.scss +0 -1
  134. package/src/components/ConfigurationPanelComponent.tsx +2 -2
  135. package/src/components/DialogContext.tsx +20 -12
  136. package/src/components/DraggableIcon.tsx +71 -49
  137. package/src/components/ExtendedNumericInput.tsx +2 -2
  138. package/src/components/FileComponent.tsx +37 -18
  139. package/src/components/FormGroupComponent.tsx +8 -4
  140. package/src/components/InspectorStackComponent.tsx +20 -7
  141. package/src/components/NumericInput.tsx +4 -5
  142. package/src/components/common.scss +1 -1
  143. package/src/lib.ts +2 -3
  144. package/src/renderer.scss +30 -8
  145. package/src/utils/PointerLockManager.md +334 -0
  146. package/src/utils/pointerLock.ts +264 -0
  147. package/src/utils.ts +8 -4
  148. package/dist/bpComponents/BPTreeComponent.d.ts +0 -46
  149. package/dist/bpComponents/BPTreeFolderComponent.d.ts +0 -10
  150. package/dist/components/Tree2.d.ts +0 -52
  151. package/dist/components/TreeNode2.d.ts +0 -43
  152. package/dist/components/treeTypes.d.ts +0 -18
  153. package/dist/index-BFBvfUPU.js +0 -671
  154. package/dist/index-BFBvfUPU.js.map +0 -1
  155. package/dist/index-CHQ1fP9-.js +0 -671
  156. package/dist/index-CHQ1fP9-.js.map +0 -1
  157. package/dist/index-Dbe8gLld.js +0 -13583
  158. package/dist/index-Dbe8gLld.js.map +0 -1
  159. package/src/bpComponents/BPTreeComponent.scss +0 -3
  160. package/src/bpComponents/BPTreeComponent.tsx +0 -244
  161. package/src/bpComponents/BPTreeFolderComponent.tsx +0 -31
  162. package/src/components/Tree2.tsx +0 -344
  163. package/src/components/TreeNode2.tsx +0 -192
  164. package/src/components/tree2.scss +0 -69
  165. package/src/components/treeTypes.ts +0 -97
@@ -1,3 +0,0 @@
1
- .bpTreeComponent {
2
- width: 100%;
3
- }
@@ -1,244 +0,0 @@
1
- import {Tree2} from "../components/Tree2";
2
- import {BPComponent, BPComponentProps, BPComponentState, UiConfigRendererContextType} from "./BPComponent";
3
- import {TreeNodeInfo} from "@blueprintjs/core";
4
- import React from "react";
5
-
6
- export type BPTreeComponentState<T = {}> = BPComponentState & {
7
- nodes: TreeNodeInfo<T>[]
8
- }
9
-
10
- // https://github.com/palantir/blueprint/blob/develop/packages/docs-app/src/examples/core-examples/treeExample.tsx
11
- type NodePath = (string|number)[];
12
-
13
- export abstract class BPTreeComponent<T = {}, TConfigVal extends any /*|PrimitiveVal|void*/ = void> extends BPComponent<TConfigVal, BPTreeComponentState<T>, BPComponentProps<TConfigVal> & {className: string}> {
14
- constructor(props: BPComponentProps<TConfigVal> & {className: string}, context: UiConfigRendererContextType) {
15
- super(props, context, {nodes: []});
16
- }
17
-
18
- protected _infoMap = new Map<string | number, TreeNodeInfo<T>>()
19
-
20
- protected _createNodeInfo(id: string, obj: T) {
21
- return {
22
- id,
23
- label: 'unnamed',
24
- nodeData: obj,
25
- childNodes: [],
26
- isExpanded: false,
27
- isSelected: false,
28
- }
29
- }
30
-
31
- protected abstract _getNodeId(obj: T): string
32
-
33
- protected abstract _updateNodeInfo(node: TreeNodeInfo<T>, obj: T): TreeNodeInfo<T>;
34
-
35
- protected abstract _getRootNodes(): T[]
36
-
37
- protected async _onNodeClick(_id: string | number) {
38
- }
39
-
40
- protected async _onNodeDoubleClick(_id: string | number) {
41
- }
42
-
43
- protected _cloneNodes(callback?: (t:TreeNodeInfo<T>)=>void, state?: TreeNodeInfo<T>[]): TreeNodeInfo<T>[] {
44
- return (state ?? this.state.nodes).map(n => {
45
- let res: TreeNodeInfo<T> = {
46
- ...n,
47
- childNodes: n.childNodes ? this._cloneNodes(callback, n.childNodes) : undefined
48
- }
49
- if(callback) callback(res)
50
- this._infoMap.set(n.id, res)
51
- return res
52
- })
53
- }
54
-
55
- protected _getNodePath(id: string, nodes?: TreeNodeInfo<T>[]): NodePath {
56
- let path1: NodePath|null = null
57
- this._forEachNode(nodes ?? this.state.nodes, (node, path) => {
58
- if (node.id === id) path1 = path
59
- })
60
- return path1 ?? []
61
- }
62
-
63
- protected _forEachNode<T>(nodes: TreeNodeInfo<T>[] | undefined, callback: (node: TreeNodeInfo<T>, path: NodePath) => void, path: NodePath = []) {
64
- if (nodes === undefined) {
65
- return nodes;
66
- }
67
- for (const node of nodes) {
68
- callback(node, path);
69
- this._forEachNode(node.childNodes, callback, [...path, node.id]);
70
- }
71
- return nodes
72
- }
73
-
74
- // protected _forNodeAtPath<T>(nodes: TreeNodeInfo<T>[], path: NodePath, callback: (node: TreeNodeInfo<T>) => void) {
75
- // callback(Tree.nodeFromPath(path, nodes));
76
- // }
77
-
78
- protected async _onNodeExpandCollapse(_id: string | number, expanded?: boolean) {
79
- const nodes = this._cloneNodes()
80
- const node = this._infoMap.get(_id)
81
- if (!node) return
82
- node.isExpanded = expanded ?? !node.isExpanded
83
- // forNodeAtPath(nodes, _path, node => (node.isExpanded = !node.isExpanded));
84
- await this.setStatePromise({...this.state, nodes})
85
- }
86
-
87
- protected async _onNodeContextMenu(_id: string | number) {
88
- }
89
-
90
- protected buildData(data: TreeNodeInfo<T>[], obj: T, _?: any, _2?: any) {
91
- if (!obj) return data
92
- const id = this._getNodeId(obj)
93
- if (!this._infoMap.has(id)) this._infoMap.set(id, this._createNodeInfo(id, obj))
94
- const node = this._infoMap.get(id)!
95
- const node2 = this._updateNodeInfo(node, obj)
96
- if (node2 !== node) this._infoMap.set(id, node2)
97
- data.push(node2)
98
- return data
99
- }
100
-
101
- getUpdatedState(_state: BPTreeComponentState<T>): BPTreeComponentState<T> {
102
- if (!this._infoMap) this._infoMap = new Map()
103
- const children = this._getRootNodes()
104
- const nodes = children.map(c => {
105
- return this.buildData([], c)[0]
106
- }).filter(v => v)
107
- return super.getUpdatedState({
108
- nodes
109
- })
110
- }
111
-
112
- deselectAll() {
113
- const nodes = this._cloneNodes(n => n.isSelected = false)
114
- return this.setStatePromise({...this.state, nodes})
115
- }
116
-
117
- async setSelected(id?: string|string[], expand = false) {
118
- const nodes =
119
- Array.isArray(id) ?
120
- this._cloneNodes(n => n.isSelected = id.includes(n.id as any)) :
121
- this._cloneNodes(n => n.isSelected = n.id === id)
122
- if(expand && id!==undefined){
123
- const ids = Array.isArray(id) ? id : [id]
124
- for (const id1 of ids) {
125
- const parents = this._getNodePath(id1, nodes)
126
- for (let i = 0; i < parents.length; i++) {
127
- const node = this._infoMap.get(parents[i])
128
- if(node) node.isExpanded = true
129
- }
130
- }
131
- }
132
- return this.setStatePromise({...this.state, nodes})
133
- }
134
-
135
- componentDidMount() {
136
- super.componentDidMount();
137
- }
138
-
139
- componentWillUnmount() {
140
- super.componentWillUnmount();
141
- }
142
-
143
- findSelectedNode(nodes?: TreeNodeInfo<T>[]): TreeNodeInfo<T> | undefined {
144
- if (!nodes) nodes = this.state.nodes
145
- for (const node of nodes) {
146
- if (node.isSelected) return node
147
- if (node.childNodes) {
148
- const res = this.findSelectedNode(node.childNodes)
149
- if (res) return res
150
- }
151
- }
152
- }
153
- getFlatNodes(onlyVisible = false, nodes?: TreeNodeInfo<T>[], res: TreeNodeInfo<T>[] = []): TreeNodeInfo<T>[] {
154
- if (!nodes) nodes = this.state.nodes
155
- for (const node of nodes) {
156
- res.push(node)
157
- if (node.childNodes && (!onlyVisible || node.isExpanded)) this.getFlatNodes(onlyVisible, node.childNodes, res)
158
- }
159
- return res
160
- }
161
-
162
- protected _handleKeyDown(e: React.KeyboardEvent) {
163
- const nodes = this.getFlatNodes(true)
164
- let current, next, previous;
165
- for (let i = 0; i < nodes.length; i++) {
166
- const node = nodes[i]
167
- if (node.isSelected) {
168
- current = node
169
- next = i < nodes.length - 1 ? nodes[i + 1] : undefined
170
- previous = i > 0 ? nodes[i - 1] : undefined
171
- break
172
- }
173
- }
174
- switch (e.key) {
175
- case "ArrowUp":
176
- if (previous) this._onNodeClick(previous.id)
177
- break
178
- case "ArrowDown":
179
- if (next) this._onNodeClick(next.id)
180
- break
181
- case "ArrowRight":
182
- if (current) this._onNodeExpandCollapse(current.id, true)
183
- break
184
- case "ArrowLeft":
185
- if (current) this._onNodeExpandCollapse(current.id, false)
186
- break
187
- case "Escape":
188
- if (current) this._onNodeClick(current.id)
189
- break
190
- case "Enter":
191
- if (current) this._onNodeDoubleClick(current.id)
192
- break
193
- default:
194
- return
195
- }
196
- e.preventDefault()
197
- e.stopPropagation()
198
- }
199
-
200
- protected _canDropNode(_sourceNode: TreeNodeInfo<T>, _sourcePath: NodePath, _targetNode: TreeNodeInfo<T>, _targetPath: NodePath, _index?: number) {
201
- return true
202
- }
203
- protected _onDropNode(_sourceNode: TreeNodeInfo<T>, _sourcePath: NodePath, _targetNode: TreeNodeInfo<T>, _targetPath: NodePath, _e?: React.DragEvent, _index?: number) {
204
- return
205
- }
206
-
207
- render() {
208
- const TreeT = Tree2.ofType<T>()
209
- return !this.state.hidden ? (
210
- <div
211
- style={{width: "100%", height: "100%"}}
212
- onKeyDown={e => this._handleKeyDown(e)}
213
- tabIndex={0}
214
- >
215
- <TreeT
216
- contents={this.state.nodes}
217
- className={"folderContent " + (this.props.className||'')}
218
- canDropNode={(node, path, targetNode, targetPath, index) => {
219
- return this._canDropNode(node, path, targetNode, targetPath, index)
220
- }}
221
- onNodeDrop={(node, path, targetNode, targetPath, e, index) => {
222
- // console.log(node, path, targetNode, targetPath, e);
223
- this._onDropNode(node, path, targetNode, targetPath, e, index)
224
- }}
225
- onNodeExpand={(node, _path, _e) => {
226
- this._onNodeExpandCollapse(node.id)
227
- }}
228
- onNodeCollapse={(node, _path, _e) => {
229
- this._onNodeExpandCollapse(node.id)
230
- }}
231
- onNodeClick={(node, _path, _e) => {
232
- this._onNodeClick(node.id)
233
- }}
234
- onNodeDoubleClick={(node, _path, _e) => {
235
- this._onNodeDoubleClick(node.id)
236
- }}
237
- onNodeContextMenu={(node, _path, _e) => {
238
- this._onNodeContextMenu(node.id)
239
- }}
240
- /></div>
241
- ) : null
242
- }
243
- }
244
-
@@ -1,31 +0,0 @@
1
- import {TreeNodeInfo} from "@blueprintjs/core";
2
- import {BPTreeComponent} from "./BPTreeComponent";
3
- import {UiObjectConfig} from 'uiconfig.js'
4
- import {getOrCall, uuidV4} from 'ts-browser-helpers'
5
-
6
- export class BPTreeFolderComponent extends BPTreeComponent<UiObjectConfig> {
7
-
8
- protected _getNodeId(obj: UiObjectConfig) {
9
- if(!obj.uuid) obj.uuid = uuidV4();
10
- return obj.uuid;
11
- }
12
-
13
- protected _updateNodeInfo(node: TreeNodeInfo<UiObjectConfig>, obj: UiObjectConfig) {
14
- node.label = getOrCall(obj.label) || 'unnamed'
15
- node.childNodes = this.context.methods.getChildren(this.props.config).reduce<any[]>((...args) => this.buildData(...args), [])
16
- return node;
17
- }
18
-
19
- protected _getRootNodes(): UiObjectConfig[] {
20
- return (this.props.config.children || []).map(c => getOrCall(c) || {}).flat(2) as UiObjectConfig[]
21
- }
22
-
23
- protected async _onNodeClick(_id: string|number) {
24
- console.log("TODO: Tree node clicked")
25
- }
26
-
27
- protected async _onNodeDoubleClick(_id: string|number) {
28
- console.log("TODO: Tree node double clicked")
29
- }
30
-
31
- }
@@ -1,344 +0,0 @@
1
- /*
2
- * Copyright 2015 Palantir Technologies, Inc. All rights reserved.
3
- *
4
- * Licensed under the Apache License, Version 2.0 (the "License");
5
- * you may not use this file except in compliance with the License.
6
- * You may obtain a copy of the License at
7
- *
8
- * http://www.apache.org/licenses/LICENSE-2.0
9
- *
10
- * Unless required by applicable law or agreed to in writing, software
11
- * distributed under the License is distributed on an "AS IS" BASIS,
12
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
- * See the License for the specific language governing permissions and
14
- * limitations under the License.
15
- *
16
- * Changes:
17
- * - Added support for drag and drop
18
- *
19
- */
20
- import classNames from "classnames";
21
- import * as React from "react";
22
-
23
- import type {TreeEventHandler} from "@blueprintjs/core";
24
- import {Classes, DISPLAYNAME_PREFIX, type Props} from "@blueprintjs/core";
25
- import {TreeNode2} from "./TreeNode2";
26
- import {TREE_NODE} from "@blueprintjs/core/lib/esnext/common/classes";
27
- import { TreeNodeInfo } from "./treeTypes";
28
-
29
- // eslint-disable-next-line @typescript-eslint/ban-types
30
- export interface TreeProps<T = {}> extends Props {
31
- /**
32
- * Whether to use a compact appearance which reduces the visual padding around node content.
33
- */
34
- compact?: boolean;
35
-
36
- /**
37
- * The data specifying the contents and appearance of the tree.
38
- */
39
- contents: ReadonlyArray<TreeNodeInfo<T>>;
40
-
41
- /**
42
- * Invoked when a node is clicked anywhere other than the caret for expanding/collapsing the node.
43
- */
44
- onNodeClick?: TreeEventHandler<T>;
45
-
46
- /**
47
- * Invoked when caret of an expanded node is clicked.
48
- */
49
- onNodeCollapse?: TreeEventHandler<T>;
50
-
51
- /**
52
- * Invoked when a node is right-clicked or the context menu button is pressed on a focused node.
53
- */
54
- onNodeContextMenu?: TreeEventHandler<T>;
55
-
56
- /**
57
- * Invoked when a node is double-clicked. Be careful when using this in combination with
58
- * an `onNodeClick` (single-click) handler, as the way this behaves can vary between browsers.
59
- * See http://stackoverflow.com/q/5497073/3124288
60
- */
61
- onNodeDoubleClick?: TreeEventHandler<T>;
62
-
63
- /**
64
- * Invoked when the caret of a collapsed node is clicked.
65
- */
66
- onNodeExpand?: TreeEventHandler<T>;
67
-
68
- /**
69
- * Invoked when the mouse is moved over a node.
70
- */
71
- onNodeMouseEnter?: TreeEventHandler<T>;
72
-
73
- /**
74
- * Invoked when the mouse is moved out of a node.
75
- */
76
- onNodeMouseLeave?: TreeEventHandler<T>;
77
-
78
- /**
79
- * Invoked when a node is dropped onto another node.
80
- */
81
- onNodeDrop?: (source: TreeNodeInfo<T>, sourcePath: number[], target: TreeNodeInfo<T>, targetPath: number[], event: React.DragEvent<HTMLElement>, index?: number) => void;
82
-
83
- /**
84
- * Invoked when a node drag starts.
85
- */
86
- onNodeDragStart?: (node: TreeNodeInfo<T>, path: number[], event: React.DragEvent<HTMLElement>) => void;
87
-
88
- /**
89
- * Invoked when a node is dragged over another node.
90
- */
91
- onNodeDragOver?: (node: TreeNodeInfo<T>, path: number[], event: React.DragEvent<HTMLElement>) => void;
92
-
93
- /**
94
- * Invoked when a node drag ends.
95
- */
96
- onNodeDragEnd?: (node: TreeNodeInfo<T>, path: number[], event: React.DragEvent<HTMLElement>) => void;
97
-
98
- /**
99
- * Invoked when a dragged node enters another node.
100
- */
101
- onNodeDragEnter?: (node: TreeNodeInfo<T>, path: number[], event: React.DragEvent<HTMLElement>) => void;
102
-
103
- /**
104
- * Invoked when a dragged node leaves another node.
105
- */
106
- onNodeDragLeave?: (node: TreeNodeInfo<T>, path: number[], event: React.DragEvent<HTMLElement>) => void;
107
-
108
- /**
109
- * A function that determines whether a node can be dropped onto another node.
110
- * @param source
111
- * @param target
112
- */
113
- canDropNode?: (source: TreeNodeInfo<T>, sourcePath: number[], target: TreeNodeInfo<T>, targetPath: number[], index?: number) => boolean;
114
- }
115
-
116
- /**
117
- * Tree component.
118
- *
119
- * @see https://blueprintjs.com/docs/#core/components/tree
120
- */
121
- // eslint-disable-next-line @typescript-eslint/ban-types
122
- export class Tree2<T = {}> extends React.Component<TreeProps<T>> {
123
- public static displayName = `${DISPLAYNAME_PREFIX}.Tree`;
124
-
125
- public static ofType<U>() {
126
- return Tree2 as new (props: TreeProps<U>) => Tree2<U>;
127
- }
128
-
129
- public static nodeFromPath<U>(
130
- path: readonly number[],
131
- treeNodes?: ReadonlyArray<TreeNodeInfo<U>>,
132
- ): TreeNodeInfo<U> {
133
- if (path.length === 1) {
134
- return treeNodes![path[0]];
135
- } else {
136
- return Tree2.nodeFromPath(path.slice(1), treeNodes![path[0]].childNodes);
137
- }
138
- }
139
-
140
- private nodeRefs: { [nodeId: string]: HTMLElement } = {};
141
- private dragSource: { node: TreeNodeInfo<T>; path: number[] } | null = null;
142
- private draggingNode?: { node: TreeNodeInfo<T>; path: number[] };
143
- private dragOverNode?: { node: TreeNodeInfo<T>; path: number[]; currentTarget?: HTMLElement };
144
- private rootRef: React.RefObject<HTMLDivElement> = React.createRef<HTMLDivElement>();
145
-
146
- public render() {
147
- return (
148
- <div
149
- className={classNames(Classes.TREE, this.props.className, {
150
- [Classes.COMPACT]: this.props.compact,
151
- })}
152
- ref={this.rootRef}
153
- >
154
- {this.renderNodes(this.props.contents, [], Classes.TREE_ROOT)}
155
- </div>
156
- );
157
- }
158
-
159
- /**
160
- * Returns the underlying HTML element of the `Tree` node with an id of `nodeId`.
161
- * This element does not contain the children of the node, only its label and controls.
162
- * If the node is not currently mounted, `undefined` is returned.
163
- */
164
- public getNodeContentElement(nodeId: string | number): HTMLElement | undefined {
165
- return this.nodeRefs[nodeId];
166
- }
167
- private renderNodeSpacer = (node: TreeNodeInfo<T>, path: number[], i: number)=> {
168
- return <li className={Classes.TREE + "-drop-spacer"}
169
- key={"drop-" + node.id + "-" + i}
170
- >
171
- <div
172
- onDragOver={(e) => this.handleNodeDragOver(node, path, e, i)}
173
- onDrop={(e) => this.handleNodeDrop(node, path, e, i)}
174
- onDragEnter={(e) => this.handleNodeDragEnter(node, path, e, i)}
175
- onDragLeave={(e) => this.handleNodeDragLeave(node, path, e, i)}
176
- ></div>
177
- </li>
178
- }
179
-
180
- private renderNodes(
181
- treeNodes: ReadonlyArray<TreeNodeInfo<T>> | undefined,
182
- currentPath?: number[],
183
- className?: string,
184
- parentNode?: TreeNodeInfo<T>,
185
- ) {
186
- if (treeNodes == null) {
187
- return null;
188
- }
189
-
190
- const nodeItems = treeNodes.map((node, i) => {
191
- const elementPath = currentPath!.concat(i);
192
- const draggable = !!node.draggable;
193
- const droppable = !!node.droppable;
194
- const parentDroppable = !!(parentNode && parentNode.droppable);
195
- return (<React.Fragment key={'wr-'+node.id}>
196
- {parentDroppable && i === 0 && this.renderNodeSpacer(parentNode, elementPath, i)}
197
- <TreeNode2<T>
198
- {...node}
199
- key={'node-'+node.id}
200
- contentRef={this.handleContentRef}
201
- depth={elementPath.length - 1}
202
- onClick={this.handleNodeClick}
203
- onContextMenu={this.handleNodeContextMenu}
204
- onCollapse={this.handleNodeCollapse}
205
- onDoubleClick={this.handleNodeDoubleClick}
206
- onExpand={this.handleNodeExpand}
207
- onMouseEnter={this.handleNodeMouseEnter}
208
- onMouseLeave={this.handleNodeMouseLeave}
209
- path={elementPath}
210
- draggable={draggable}
211
- onDragStart={draggable ? this.handleNodeDragStart : undefined}
212
- onDragEnd={draggable ? this.handleNodeDragEnd : undefined}
213
- onDragOver={droppable ? this.handleNodeDragOver : undefined}
214
- onDrop={droppable ? this.handleNodeDrop : undefined}
215
- onDragEnter={droppable ? this.handleNodeDragEnter : undefined}
216
- onDragLeave={droppable ? this.handleNodeDragLeave : undefined}
217
- >
218
- {this.renderNodes(node.childNodes, elementPath, undefined, node)}
219
- </TreeNode2>
220
- {parentDroppable && i >= 0 && this.renderNodeSpacer(parentNode, elementPath, i + 1)}
221
- </React.Fragment>)
222
- });
223
-
224
- return <ul className={classNames(Classes.TREE_NODE_LIST, className)}>{nodeItems}</ul>;
225
- }
226
-
227
- private handleContentRef = (node: TreeNodeInfo<T>, element: HTMLElement | null) => {
228
- if (element != null) {
229
- this.nodeRefs[node.id] = element;
230
- } else {
231
- // don't want our object to get bloated with old keys
232
- delete this.nodeRefs[node.id];
233
- }
234
- };
235
-
236
- private handleNodeCollapse = (node: TreeNodeInfo<T>, path: number[], e: React.MouseEvent<HTMLElement>) => {
237
- this.props.onNodeCollapse?.(node, path, e);
238
- };
239
-
240
- private handleNodeClick = (node: TreeNodeInfo<T>, path: number[], e: React.MouseEvent<HTMLElement>) => {
241
- this.props.onNodeClick?.(node, path, e);
242
- };
243
-
244
- private handleNodeContextMenu = (node: TreeNodeInfo<T>, path: number[], e: React.MouseEvent<HTMLElement>) => {
245
- this.props.onNodeContextMenu?.(node, path, e);
246
- };
247
-
248
- private handleNodeDoubleClick = (node: TreeNodeInfo<T>, path: number[], e: React.MouseEvent<HTMLElement>) => {
249
- this.props.onNodeDoubleClick?.(node, path, e);
250
- };
251
-
252
- private handleNodeExpand = (node: TreeNodeInfo<T>, path: number[], e: React.MouseEvent<HTMLElement>) => {
253
- this.props.onNodeExpand?.(node, path, e);
254
- };
255
-
256
- private handleNodeMouseEnter = (node: TreeNodeInfo<T>, path: number[], e: React.MouseEvent<HTMLElement>) => {
257
- this.props.onNodeMouseEnter?.(node, path, e);
258
- };
259
-
260
- private handleNodeMouseLeave = (node: TreeNodeInfo<T>, path: number[], e: React.MouseEvent<HTMLElement>) => {
261
- this.props.onNodeMouseLeave?.(node, path, e);
262
- };
263
-
264
- // Drag and drop handlers
265
- private handleNodeDragStart = (node: TreeNodeInfo<T>, path: number[], e: React.DragEvent<HTMLElement>) => {
266
- this.dragSource = { node, path };
267
- this.draggingNode = { node, path };
268
- this.rootRef?.current?.classList.add(Classes.TREE + "-dragging-node");
269
- this.addNodeClass(node, TREE_NODE + "-dragging");
270
- e.dataTransfer.effectAllowed = "move";
271
- try {
272
- e.dataTransfer.setData("application/json", JSON.stringify({ nodeId: node.id, path }));
273
- } catch {
274
- // ignore
275
- }
276
- this.props.onNodeDragStart?.(node, path, e);
277
- };
278
-
279
- private handleNodeDragOver = (node: TreeNodeInfo<T>, path: number[], e: React.DragEvent<HTMLElement>, index?: number) => {
280
- if (this.dragSource && this.props.canDropNode) {
281
- const canDrop = this.props.canDropNode(this.dragSource.node, this.dragSource.path, node, path, index);
282
- if (!canDrop) {
283
- e.dataTransfer.dropEffect = "none";
284
- e.preventDefault();
285
- return;
286
- }
287
- }
288
- const currentTarget = e.currentTarget as HTMLElement;
289
- if ((this.dragOverNode?.node.id !== node.id || this.dragOverNode?.currentTarget !== currentTarget) && this.draggingNode?.node.id !== node.id) {
290
- if (this.dragOverNode) this.removeNodeClass(this.dragOverNode.node, TREE_NODE + "-dragover", this.dragOverNode.currentTarget);
291
- this.dragOverNode = { node, path, currentTarget };
292
- this.addNodeClass(this.dragOverNode.node, TREE_NODE + "-dragover", this.dragOverNode.currentTarget);
293
- }
294
- e.preventDefault();
295
- e.dataTransfer.dropEffect = "move";
296
- this.props.onNodeDragOver?.(node, path, e);
297
- };
298
-
299
- private handleNodeDrop = (targetNode: TreeNodeInfo<T>, targetPath: number[], e: React.DragEvent<HTMLElement>, index?: number) => {
300
- e.preventDefault();
301
- const source = this.dragSource
302
- const canDrop = !source ? false : (this.props.canDropNode ? this.props.canDropNode(source.node, source.path, targetNode, targetPath, index) : true);
303
- if (this.dragOverNode) this.removeNodeClass(this.dragOverNode.node, TREE_NODE + "-dragover", this.dragOverNode.currentTarget);
304
- if (this.draggingNode) this.removeNodeClass(this.draggingNode.node, TREE_NODE + "-dragging");
305
- this.dragSource = null;
306
- this.draggingNode = undefined;
307
- this.rootRef?.current?.classList.remove(Classes.TREE + "-dragging-node");
308
- this.dragOverNode = undefined;
309
- if (canDrop && source && this.props.onNodeDrop) {
310
- this.props.onNodeDrop(source.node, source.path, targetNode, targetPath, e, index);
311
- }
312
- };
313
-
314
- private handleNodeDragEnd = (node: TreeNodeInfo<T>, path: number[], e: React.DragEvent<HTMLElement>, _index?: number) => {
315
- if (this.draggingNode) this.removeNodeClass(this.draggingNode.node, TREE_NODE + "-dragging");
316
- if (this.dragOverNode) this.removeNodeClass(this.dragOverNode.node, TREE_NODE + "-dragover", this.dragOverNode.currentTarget);
317
- this.dragSource = null;
318
- this.draggingNode = undefined;
319
- this.rootRef?.current?.classList.remove(Classes.TREE + "-dragging-node");
320
- this.dragOverNode = undefined;
321
- this.props.onNodeDragEnd?.(node, path, e);
322
- };
323
-
324
- private handleNodeDragEnter = (node: TreeNodeInfo<T>, path: number[], e: React.DragEvent<HTMLElement>, _index?: number) => {
325
- this.props.onNodeDragEnter?.(node, path, e);
326
- };
327
-
328
- private handleNodeDragLeave = (node: TreeNodeInfo<T>, path: number[], e: React.DragEvent<HTMLElement>, _index?: number) => {
329
- if (this.dragOverNode) this.removeNodeClass(this.dragOverNode.node, TREE_NODE + "-dragover", this.dragOverNode.currentTarget);
330
- this.dragOverNode = undefined;
331
- this.props.onNodeDragLeave?.(node, path, e);
332
- };
333
-
334
- private addNodeClass = (node: TreeNodeInfo<T>|number[], className: string, currentTarget?: HTMLElement) => {
335
- const el = this.nodeRefs[!Array.isArray(node) ? node.id : Tree2.nodeFromPath(node, this.props.contents).id];
336
- if (el) el.classList.add(className);
337
- if(currentTarget) currentTarget.classList.add(className);
338
- }
339
- private removeNodeClass = (node: TreeNodeInfo<T>|number[], className: string, currentTarget?: HTMLElement) => {
340
- const el = this.nodeRefs[!Array.isArray(node) ? node.id : Tree2.nodeFromPath(node, this.props.contents).id];
341
- if (el) el.classList.remove(className);
342
- if(currentTarget) currentTarget.classList.remove(className);
343
- }
344
- }