@theia/core 1.53.0-next.5 → 1.53.0-next.55

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 (689) hide show
  1. package/README.md +7 -7
  2. package/i18n/nls.cs.json +582 -552
  3. package/i18n/nls.de.json +582 -552
  4. package/i18n/nls.es.json +582 -552
  5. package/i18n/nls.fr.json +582 -552
  6. package/i18n/nls.hu.json +582 -552
  7. package/i18n/nls.it.json +582 -552
  8. package/i18n/nls.ja.json +582 -552
  9. package/i18n/nls.json +582 -552
  10. package/i18n/nls.ko.json +582 -0
  11. package/i18n/nls.pl.json +582 -552
  12. package/i18n/nls.pt-br.json +582 -552
  13. package/i18n/nls.ru.json +582 -552
  14. package/i18n/nls.tr.json +582 -0
  15. package/i18n/nls.zh-cn.json +582 -552
  16. package/i18n/nls.zh-tw.json +582 -0
  17. package/lib/browser/authentication-service.d.ts +15 -14
  18. package/lib/browser/authentication-service.d.ts.map +1 -1
  19. package/lib/browser/authentication-service.js +5 -5
  20. package/lib/browser/authentication-service.js.map +1 -1
  21. package/lib/browser/catalog.json +6889 -0
  22. package/lib/browser/common-frontend-contribution.js +3 -3
  23. package/lib/browser/common-styling-participants.js +166 -166
  24. package/lib/browser/context-key-service.d.ts +3 -2
  25. package/lib/browser/context-key-service.d.ts.map +1 -1
  26. package/lib/browser/context-key-service.js.map +1 -1
  27. package/lib/browser/core-preferences.d.ts.map +1 -1
  28. package/lib/browser/core-preferences.js +9 -0
  29. package/lib/browser/core-preferences.js.map +1 -1
  30. package/lib/browser/frontend-application-module.d.ts.map +1 -1
  31. package/lib/browser/frontend-application-module.js.map +1 -1
  32. package/lib/browser/json-schema-store.d.ts +0 -3
  33. package/lib/browser/json-schema-store.d.ts.map +1 -1
  34. package/lib/browser/json-schema-store.js +2 -12
  35. package/lib/browser/json-schema-store.js.map +1 -1
  36. package/lib/browser/open-with-service.d.ts +13 -1
  37. package/lib/browser/open-with-service.d.ts.map +1 -1
  38. package/lib/browser/open-with-service.js +48 -9
  39. package/lib/browser/open-with-service.js.map +1 -1
  40. package/lib/browser/opener-service.d.ts +8 -0
  41. package/lib/browser/opener-service.d.ts.map +1 -1
  42. package/lib/browser/opener-service.js +18 -3
  43. package/lib/browser/opener-service.js.map +1 -1
  44. package/lib/browser/progress-location-service.spec.js +7 -7
  45. package/lib/browser/saveable-service.d.ts.map +1 -1
  46. package/lib/browser/saveable-service.js +6 -2
  47. package/lib/browser/saveable-service.js.map +1 -1
  48. package/lib/browser/saveable.d.ts +17 -1
  49. package/lib/browser/saveable.d.ts.map +1 -1
  50. package/lib/browser/saveable.js +62 -1
  51. package/lib/browser/saveable.js.map +1 -1
  52. package/lib/browser/shell/tab-bar-toolbar/tab-bar-toolbar-menu-adapters.d.ts +5 -4
  53. package/lib/browser/shell/tab-bar-toolbar/tab-bar-toolbar-menu-adapters.d.ts.map +1 -1
  54. package/lib/browser/shell/tab-bar-toolbar/tab-bar-toolbar-menu-adapters.js +2 -1
  55. package/lib/browser/shell/tab-bar-toolbar/tab-bar-toolbar-menu-adapters.js.map +1 -1
  56. package/lib/browser/shell/tab-bar-toolbar/tab-bar-toolbar-registry.d.ts +6 -16
  57. package/lib/browser/shell/tab-bar-toolbar/tab-bar-toolbar-registry.d.ts.map +1 -1
  58. package/lib/browser/shell/tab-bar-toolbar/tab-bar-toolbar-registry.js +12 -29
  59. package/lib/browser/shell/tab-bar-toolbar/tab-bar-toolbar-registry.js.map +1 -1
  60. package/lib/browser/shell/tab-bar-toolbar/tab-bar-toolbar-types.d.ts +43 -78
  61. package/lib/browser/shell/tab-bar-toolbar/tab-bar-toolbar-types.d.ts.map +1 -1
  62. package/lib/browser/shell/tab-bar-toolbar/tab-bar-toolbar-types.js +8 -39
  63. package/lib/browser/shell/tab-bar-toolbar/tab-bar-toolbar-types.js.map +1 -1
  64. package/lib/browser/shell/tab-bar-toolbar/tab-bar-toolbar.d.ts +10 -10
  65. package/lib/browser/shell/tab-bar-toolbar/tab-bar-toolbar.d.ts.map +1 -1
  66. package/lib/browser/shell/tab-bar-toolbar/tab-bar-toolbar.js +43 -32
  67. package/lib/browser/shell/tab-bar-toolbar/tab-bar-toolbar.js.map +1 -1
  68. package/lib/browser/storage-service.js +3 -3
  69. package/lib/browser/tree/tree.spec.js +75 -75
  70. package/lib/browser/view-container.d.ts +2 -2
  71. package/lib/browser/view-container.d.ts.map +1 -1
  72. package/lib/browser/view-container.js.map +1 -1
  73. package/lib/browser/widget-open-handler.d.ts +4 -1
  74. package/lib/browser/widget-open-handler.d.ts.map +1 -1
  75. package/lib/browser/widget-open-handler.js.map +1 -1
  76. package/lib/browser/widgets/extractable-widget.js +1 -1
  77. package/lib/browser/widgets/extractable-widget.js.map +1 -1
  78. package/lib/browser/widgets/index.d.ts +1 -0
  79. package/lib/browser/widgets/index.d.ts.map +1 -1
  80. package/lib/browser/widgets/index.js +1 -0
  81. package/lib/browser/widgets/index.js.map +1 -1
  82. package/lib/browser/widgets/split-widget.d.ts +45 -0
  83. package/lib/browser/widgets/split-widget.d.ts.map +1 -0
  84. package/lib/browser/widgets/split-widget.js +126 -0
  85. package/lib/browser/widgets/split-widget.js.map +1 -0
  86. package/lib/common/event.d.ts +2 -0
  87. package/lib/common/event.d.ts.map +1 -1
  88. package/lib/common/event.js +4 -0
  89. package/lib/common/event.js.map +1 -1
  90. package/lib/common/glob.d.ts +4 -4
  91. package/lib/common/json-schema.d.ts +2 -0
  92. package/lib/common/json-schema.d.ts.map +1 -1
  93. package/lib/common/menu/menu-types.d.ts.map +1 -1
  94. package/lib/common/menu/menu-types.js.map +1 -1
  95. package/lib/electron-browser/electron-uri-handler.d.ts +6 -0
  96. package/lib/electron-browser/electron-uri-handler.d.ts.map +1 -0
  97. package/lib/electron-browser/electron-uri-handler.js +49 -0
  98. package/lib/electron-browser/electron-uri-handler.js.map +1 -0
  99. package/lib/electron-browser/menu/electron-main-menu-factory.d.ts +1 -1
  100. package/lib/electron-browser/menu/electron-main-menu-factory.d.ts.map +1 -1
  101. package/lib/electron-browser/menu/electron-main-menu-factory.js +6 -6
  102. package/lib/electron-browser/menu/electron-main-menu-factory.js.map +1 -1
  103. package/lib/electron-browser/preload.d.ts.map +1 -1
  104. package/lib/electron-browser/preload.js +12 -0
  105. package/lib/electron-browser/preload.js.map +1 -1
  106. package/lib/electron-browser/window/electron-window-module.d.ts.map +1 -1
  107. package/lib/electron-browser/window/electron-window-module.js +3 -0
  108. package/lib/electron-browser/window/electron-window-module.js.map +1 -1
  109. package/lib/electron-browser/window/external-app-open-handler.js +1 -1
  110. package/lib/electron-browser/window/external-app-open-handler.js.map +1 -1
  111. package/lib/electron-common/electron-api.d.ts +2 -0
  112. package/lib/electron-common/electron-api.d.ts.map +1 -1
  113. package/lib/electron-common/electron-api.js +2 -1
  114. package/lib/electron-common/electron-api.js.map +1 -1
  115. package/lib/electron-main/electron-api-main.d.ts +2 -0
  116. package/lib/electron-main/electron-api-main.d.ts.map +1 -1
  117. package/lib/electron-main/electron-api-main.js +27 -3
  118. package/lib/electron-main/electron-api-main.js.map +1 -1
  119. package/lib/electron-main/electron-main-application.d.ts +5 -3
  120. package/lib/electron-main/electron-main-application.d.ts.map +1 -1
  121. package/lib/electron-main/electron-main-application.js +57 -14
  122. package/lib/electron-main/electron-main-application.js.map +1 -1
  123. package/lib/electron-main/theia-electron-window.d.ts +1 -0
  124. package/lib/electron-main/theia-electron-window.d.ts.map +1 -1
  125. package/lib/electron-main/theia-electron-window.js +3 -0
  126. package/lib/electron-main/theia-electron-window.js.map +1 -1
  127. package/lib/node/i18n/theia-localization-contribution.d.ts.map +1 -1
  128. package/lib/node/i18n/theia-localization-contribution.js +12 -8
  129. package/lib/node/i18n/theia-localization-contribution.js.map +1 -1
  130. package/lib/node/process-utils.spec.js +8 -8
  131. package/package.json +10 -8
  132. package/shared/ajv/index.d.ts +2 -2
  133. package/shared/markdown-it.d.ts +2 -2
  134. package/shared/markdown-it.js +1 -1
  135. package/shared/reflect-metadata/index.d.ts +1 -1
  136. package/shared/reflect-metadata/index.js +1 -1
  137. package/shared/vscode-languageserver-types/index.d.ts +1 -1
  138. package/src/browser/about-dialog.tsx +137 -137
  139. package/src/browser/authentication-service.ts +467 -468
  140. package/src/browser/breadcrumbs/breadcrumb-popup-container.ts +101 -101
  141. package/src/browser/breadcrumbs/breadcrumb-renderer.tsx +41 -41
  142. package/src/browser/breadcrumbs/breadcrumbs-constants.ts +79 -79
  143. package/src/browser/breadcrumbs/breadcrumbs-renderer.tsx +185 -185
  144. package/src/browser/breadcrumbs/breadcrumbs-service.ts +108 -108
  145. package/src/browser/breadcrumbs/index.ts +21 -21
  146. package/src/browser/browser-clipboard-service.ts +122 -122
  147. package/src/browser/browser.ts +239 -239
  148. package/src/browser/clipboard-service.ts +23 -23
  149. package/src/browser/color-application-contribution.ts +110 -110
  150. package/src/browser/color-registry.ts +60 -60
  151. package/src/browser/command-open-handler.ts +54 -54
  152. package/src/browser/common-frontend-contribution.ts +2680 -2680
  153. package/src/browser/common-styling-participants.ts +361 -361
  154. package/src/browser/connection-status-service.spec.ts +200 -200
  155. package/src/browser/connection-status-service.ts +216 -216
  156. package/src/browser/context-key-service.ts +142 -142
  157. package/src/browser/context-menu-renderer.ts +124 -124
  158. package/src/browser/core-preferences.ts +343 -334
  159. package/src/browser/credentials-service.ts +106 -106
  160. package/src/browser/decoration-style.ts +65 -65
  161. package/src/browser/decorations-service.ts +209 -209
  162. package/src/browser/dialogs/react-dialog.tsx +56 -56
  163. package/src/browser/dialogs.ts +534 -534
  164. package/src/browser/diff-uris.ts +117 -117
  165. package/src/browser/encoding-registry.ts +97 -97
  166. package/src/browser/endpoint.spec.ts +148 -148
  167. package/src/browser/endpoint.ts +136 -136
  168. package/src/browser/external-uri-service.ts +79 -79
  169. package/src/browser/file-icons-js.d.ts +20 -20
  170. package/src/browser/frontend-application-bindings.ts +62 -62
  171. package/src/browser/frontend-application-config-provider.spec.ts +45 -45
  172. package/src/browser/frontend-application-config-provider.ts +50 -50
  173. package/src/browser/frontend-application-contribution.ts +110 -110
  174. package/src/browser/frontend-application-module.ts +474 -475
  175. package/src/browser/frontend-application-state.ts +74 -74
  176. package/src/browser/frontend-application.ts +326 -326
  177. package/src/browser/hover-service.ts +218 -218
  178. package/src/browser/http-open-handler.ts +49 -49
  179. package/src/browser/i18n/i18n-frontend-module.ts +27 -27
  180. package/src/browser/i18n/language-quick-pick-service.ts +130 -130
  181. package/src/browser/icon-registry.ts +87 -87
  182. package/src/browser/icon-theme-contribution.ts +64 -64
  183. package/src/browser/icon-theme-service.ts +217 -217
  184. package/src/browser/icons/CollapseAll.svg +7 -7
  185. package/src/browser/icons/CollapseAll_inverse.svg +7 -7
  186. package/src/browser/icons/Refresh.svg +7 -7
  187. package/src/browser/icons/Refresh_inverse.svg +7 -7
  188. package/src/browser/icons/add-inverse.svg +4 -4
  189. package/src/browser/icons/add.svg +4 -4
  190. package/src/browser/icons/arrow-down-bright.svg +6 -6
  191. package/src/browser/icons/arrow-down-dark.svg +6 -6
  192. package/src/browser/icons/arrow-up-bright.svg +6 -6
  193. package/src/browser/icons/arrow-up-dark.svg +6 -6
  194. package/src/browser/icons/case-sensitive-dark.svg +16 -16
  195. package/src/browser/icons/case-sensitive.svg +16 -16
  196. package/src/browser/icons/chevron-right-dark.svg +5 -5
  197. package/src/browser/icons/chevron-right-light.svg +6 -6
  198. package/src/browser/icons/circle-bright.svg +7 -7
  199. package/src/browser/icons/circle-dark.svg +7 -7
  200. package/src/browser/icons/clear-search-results-dark.svg +7 -7
  201. package/src/browser/icons/clear-search-results.svg +7 -7
  202. package/src/browser/icons/close-all-bright.svg +7 -7
  203. package/src/browser/icons/close-all-dark.svg +7 -7
  204. package/src/browser/icons/close-bright.svg +7 -7
  205. package/src/browser/icons/close-dark.svg +7 -7
  206. package/src/browser/icons/collapse.svg +4 -4
  207. package/src/browser/icons/edit-json-dark.svg +6 -6
  208. package/src/browser/icons/edit-json.svg +6 -6
  209. package/src/browser/icons/expand.svg +4 -4
  210. package/src/browser/icons/loading-dark.svg +6 -6
  211. package/src/browser/icons/loading-light.svg +6 -6
  212. package/src/browser/icons/open-change-bright.svg +3 -3
  213. package/src/browser/icons/open-change-dark.svg +4 -4
  214. package/src/browser/icons/open-file-bright.svg +4 -4
  215. package/src/browser/icons/open-file-dark.svg +4 -4
  216. package/src/browser/icons/preview-bright.svg +3 -3
  217. package/src/browser/icons/preview-dark.svg +3 -3
  218. package/src/browser/icons/regex-dark.svg +10 -10
  219. package/src/browser/icons/regex.svg +10 -10
  220. package/src/browser/icons/remove-all-inverse.svg +4 -4
  221. package/src/browser/icons/remove-all.svg +4 -4
  222. package/src/browser/icons/replace-all-inverse.svg +13 -13
  223. package/src/browser/icons/replace-all.svg +13 -13
  224. package/src/browser/icons/replace-inverse.svg +15 -15
  225. package/src/browser/icons/replace.svg +15 -15
  226. package/src/browser/icons/whole-word-dark.svg +19 -19
  227. package/src/browser/icons/whole-word.svg +19 -19
  228. package/src/browser/index.ts +50 -50
  229. package/src/browser/json-schema-store.ts +118 -127
  230. package/src/browser/keybinding.spec.ts +554 -554
  231. package/src/browser/keybinding.ts +759 -759
  232. package/src/browser/keyboard/browser-keyboard-frontend-contribution.ts +108 -108
  233. package/src/browser/keyboard/browser-keyboard-layout-provider.spec.ts +171 -171
  234. package/src/browser/keyboard/browser-keyboard-layout-provider.ts +469 -469
  235. package/src/browser/keyboard/browser-keyboard-module.ts +30 -30
  236. package/src/browser/keyboard/index.ts +20 -20
  237. package/src/browser/keyboard/keyboard-layout-service.spec.ts +121 -121
  238. package/src/browser/keyboard/keyboard-layout-service.ts +455 -455
  239. package/src/browser/keyboard/keys.spec.ts +258 -258
  240. package/src/browser/keyboard/keys.ts +20 -20
  241. package/src/browser/keys.ts +21 -21
  242. package/src/browser/label-parser.spec.ts +165 -165
  243. package/src/browser/label-parser.ts +108 -108
  244. package/src/browser/label-provider.spec.ts +62 -62
  245. package/src/browser/label-provider.ts +385 -385
  246. package/src/browser/language-icon-provider.ts +55 -55
  247. package/src/browser/language-service.ts +77 -77
  248. package/src/browser/logger-frontend-module.ts +65 -65
  249. package/src/browser/markdown-rendering/markdown-renderer.ts +98 -98
  250. package/src/browser/menu/browser-context-menu-renderer.ts +48 -48
  251. package/src/browser/menu/browser-menu-module.ts +28 -28
  252. package/src/browser/menu/browser-menu-plugin.ts +491 -491
  253. package/src/browser/menu/context-menu-context.ts +41 -41
  254. package/src/browser/messaging/connection-source.ts +26 -26
  255. package/src/browser/messaging/frontend-id-provider.ts +37 -37
  256. package/src/browser/messaging/index.ts +18 -18
  257. package/src/browser/messaging/messaging-frontend-module.ts +41 -41
  258. package/src/browser/messaging/service-connection-provider.ts +140 -140
  259. package/src/browser/messaging/ws-connection-provider.ts +49 -49
  260. package/src/browser/messaging/ws-connection-source.ts +230 -230
  261. package/src/browser/mime-service.ts +30 -30
  262. package/src/browser/navigatable-types.ts +81 -81
  263. package/src/browser/navigatable.ts +39 -39
  264. package/src/browser/open-with-service.ts +140 -93
  265. package/src/browser/opener-service.spec.ts +49 -49
  266. package/src/browser/opener-service.ts +169 -146
  267. package/src/browser/performance/frontend-stopwatch.ts +65 -65
  268. package/src/browser/performance/index.ts +18 -18
  269. package/src/browser/performance/measurement-frontend-bindings.ts +31 -31
  270. package/src/browser/preferences/index.ts +23 -23
  271. package/src/browser/preferences/injectable-preference-proxy.ts +283 -283
  272. package/src/browser/preferences/preference-configurations.ts +82 -82
  273. package/src/browser/preferences/preference-contribution.ts +436 -436
  274. package/src/browser/preferences/preference-language-override-service.ts +111 -111
  275. package/src/browser/preferences/preference-provider.spec.ts +36 -36
  276. package/src/browser/preferences/preference-provider.ts +277 -277
  277. package/src/browser/preferences/preference-proxy.spec.ts +367 -367
  278. package/src/browser/preferences/preference-proxy.ts +367 -367
  279. package/src/browser/preferences/preference-schema-provider.spec.ts +130 -130
  280. package/src/browser/preferences/preference-scope.ts +18 -18
  281. package/src/browser/preferences/preference-service.spec.ts +613 -613
  282. package/src/browser/preferences/preference-service.ts +594 -594
  283. package/src/browser/preferences/preference-validation-service.spec.ts +334 -334
  284. package/src/browser/preferences/preference-validation-service.ts +358 -358
  285. package/src/browser/preferences/test/index.ts +19 -19
  286. package/src/browser/preferences/test/mock-preference-provider.ts +50 -50
  287. package/src/browser/preferences/test/mock-preference-proxy.ts +48 -48
  288. package/src/browser/preferences/test/mock-preference-service.ts +63 -63
  289. package/src/browser/preload/i18n-preload-contribution.ts +50 -50
  290. package/src/browser/preload/os-preload-contribution.ts +37 -37
  291. package/src/browser/preload/preload-module.ts +45 -45
  292. package/src/browser/preload/preloader.ts +37 -37
  293. package/src/browser/preload/theme-preload-contribution.ts +31 -31
  294. package/src/browser/progress-bar-factory.ts +29 -29
  295. package/src/browser/progress-bar.ts +76 -76
  296. package/src/browser/progress-client.ts +53 -53
  297. package/src/browser/progress-location-service.spec.ts +50 -50
  298. package/src/browser/progress-location-service.ts +96 -96
  299. package/src/browser/progress-status-bar-item.ts +83 -83
  300. package/src/browser/quick-input/index.ts +23 -23
  301. package/src/browser/quick-input/quick-access.ts +75 -75
  302. package/src/browser/quick-input/quick-command-frontend-contribution.ts +89 -89
  303. package/src/browser/quick-input/quick-command-service.ts +246 -246
  304. package/src/browser/quick-input/quick-help-service.ts +87 -87
  305. package/src/browser/quick-input/quick-input-frontend-contribution.ts +33 -33
  306. package/src/browser/quick-input/quick-input-service.spec.ts +176 -176
  307. package/src/browser/quick-input/quick-input-service.ts +17 -17
  308. package/src/browser/quick-input/quick-pick-service-impl.ts +69 -69
  309. package/src/browser/quick-input/quick-view-service.ts +83 -83
  310. package/src/browser/request/browser-request-module.ts +23 -23
  311. package/src/browser/request/browser-request-service.ts +172 -172
  312. package/src/browser/resource-context-key.ts +77 -77
  313. package/src/browser/saveable-service.ts +332 -328
  314. package/src/browser/saveable.ts +395 -327
  315. package/src/browser/secondary-window-handler.ts +211 -211
  316. package/src/browser/shell/additional-views-menu-widget.tsx +71 -71
  317. package/src/browser/shell/application-shell-mouse-tracker.ts +103 -103
  318. package/src/browser/shell/application-shell.ts +2271 -2271
  319. package/src/browser/shell/current-widget-command-adapter.ts +57 -57
  320. package/src/browser/shell/index.ts +23 -23
  321. package/src/browser/shell/shell-layout-restorer.ts +399 -399
  322. package/src/browser/shell/side-panel-handler.ts +794 -794
  323. package/src/browser/shell/side-panel-toolbar.ts +111 -111
  324. package/src/browser/shell/sidebar-bottom-menu-widget.tsx +39 -39
  325. package/src/browser/shell/sidebar-menu-widget.tsx +183 -183
  326. package/src/browser/shell/sidebar-top-menu-widget.tsx +26 -26
  327. package/src/browser/shell/split-panels.ts +191 -191
  328. package/src/browser/shell/tab-bar-decorator.ts +106 -106
  329. package/src/browser/shell/tab-bar-toolbar/index.ts +19 -19
  330. package/src/browser/shell/tab-bar-toolbar/tab-bar-toolbar-menu-adapters.ts +31 -31
  331. package/src/browser/shell/tab-bar-toolbar/tab-bar-toolbar-registry.ts +242 -256
  332. package/src/browser/shell/tab-bar-toolbar/tab-bar-toolbar-types.ts +149 -207
  333. package/src/browser/shell/tab-bar-toolbar/tab-bar-toolbar.spec.ts +62 -62
  334. package/src/browser/shell/tab-bar-toolbar/tab-bar-toolbar.tsx +443 -428
  335. package/src/browser/shell/tab-bars.spec.ts +63 -63
  336. package/src/browser/shell/tab-bars.ts +1468 -1468
  337. package/src/browser/shell/theia-dock-panel.ts +265 -265
  338. package/src/browser/shell/view-column-service.ts +125 -125
  339. package/src/browser/shell/view-contribution.ts +178 -178
  340. package/src/browser/source-tree/index.ts +19 -19
  341. package/src/browser/source-tree/source-tree-widget.tsx +107 -107
  342. package/src/browser/source-tree/source-tree.ts +146 -146
  343. package/src/browser/source-tree/tree-source.ts +73 -73
  344. package/src/browser/status-bar/index.ts +29 -29
  345. package/src/browser/status-bar/status-bar-types.ts +97 -97
  346. package/src/browser/status-bar/status-bar-view-model.ts +209 -209
  347. package/src/browser/status-bar/status-bar.tsx +189 -189
  348. package/src/browser/storage-service.spec.ts +76 -76
  349. package/src/browser/storage-service.ts +129 -129
  350. package/src/browser/style/about.css +36 -36
  351. package/src/browser/style/alert-messages.css +62 -62
  352. package/src/browser/style/ansi.css +88 -88
  353. package/src/browser/style/breadcrumbs.css +130 -130
  354. package/src/browser/style/dialog.css +126 -126
  355. package/src/browser/style/dockpanel.css +76 -76
  356. package/src/browser/style/hover-service.css +101 -101
  357. package/src/browser/style/icons.css +61 -61
  358. package/src/browser/style/index.css +353 -352
  359. package/src/browser/style/materialcolors.css +278 -278
  360. package/src/browser/style/menus.css +230 -230
  361. package/src/browser/style/notification.css +39 -39
  362. package/src/browser/style/os.css +87 -87
  363. package/src/browser/style/progress-bar.css +43 -43
  364. package/src/browser/style/quick-title-bar.css +45 -45
  365. package/src/browser/style/scrollbars.css +172 -172
  366. package/src/browser/style/search-box.css +123 -123
  367. package/src/browser/style/select-component.css +107 -107
  368. package/src/browser/style/sidepanel.css +367 -367
  369. package/src/browser/style/split-widget.css +38 -0
  370. package/src/browser/style/status-bar.css +127 -127
  371. package/src/browser/style/tabs.css +647 -658
  372. package/src/browser/style/tooltip.css +28 -28
  373. package/src/browser/style/tree-decorators.css +81 -81
  374. package/src/browser/style/tree.css +232 -232
  375. package/src/browser/style/view-container.css +187 -194
  376. package/src/browser/style/widget.css +19 -19
  377. package/src/browser/styling-service.ts +96 -96
  378. package/src/browser/supported-encodings.ts +262 -262
  379. package/src/browser/test/jsdom.ts +69 -69
  380. package/src/browser/test/mock-connection-status-service.ts +33 -33
  381. package/src/browser/test/mock-env-variables-server.ts +47 -47
  382. package/src/browser/test/mock-opener-service.ts +34 -34
  383. package/src/browser/test/mock-storage-service.ts +49 -49
  384. package/src/browser/theming.ts +206 -206
  385. package/src/browser/tooltip-service.tsx +96 -96
  386. package/src/browser/tree/fuzzy-search.spec.ts +99 -99
  387. package/src/browser/tree/fuzzy-search.ts +136 -136
  388. package/src/browser/tree/index.ts +29 -29
  389. package/src/browser/tree/search-box-debounce.ts +96 -96
  390. package/src/browser/tree/search-box.ts +355 -355
  391. package/src/browser/tree/test/mock-selectable-tree-model.ts +109 -109
  392. package/src/browser/tree/test/mock-tree-model.ts +136 -136
  393. package/src/browser/tree/test/tree-test-container.ts +50 -50
  394. package/src/browser/tree/tree-compression/compressed-tree-expansion-service.ts +46 -46
  395. package/src/browser/tree/tree-compression/compressed-tree-model.ts +88 -88
  396. package/src/browser/tree/tree-compression/compressed-tree-widget.tsx +203 -203
  397. package/src/browser/tree/tree-compression/index.ts +20 -20
  398. package/src/browser/tree/tree-compression/tree-compression-service.ts +125 -125
  399. package/src/browser/tree/tree-compression/tree-compression.css +28 -28
  400. package/src/browser/tree/tree-consistency.spec.ts +105 -105
  401. package/src/browser/tree/tree-container.spec.ts +45 -45
  402. package/src/browser/tree/tree-container.ts +155 -155
  403. package/src/browser/tree/tree-decorator.spec.ts +162 -162
  404. package/src/browser/tree/tree-decorator.ts +238 -238
  405. package/src/browser/tree/tree-expansion.spec.ts +173 -173
  406. package/src/browser/tree/tree-expansion.ts +165 -165
  407. package/src/browser/tree/tree-focus-service.ts +55 -55
  408. package/src/browser/tree/tree-iterator.spec.ts +170 -170
  409. package/src/browser/tree/tree-iterator.ts +256 -256
  410. package/src/browser/tree/tree-label-provider.ts +40 -40
  411. package/src/browser/tree/tree-model.ts +562 -562
  412. package/src/browser/tree/tree-navigation.ts +58 -58
  413. package/src/browser/tree/tree-preference.ts +50 -50
  414. package/src/browser/tree/tree-search.ts +128 -128
  415. package/src/browser/tree/tree-selectable.spec.ts +152 -152
  416. package/src/browser/tree/tree-selection-impl.ts +176 -176
  417. package/src/browser/tree/tree-selection-state.spec.ts +462 -462
  418. package/src/browser/tree/tree-selection-state.ts +245 -245
  419. package/src/browser/tree/tree-selection.ts +159 -159
  420. package/src/browser/tree/tree-view-welcome-widget.tsx +263 -263
  421. package/src/browser/tree/tree-widget-selection.ts +45 -45
  422. package/src/browser/tree/tree-widget.tsx +1591 -1591
  423. package/src/browser/tree/tree.spec.ts +241 -241
  424. package/src/browser/tree/tree.ts +425 -425
  425. package/src/browser/undo-redo-handler.ts +85 -85
  426. package/src/browser/user-working-directory-provider.ts +77 -77
  427. package/src/browser/view-container.ts +1640 -1640
  428. package/src/browser/widget-decoration.ts +358 -358
  429. package/src/browser/widget-manager.spec.ts +102 -102
  430. package/src/browser/widget-manager.ts +318 -318
  431. package/src/browser/widget-open-handler.ts +168 -165
  432. package/src/browser/widgets/alert-message.tsx +56 -56
  433. package/src/browser/widgets/enhanced-preview-widget.ts +27 -27
  434. package/src/browser/widgets/extractable-widget.ts +33 -33
  435. package/src/browser/widgets/index.ts +21 -20
  436. package/src/browser/widgets/previewable-widget.ts +31 -31
  437. package/src/browser/widgets/react-renderer.tsx +53 -53
  438. package/src/browser/widgets/react-widget.tsx +51 -51
  439. package/src/browser/widgets/select-component.tsx +367 -367
  440. package/src/browser/widgets/split-widget.ts +163 -0
  441. package/src/browser/widgets/widget.ts +406 -406
  442. package/src/browser/window/browser-window-module.ts +32 -32
  443. package/src/browser/window/default-secondary-window-service.ts +189 -189
  444. package/src/browser/window/default-window-service.spec.ts +78 -78
  445. package/src/browser/window/default-window-service.ts +171 -171
  446. package/src/browser/window/secondary-window-service.ts +39 -39
  447. package/src/browser/window/test/mock-window-service.ts +29 -29
  448. package/src/browser/window/window-service.ts +78 -78
  449. package/src/browser/window/window-title-service.ts +107 -107
  450. package/src/browser/window/window-title-updater.ts +95 -95
  451. package/src/browser/window-contribution.ts +64 -64
  452. package/src/browser-only/frontend-only-application-module.ts +116 -116
  453. package/src/browser-only/i18n/i18n-frontend-only-module.ts +37 -37
  454. package/src/browser-only/logger-frontend-only-module.ts +63 -63
  455. package/src/browser-only/messaging/frontend-only-service-connection-provider.ts +39 -39
  456. package/src/browser-only/messaging/messaging-frontend-only-module.ts +42 -42
  457. package/src/browser-only/preload/frontend-only-preload-module.ts +49 -49
  458. package/src/common/accessibility.ts +33 -33
  459. package/src/common/application-error.spec.ts +27 -27
  460. package/src/common/application-error.ts +76 -76
  461. package/src/common/application-protocol.ts +42 -42
  462. package/src/common/array-utils.ts +129 -129
  463. package/src/common/buffer.ts +228 -228
  464. package/src/common/cancellation.ts +163 -163
  465. package/src/common/char-code.ts +438 -438
  466. package/src/common/collections.ts +125 -125
  467. package/src/common/color.ts +103 -103
  468. package/src/common/command.spec.ts +208 -208
  469. package/src/common/command.ts +489 -489
  470. package/src/common/contribution-filter/contribution-filter-registry.ts +79 -79
  471. package/src/common/contribution-filter/contribution-filter.ts +64 -64
  472. package/src/common/contribution-filter/filter.ts +23 -23
  473. package/src/common/contribution-filter/index.ts +19 -19
  474. package/src/common/contribution-provider.ts +96 -96
  475. package/src/common/disposable.spec.ts +94 -94
  476. package/src/common/disposable.ts +188 -188
  477. package/src/common/encoding-service.ts +380 -380
  478. package/src/common/encodings.ts +24 -24
  479. package/src/common/env-variables/env-variables-protocol.ts +38 -38
  480. package/src/common/env-variables/index.ts +17 -17
  481. package/src/common/event.spec.ts +32 -32
  482. package/src/common/event.ts +493 -487
  483. package/src/common/file-uri.ts +61 -61
  484. package/src/common/frontend-application-state.ts +38 -38
  485. package/src/common/glob.ts +741 -741
  486. package/src/common/hash.ts +85 -85
  487. package/src/common/i18n/localization-server.ts +25 -25
  488. package/src/common/i18n/localization.ts +80 -80
  489. package/src/common/i18n/nls.metadata.json +34112 -34112
  490. package/src/common/index.ts +51 -51
  491. package/src/common/json-schema.ts +108 -106
  492. package/src/common/key-store.ts +26 -26
  493. package/src/common/keybinding.ts +152 -152
  494. package/src/common/keyboard/keyboard-layout-provider.ts +51 -51
  495. package/src/common/keys.ts +694 -694
  496. package/src/common/label-protocol.ts +35 -35
  497. package/src/common/logger-protocol.ts +119 -119
  498. package/src/common/logger-watcher.ts +48 -48
  499. package/src/common/logger.spec.ts +46 -46
  500. package/src/common/logger.ts +389 -389
  501. package/src/common/lsp-types.ts +34 -34
  502. package/src/common/markdown-rendering/icon-utilities.ts +30 -30
  503. package/src/common/markdown-rendering/index.ts +18 -18
  504. package/src/common/markdown-rendering/markdown-string.ts +152 -152
  505. package/src/common/menu/action-menu-node.ts +65 -65
  506. package/src/common/menu/composite-menu-node.spec.ts +67 -67
  507. package/src/common/menu/composite-menu-node.ts +114 -114
  508. package/src/common/menu/index.ts +21 -21
  509. package/src/common/menu/menu-adapter.ts +103 -103
  510. package/src/common/menu/menu-model-registry.ts +374 -374
  511. package/src/common/menu/menu-types.ts +220 -219
  512. package/src/common/menu/menu.spec.ts +101 -101
  513. package/src/common/message-rpc/channel.spec.ts +88 -88
  514. package/src/common/message-rpc/channel.ts +300 -300
  515. package/src/common/message-rpc/index.ts +22 -22
  516. package/src/common/message-rpc/message-buffer.ts +105 -105
  517. package/src/common/message-rpc/msg-pack-extension-manager.ts +70 -70
  518. package/src/common/message-rpc/rpc-message-encoder.spec.ts +65 -65
  519. package/src/common/message-rpc/rpc-message-encoder.ts +190 -190
  520. package/src/common/message-rpc/rpc-protocol.ts +255 -255
  521. package/src/common/message-rpc/uint8-array-message-buffer.spec.ts +41 -41
  522. package/src/common/message-rpc/uint8-array-message-buffer.ts +213 -213
  523. package/src/common/message-service-protocol.ts +148 -148
  524. package/src/common/message-service.ts +226 -226
  525. package/src/common/messaging/connection-error-handler.ts +73 -73
  526. package/src/common/messaging/connection-management.ts +43 -43
  527. package/src/common/messaging/handler.ts +26 -26
  528. package/src/common/messaging/index.ts +19 -19
  529. package/src/common/messaging/proxy-factory.spec.ts +108 -108
  530. package/src/common/messaging/proxy-factory.ts +336 -336
  531. package/src/common/messaging/socket-write-buffer.ts +52 -52
  532. package/src/common/messaging/web-socket-channel.ts +76 -76
  533. package/src/common/nls.ts +151 -151
  534. package/src/common/numbers.ts +21 -21
  535. package/src/common/objects.spec.ts +112 -112
  536. package/src/common/objects.ts +123 -123
  537. package/src/common/os.ts +82 -82
  538. package/src/common/path.spec.ts +415 -415
  539. package/src/common/path.ts +334 -334
  540. package/src/common/paths.ts +250 -250
  541. package/src/common/performance/index.ts +19 -19
  542. package/src/common/performance/measurement-protocol.ts +104 -104
  543. package/src/common/performance/measurement.ts +130 -130
  544. package/src/common/performance/stopwatch.ts +183 -183
  545. package/src/common/preferences/preference-schema.ts +101 -101
  546. package/src/common/preferences/preference-scope.spec.ts +48 -48
  547. package/src/common/preferences/preference-scope.ts +68 -68
  548. package/src/common/prioritizeable.ts +58 -58
  549. package/src/common/progress-service-protocol.ts +35 -35
  550. package/src/common/progress-service.ts +82 -82
  551. package/src/common/promise-util.spec.ts +102 -102
  552. package/src/common/promise-util.ts +143 -143
  553. package/src/common/quick-pick-service.ts +353 -353
  554. package/src/common/reference.spec.ts +145 -145
  555. package/src/common/reference.ts +230 -230
  556. package/src/common/resource.ts +430 -430
  557. package/src/common/selection-command-handler.ts +101 -101
  558. package/src/common/selection-service.spec.ts +43 -43
  559. package/src/common/selection-service.ts +49 -49
  560. package/src/common/selection.ts +50 -50
  561. package/src/common/severity.ts +111 -111
  562. package/src/common/stream.ts +718 -718
  563. package/src/common/strings.ts +231 -231
  564. package/src/common/telemetry.ts +45 -45
  565. package/src/common/ternary-search-tree.ts +417 -417
  566. package/src/common/test/expect.ts +34 -34
  567. package/src/common/test/mock-logger.ts +118 -118
  568. package/src/common/test/mock-menu.ts +35 -35
  569. package/src/common/test/mock-resource-provider.ts +33 -33
  570. package/src/common/theme.ts +68 -68
  571. package/src/common/types.spec.ts +86 -86
  572. package/src/common/types.ts +140 -140
  573. package/src/common/uri-command-handler.spec.ts +90 -90
  574. package/src/common/uri-command-handler.ts +148 -148
  575. package/src/common/uri.spec.ts +278 -278
  576. package/src/common/uri.ts +279 -279
  577. package/src/common/uuid.ts +45 -45
  578. package/src/common/version.ts +17 -17
  579. package/src/common/view-column.ts +33 -33
  580. package/src/common/window.ts +34 -34
  581. package/src/electron-browser/electron-clipboard-service.ts +32 -32
  582. package/src/electron-browser/electron-uri-handler.ts +42 -0
  583. package/src/electron-browser/keyboard/electron-keyboard-layout-change-notifier.ts +39 -39
  584. package/src/electron-browser/keyboard/electron-keyboard-module.ts +28 -28
  585. package/src/electron-browser/menu/electron-context-menu-renderer.ts +122 -122
  586. package/src/electron-browser/menu/electron-main-menu-factory.ts +339 -338
  587. package/src/electron-browser/menu/electron-menu-contribution.ts +506 -506
  588. package/src/electron-browser/menu/electron-menu-module.ts +40 -40
  589. package/src/electron-browser/menu/electron-menu-style.css +110 -110
  590. package/src/electron-browser/messaging/electron-frontend-id-provider.ts +25 -25
  591. package/src/electron-browser/messaging/electron-ipc-connection-source.ts +65 -65
  592. package/src/electron-browser/messaging/electron-local-ws-connection-source.ts +45 -45
  593. package/src/electron-browser/messaging/electron-messaging-frontend-module.ts +78 -78
  594. package/src/electron-browser/messaging/electron-ws-connection-source.ts +38 -38
  595. package/src/electron-browser/preload.ts +264 -249
  596. package/src/electron-browser/request/electron-browser-request-module.ts +26 -26
  597. package/src/electron-browser/token/electron-token-frontend-module.ts +22 -22
  598. package/src/electron-browser/window/electron-frontend-application-state.ts +26 -26
  599. package/src/electron-browser/window/electron-secondary-window-service.ts +35 -35
  600. package/src/electron-browser/window/electron-window-module.ts +48 -45
  601. package/src/electron-browser/window/electron-window-preferences.ts +76 -76
  602. package/src/electron-browser/window/electron-window-service.ts +109 -109
  603. package/src/electron-browser/window/external-app-open-handler.ts +42 -42
  604. package/src/electron-common/electron-api.ts +157 -154
  605. package/src/electron-common/electron-main-window-service.ts +24 -24
  606. package/src/electron-common/electron-token.ts +27 -27
  607. package/src/electron-main/electron-api-main.ts +373 -347
  608. package/src/electron-main/electron-main-application-module.ts +65 -65
  609. package/src/electron-main/electron-main-application.ts +860 -818
  610. package/src/electron-main/electron-main-constants.ts +23 -23
  611. package/src/electron-main/electron-main-window-service-impl.ts +44 -44
  612. package/src/electron-main/electron-security-token-service.ts +36 -36
  613. package/src/electron-main/event-utils.ts +36 -36
  614. package/src/electron-main/messaging/electron-connection-handler.ts +21 -21
  615. package/src/electron-main/messaging/electron-messaging-contribution.ts +143 -143
  616. package/src/electron-main/messaging/electron-messaging-service.ts +35 -35
  617. package/src/electron-main/theia-electron-window.ts +219 -214
  618. package/src/electron-node/cli/electron-backend-cli-module.ts +24 -24
  619. package/src/electron-node/cli/electron-cli-contribution.ts +35 -35
  620. package/src/electron-node/hosting/electron-backend-hosting-module.ts +24 -24
  621. package/src/electron-node/hosting/electron-ws-origin-validator.ts +37 -37
  622. package/src/electron-node/keyboard/electron-backend-keyboard-module.ts +30 -30
  623. package/src/electron-node/keyboard/electron-keyboard-layout-provider.ts +35 -35
  624. package/src/electron-node/request/electron-backend-request-module.ts +23 -23
  625. package/src/electron-node/request/electron-backend-request-service.ts +78 -78
  626. package/src/electron-node/token/electron-token-backend-contribution.ts +48 -48
  627. package/src/electron-node/token/electron-token-backend-module.ts +28 -28
  628. package/src/electron-node/token/electron-token-validator.ts +93 -93
  629. package/src/node/application-server.ts +59 -59
  630. package/src/node/backend-application-config-provider.spec.ts +29 -29
  631. package/src/node/backend-application-config-provider.ts +48 -48
  632. package/src/node/backend-application-module.ts +139 -139
  633. package/src/node/backend-application.ts +374 -374
  634. package/src/node/cli.spec.ts +94 -94
  635. package/src/node/cli.ts +63 -63
  636. package/src/node/console-logger-server.spec.ts +59 -59
  637. package/src/node/console-logger-server.ts +76 -76
  638. package/src/node/debug.ts +30 -30
  639. package/src/node/dynamic-require.ts +56 -56
  640. package/src/node/env-variables/env-variables-server.ts +123 -123
  641. package/src/node/env-variables/index.ts +17 -17
  642. package/src/node/environment-utils.spec.ts +92 -92
  643. package/src/node/environment-utils.ts +66 -66
  644. package/src/node/file-uri.spec.ts +76 -76
  645. package/src/node/filesystem-locking.ts +77 -77
  646. package/src/node/hosting/backend-application-hosts.ts +60 -60
  647. package/src/node/hosting/backend-hosting-module.ts +26 -26
  648. package/src/node/hosting/ws-origin-validator.ts +36 -36
  649. package/src/node/i18n/i18n-backend-module.ts +42 -42
  650. package/src/node/i18n/localization-contribution.ts +112 -112
  651. package/src/node/i18n/localization-provider.ts +125 -125
  652. package/src/node/i18n/localization-server.ts +52 -52
  653. package/src/node/i18n/theia-localization-contribution.ts +40 -36
  654. package/src/node/index.ts +22 -22
  655. package/src/node/key-store-server.ts +162 -162
  656. package/src/node/logger-backend-module.ts +88 -88
  657. package/src/node/logger-cli-contribution.spec.ts +245 -245
  658. package/src/node/logger-cli-contribution.ts +168 -168
  659. package/src/node/main.ts +33 -33
  660. package/src/node/messaging/binary-message-pipe.ts +168 -168
  661. package/src/node/messaging/connection-container-module.ts +96 -96
  662. package/src/node/messaging/default-messaging-service.ts +129 -129
  663. package/src/node/messaging/frontend-connection-service.ts +24 -24
  664. package/src/node/messaging/index.ts +19 -19
  665. package/src/node/messaging/ipc-bootstrap.ts +27 -27
  666. package/src/node/messaging/ipc-channel.ts +77 -77
  667. package/src/node/messaging/ipc-connection-provider.ts +107 -107
  668. package/src/node/messaging/ipc-protocol.ts +76 -76
  669. package/src/node/messaging/messaging-backend-module.ts +52 -52
  670. package/src/node/messaging/messaging-listeners.ts +52 -52
  671. package/src/node/messaging/messaging-service.ts +46 -46
  672. package/src/node/messaging/test/test-web-socket-channel.ts +61 -61
  673. package/src/node/messaging/websocket-endpoint.ts +79 -79
  674. package/src/node/messaging/websocket-frontend-connection-service.ts +186 -186
  675. package/src/node/os-backend-provider.ts +25 -25
  676. package/src/node/performance/index.ts +18 -18
  677. package/src/node/performance/measurement-backend-bindings.ts +35 -35
  678. package/src/node/performance/node-stopwatch.ts +40 -40
  679. package/src/node/process-utils.spec.ts +48 -48
  680. package/src/node/process-utils.ts +102 -102
  681. package/src/node/remote/backend-remote-service.ts +25 -25
  682. package/src/node/remote/remote-cli-contribution.ts +34 -34
  683. package/src/node/remote/remote-copy-contribution.ts +45 -45
  684. package/src/node/request/backend-request-facade.ts +39 -39
  685. package/src/node/request/backend-request-module.ts +25 -25
  686. package/src/node/request/proxy-cli-contribution.ts +65 -65
  687. package/src/node/ws-request-validators.ts +56 -56
  688. package/src/typings/native-keymap.d.ts +108 -108
  689. package/i18n/nls.pt-pt.json +0 -552
@@ -1,1591 +1,1591 @@
1
- // *****************************************************************************
2
- // Copyright (C) 2018 TypeFox and others.
3
- //
4
- // This program and the accompanying materials are made available under the
5
- // terms of the Eclipse Public License v. 2.0 which is available at
6
- // http://www.eclipse.org/legal/epl-2.0.
7
- //
8
- // This Source Code may also be made available under the following Secondary
9
- // Licenses when the conditions for such availability set forth in the Eclipse
10
- // Public License v. 2.0 are satisfied: GNU General Public License, version 2
11
- // with the GNU Classpath Exception which is available at
12
- // https://www.gnu.org/software/classpath/license.html.
13
- //
14
- // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
15
- // *****************************************************************************
16
-
17
- import { injectable, inject, postConstruct } from 'inversify';
18
- import { Message } from '@phosphor/messaging';
19
- import { Disposable, MenuPath, SelectionService } from '../../common';
20
- import { Key, KeyCode, KeyModifier } from '../keyboard/keys';
21
- import { ContextMenuRenderer } from '../context-menu-renderer';
22
- import { StatefulWidget } from '../shell';
23
- import {
24
- EXPANSION_TOGGLE_CLASS, SELECTED_CLASS, COLLAPSED_CLASS, FOCUS_CLASS, BUSY_CLASS, CODICON_TREE_ITEM_CLASSES, CODICON_LOADING_CLASSES, Widget, UnsafeWidgetUtilities
25
- } from '../widgets';
26
- import { TreeNode, CompositeTreeNode } from './tree';
27
- import { TreeModel } from './tree-model';
28
- import { ExpandableTreeNode } from './tree-expansion';
29
- import { SelectableTreeNode, TreeSelection } from './tree-selection';
30
- import { TreeDecoratorService, TreeDecoration, DecoratedTreeNode } from './tree-decorator';
31
- import { notEmpty } from '../../common/objects';
32
- import { isOSX } from '../../common/os';
33
- import { ReactWidget } from '../widgets/react-widget';
34
- import * as React from 'react';
35
- import { Virtuoso, VirtuosoHandle } from 'react-virtuoso';
36
- import { TopDownTreeIterator } from './tree-iterator';
37
- import { SearchBox, SearchBoxFactory, SearchBoxProps } from './search-box';
38
- import { TreeSearch } from './tree-search';
39
- import { ElementExt } from '@phosphor/domutils';
40
- import { TreeWidgetSelection } from './tree-widget-selection';
41
- import { MaybePromise } from '../../common/types';
42
- import { LabelProvider } from '../label-provider';
43
- import { CorePreferences } from '../core-preferences';
44
- import { TreeFocusService } from './tree-focus-service';
45
- import { useEffect } from 'react';
46
- import { PreferenceService, PreferenceChange } from '../preferences';
47
- import { PREFERENCE_NAME_TREE_INDENT } from './tree-preference';
48
-
49
- const debounce = require('lodash.debounce');
50
-
51
- export const TREE_CLASS = 'theia-Tree';
52
- export const TREE_CONTAINER_CLASS = 'theia-TreeContainer';
53
- export const TREE_NODE_CLASS = 'theia-TreeNode';
54
- export const TREE_NODE_CONTENT_CLASS = 'theia-TreeNodeContent';
55
- export const TREE_NODE_INFO_CLASS = 'theia-TreeNodeInfo';
56
- export const TREE_NODE_TAIL_CLASS = 'theia-TreeNodeTail';
57
- export const TREE_NODE_SEGMENT_CLASS = 'theia-TreeNodeSegment';
58
- export const TREE_NODE_SEGMENT_GROW_CLASS = 'theia-TreeNodeSegmentGrow';
59
-
60
- export const EXPANDABLE_TREE_NODE_CLASS = 'theia-ExpandableTreeNode';
61
- export const COMPOSITE_TREE_NODE_CLASS = 'theia-CompositeTreeNode';
62
- export const TREE_NODE_CAPTION_CLASS = 'theia-TreeNodeCaption';
63
- export const TREE_NODE_INDENT_GUIDE_CLASS = 'theia-tree-node-indent';
64
-
65
- export const TreeProps = Symbol('TreeProps');
66
-
67
- /**
68
- * Representation of tree properties.
69
- */
70
- export interface TreeProps {
71
-
72
- /**
73
- * The path of the context menu that one can use to contribute context menu items to the tree widget.
74
- */
75
- readonly contextMenuPath?: MenuPath;
76
-
77
- /**
78
- * The size of the padding (in pixels) for the root node of the tree.
79
- */
80
- readonly leftPadding: number;
81
-
82
- readonly expansionTogglePadding: number;
83
-
84
- /**
85
- * `true` if the tree widget support multi-selection. Otherwise, `false`. Defaults to `false`.
86
- */
87
- readonly multiSelect?: boolean;
88
-
89
- /**
90
- * `true` if the tree widget support searching. Otherwise, `false`. Defaults to `false`.
91
- */
92
- readonly search?: boolean
93
-
94
- /**
95
- * `true` if the tree widget should be virtualized searching. Otherwise, `false`. Defaults to `true`.
96
- */
97
- readonly virtualized?: boolean
98
-
99
- /**
100
- * `true` if the selected node should be auto scrolled only if the widget is active. Otherwise, `false`. Defaults to `false`.
101
- */
102
- readonly scrollIfActive?: boolean
103
-
104
- /**
105
- * `true` if a tree widget contributes to the global selection. Defaults to `false`.
106
- */
107
- readonly globalSelection?: boolean;
108
-
109
- /**
110
- * `true` if the tree widget supports expansion only when clicking the expansion toggle. Defaults to `false`.
111
- */
112
- readonly expandOnlyOnExpansionToggleClick?: boolean;
113
-
114
- }
115
-
116
- /**
117
- * Representation of node properties.
118
- */
119
- export interface NodeProps {
120
-
121
- /**
122
- * A root relative number representing the hierarchical depth of the actual node. Root is `0`, its children have `1` and so on.
123
- */
124
- readonly depth: number;
125
-
126
- }
127
-
128
- /**
129
- * The default tree properties.
130
- */
131
- export const defaultTreeProps: TreeProps = {
132
- leftPadding: 8,
133
- expansionTogglePadding: 22
134
- };
135
-
136
- export namespace TreeWidget {
137
-
138
- /**
139
- * Bare minimum common interface of the keyboard and the mouse event with respect to the key maskings.
140
- */
141
- export interface ModifierAwareEvent {
142
- /**
143
- * Determines if the modifier aware event has the `meta` key masking.
144
- */
145
- readonly metaKey: boolean;
146
- /**
147
- * Determines if the modifier aware event has the `ctrl` key masking.
148
- */
149
- readonly ctrlKey: boolean;
150
- /**
151
- * Determines if the modifier aware event has the `shift` key masking.
152
- */
153
- readonly shiftKey: boolean;
154
- }
155
-
156
- }
157
-
158
- @injectable()
159
- export class TreeWidget extends ReactWidget implements StatefulWidget {
160
-
161
- protected searchBox: SearchBox;
162
- protected searchHighlights: Map<string, TreeDecoration.CaptionHighlight>;
163
-
164
- @inject(TreeDecoratorService)
165
- protected readonly decoratorService: TreeDecoratorService;
166
- @inject(TreeSearch)
167
- protected readonly treeSearch: TreeSearch;
168
- @inject(SearchBoxFactory)
169
- protected readonly searchBoxFactory: SearchBoxFactory;
170
- @inject(TreeFocusService)
171
- protected readonly focusService: TreeFocusService;
172
-
173
- protected decorations: Map<string, TreeDecoration.Data[]> = new Map();
174
-
175
- @inject(SelectionService)
176
- protected readonly selectionService: SelectionService;
177
-
178
- @inject(PreferenceService)
179
- protected readonly preferenceService: PreferenceService;
180
-
181
- @inject(LabelProvider)
182
- protected readonly labelProvider: LabelProvider;
183
-
184
- @inject(CorePreferences)
185
- protected readonly corePreferences: CorePreferences;
186
-
187
- protected shouldScrollToRow = true;
188
-
189
- protected treeIndent: number = 8;
190
-
191
- constructor(
192
- @inject(TreeProps) readonly props: TreeProps,
193
- @inject(TreeModel) readonly model: TreeModel,
194
- @inject(ContextMenuRenderer) protected readonly contextMenuRenderer: ContextMenuRenderer,
195
- ) {
196
- super();
197
- this.scrollOptions = {
198
- suppressScrollX: true,
199
- minScrollbarLength: 35
200
- };
201
- this.addClass(TREE_CLASS);
202
- this.node.tabIndex = 0;
203
- }
204
-
205
- @postConstruct()
206
- protected init(): void {
207
- this.treeIndent = this.preferenceService.get(PREFERENCE_NAME_TREE_INDENT, this.treeIndent);
208
- if (this.props.search) {
209
- this.searchBox = this.searchBoxFactory({ ...SearchBoxProps.DEFAULT, showButtons: true, showFilter: true });
210
- this.searchBox.node.addEventListener('focus', () => {
211
- this.node.focus();
212
- });
213
- this.toDispose.pushAll([
214
- this.searchBox,
215
- this.searchBox.onTextChange(async data => {
216
- await this.treeSearch.filter(data);
217
- this.searchHighlights = this.treeSearch.getHighlights();
218
- this.searchBox.updateHighlightInfo({
219
- filterText: data,
220
- total: this.rows.size,
221
- matched: this.searchHighlights.size
222
- });
223
- this.update();
224
- }),
225
- this.searchBox.onClose(data => this.treeSearch.filter(undefined)),
226
- this.searchBox.onNext(() => {
227
- // Enable next selection if there are currently highlights.
228
- if (this.searchHighlights.size > 1) {
229
- this.model.selectNextNode();
230
- }
231
- }),
232
- this.searchBox.onPrevious(() => {
233
- // Enable previous selection if there are currently highlights.
234
- if (this.searchHighlights.size > 1) {
235
- this.model.selectPrevNode();
236
- }
237
- }),
238
- this.searchBox.onFilterToggled(e => {
239
- this.updateRows();
240
- }),
241
- this.treeSearch,
242
- this.treeSearch.onFilteredNodesChanged(nodes => {
243
- if (this.searchBox.isFiltering) {
244
- this.updateRows();
245
- }
246
- const node = nodes.find(SelectableTreeNode.is);
247
- if (node) {
248
- this.model.selectNode(node);
249
- }
250
- }),
251
- ]);
252
- }
253
- this.node.addEventListener('mousedown', this.handleMiddleClickEvent.bind(this));
254
- this.node.addEventListener('mouseup', this.handleMiddleClickEvent.bind(this));
255
- this.node.addEventListener('auxclick', this.handleMiddleClickEvent.bind(this));
256
- this.toDispose.pushAll([
257
- this.model,
258
- this.model.onChanged(() => this.updateRows()),
259
- this.model.onSelectionChanged(() => this.scheduleUpdateScrollToRow({ resize: false })),
260
- this.focusService.onDidChangeFocus(() => this.scheduleUpdateScrollToRow({ resize: false })),
261
- this.model.onDidChangeBusy(() => this.update()),
262
- this.model.onDidUpdate(() => this.update()),
263
- this.model.onNodeRefreshed(() => this.updateDecorations()),
264
- this.model.onExpansionChanged(() => this.updateDecorations()),
265
- this.decoratorService,
266
- this.decoratorService.onDidChangeDecorations(() => this.updateDecorations()),
267
- this.labelProvider.onDidChange(e => {
268
- for (const row of this.rows.values()) {
269
- if (e.affects(row)) {
270
- this.update();
271
- return;
272
- }
273
- }
274
- }),
275
- this.preferenceService.onPreferenceChanged((event: PreferenceChange) => {
276
- if (event.preferenceName === PREFERENCE_NAME_TREE_INDENT) {
277
- this.treeIndent = event.newValue;
278
- this.update();
279
- }
280
- })
281
- ]);
282
- setTimeout(() => {
283
- this.updateRows();
284
- this.updateDecorations();
285
- });
286
- if (this.props.globalSelection) {
287
- this.toDispose.pushAll([
288
- this.model.onSelectionChanged(() => {
289
- if (this.node.contains(document.activeElement)) {
290
- this.updateGlobalSelection();
291
- }
292
- }),
293
- this.focusService.onDidChangeFocus(focus => {
294
- if (focus && this.node.contains(document.activeElement) && this.model.selectedNodes[0] !== focus && this.model.selectedNodes.includes(focus)) {
295
- this.updateGlobalSelection();
296
- }
297
- }),
298
- Disposable.create(() => {
299
- const selection = this.selectionService.selection;
300
- if (TreeWidgetSelection.isSource(selection, this)) {
301
- this.selectionService.selection = undefined;
302
- }
303
- })
304
- ]);
305
-
306
- this.node.addEventListener('focusin', e => {
307
- if (this.model.selectedNodes.length && (!this.selectionService.selection || !TreeWidgetSelection.isSource(this.selectionService.selection, this))) {
308
- this.updateGlobalSelection();
309
- }
310
- });
311
- }
312
- this.toDispose.push(this.corePreferences.onPreferenceChanged(preference => {
313
- if (preference.preferenceName === 'workbench.tree.renderIndentGuides') {
314
- this.update();
315
- }
316
- }));
317
- }
318
-
319
- /**
320
- * Update the global selection for the tree.
321
- */
322
- protected updateGlobalSelection(): void {
323
- this.selectionService.selection = TreeWidgetSelection.create(this);
324
- }
325
-
326
- protected rows = new Map<string, TreeWidget.NodeRow>();
327
- protected updateRows = debounce(() => this.doUpdateRows(), 10);
328
- protected doUpdateRows(): void {
329
- const root = this.model.root;
330
- const rowsToUpdate: Array<[string, TreeWidget.NodeRow]> = [];
331
- if (root) {
332
- const depths = new Map<CompositeTreeNode | undefined, number>();
333
- let index = 0;
334
- for (const node of new TopDownTreeIterator(root, {
335
- pruneCollapsed: true,
336
- pruneSiblings: true
337
- })) {
338
- if (this.shouldDisplayNode(node)) {
339
- const depth = this.getDepthForNode(node, depths);
340
- if (CompositeTreeNode.is(node)) {
341
- depths.set(node, depth);
342
- }
343
- rowsToUpdate.push([node.id, this.toNodeRow(node, index++, depth)]);
344
- }
345
- }
346
- }
347
- this.rows = new Map(rowsToUpdate);
348
- this.update();
349
- }
350
-
351
- protected getDepthForNode(node: TreeNode, depths: Map<CompositeTreeNode | undefined, number>): number {
352
- const parentDepth = depths.get(node.parent);
353
- return parentDepth === undefined ? 0 : TreeNode.isVisible(node.parent) ? parentDepth + 1 : parentDepth;
354
- }
355
-
356
- protected toNodeRow(node: TreeNode, index: number, depth: number): TreeWidget.NodeRow {
357
- return { node, index, depth };
358
- }
359
-
360
- protected shouldDisplayNode(node: TreeNode): boolean {
361
- return TreeNode.isVisible(node) && (!this.searchBox?.isFiltering || this.treeSearch.passesFilters(node));
362
- }
363
-
364
- /**
365
- * Row index to ensure visibility.
366
- * - Used to forcefully scroll if necessary.
367
- */
368
- protected scrollToRow: number | undefined;
369
- /**
370
- * Update the `scrollToRow`.
371
- * @param updateOptions the tree widget force update options.
372
- */
373
- protected updateScrollToRow(): void {
374
- this.scrollToRow = this.getScrollToRow();
375
- this.update();
376
- }
377
-
378
- protected scheduleUpdateScrollToRow = debounce(this.updateScrollToRow);
379
-
380
- /**
381
- * Get the `scrollToRow`.
382
- *
383
- * @returns the `scrollToRow` if available.
384
- */
385
- protected getScrollToRow(): number | undefined {
386
- if (!this.shouldScrollToRow) {
387
- return undefined;
388
- }
389
- const { focusedNode } = this.focusService;
390
- return focusedNode && this.rows.get(focusedNode.id)?.index;
391
- }
392
-
393
- /**
394
- * Update tree decorations.
395
- * - Updating decorations are debounced in order to limit the number of expensive updates.
396
- */
397
- protected readonly updateDecorations = debounce(() => this.doUpdateDecorations(), 150);
398
- protected async doUpdateDecorations(): Promise<void> {
399
- this.decorations = await this.decoratorService.getDecorations(this.model);
400
- this.update();
401
- }
402
-
403
- protected override onActivateRequest(msg: Message): void {
404
- super.onActivateRequest(msg);
405
- this.node.focus({ preventScroll: true });
406
- }
407
-
408
- /**
409
- * Actually focus the tree node.
410
- */
411
- protected doFocus(): void {
412
- if (!this.model.selectedNodes.length) {
413
- const node = this.getNodeToFocus();
414
- if (SelectableTreeNode.is(node)) {
415
- this.model.selectNode(node);
416
- }
417
- }
418
- }
419
-
420
- /**
421
- * Get the tree node to focus.
422
- *
423
- * @returns the node to focus if available.
424
- */
425
- protected getNodeToFocus(): SelectableTreeNode | undefined {
426
- const { focusedNode } = this.focusService;
427
- if (focusedNode) {
428
- return focusedNode;
429
- }
430
- const { root } = this.model;
431
- if (SelectableTreeNode.isVisible(root)) {
432
- return root;
433
- }
434
- return this.model.getNextSelectableNode(root);
435
- }
436
-
437
- protected override onUpdateRequest(msg: Message): void {
438
- if (!this.isAttached || !this.isVisible) {
439
- return;
440
- }
441
- super.onUpdateRequest(msg);
442
- }
443
-
444
- protected override onResize(msg: Widget.ResizeMessage): void {
445
- super.onResize(msg);
446
- this.update();
447
- }
448
-
449
- protected render(): React.ReactNode {
450
- return React.createElement('div', this.createContainerAttributes(), this.renderTree(this.model));
451
- }
452
-
453
- /**
454
- * Create the container attributes for the widget.
455
- */
456
- protected createContainerAttributes(): React.HTMLAttributes<HTMLElement> {
457
- const classNames = [TREE_CONTAINER_CLASS];
458
- if (!this.rows.size) {
459
- classNames.push('empty');
460
- }
461
- if (this.model.selectedNodes.length === 0 && !this.focusService.focusedNode) {
462
- classNames.push('focused');
463
- }
464
- return {
465
- className: classNames.join(' '),
466
- onContextMenu: event => this.handleContextMenuEvent(this.getContainerTreeNode(), event)
467
- };
468
- }
469
- /**
470
- * Get the container tree node.
471
- *
472
- * @returns the tree node for the container if available.
473
- */
474
- protected getContainerTreeNode(): TreeNode | undefined {
475
- return this.model.root;
476
- }
477
-
478
- protected ScrollingRowRenderer: React.FC<{ rows: TreeWidget.NodeRow[] }> = ({ rows }) => {
479
- useEffect(() => this.scrollToSelected());
480
- return <>{rows.map(row => <div key={row.index}>{this.renderNodeRow(row)}</div>)}</>;
481
- };
482
-
483
- protected view: TreeWidget.View | undefined;
484
- /**
485
- * Render the tree widget.
486
- * @param model the tree model.
487
- */
488
- protected renderTree(model: TreeModel): React.ReactNode {
489
- if (model.root) {
490
- const rows = Array.from(this.rows.values());
491
- if (this.props.virtualized === false) {
492
- return <this.ScrollingRowRenderer rows={rows} />;
493
- }
494
- return <TreeWidget.View
495
- ref={view => this.view = (view || undefined)}
496
- width={this.node.offsetWidth}
497
- height={this.node.offsetHeight}
498
- rows={rows}
499
- renderNodeRow={this.renderNodeRow}
500
- scrollToRow={this.scrollToRow}
501
- />;
502
- }
503
- // eslint-disable-next-line no-null/no-null
504
- return null;
505
- }
506
-
507
- scrollArea: Element = this.node;
508
- /**
509
- * Scroll to the selected tree node.
510
- */
511
- protected scrollToSelected(): void {
512
- if (this.props.scrollIfActive === true && !this.node.contains(document.activeElement)) {
513
- return;
514
- }
515
- const focus = this.node.getElementsByClassName(FOCUS_CLASS)[0];
516
- if (focus) {
517
- ElementExt.scrollIntoViewIfNeeded(this.scrollArea, focus);
518
- } else {
519
- const selected = this.node.getElementsByClassName(SELECTED_CLASS)[0];
520
- if (selected) {
521
- ElementExt.scrollIntoViewIfNeeded(this.scrollArea, selected);
522
- }
523
- }
524
- }
525
-
526
- /**
527
- * Render the node row.
528
- */
529
- protected readonly renderNodeRow = (row: TreeWidget.NodeRow) => this.doRenderNodeRow(row);
530
- /**
531
- * Actually render the node row.
532
- */
533
- protected doRenderNodeRow({ node, depth }: TreeWidget.NodeRow): React.ReactNode {
534
- return <React.Fragment>
535
- {this.renderIndent(node, { depth })}
536
- {this.renderNode(node, { depth })}
537
- </React.Fragment>;
538
- }
539
-
540
- /**
541
- * Render the tree node given the node properties.
542
- * @param node the tree node.
543
- * @param props the node properties.
544
- */
545
- protected renderIcon(node: TreeNode, props: NodeProps): React.ReactNode {
546
- // eslint-disable-next-line no-null/no-null
547
- return null;
548
- }
549
-
550
- /**
551
- * Toggle the node.
552
- */
553
- protected readonly toggle = (event: React.MouseEvent<HTMLElement>) => this.doToggle(event);
554
- /**
555
- * Actually toggle the tree node.
556
- * @param event the mouse click event.
557
- */
558
- protected doToggle(event: React.MouseEvent<HTMLElement>): void {
559
- const nodeId = event.currentTarget.getAttribute('data-node-id');
560
- if (nodeId) {
561
- const node = this.model.getNode(nodeId);
562
- if (node && this.props.expandOnlyOnExpansionToggleClick) {
563
- if (this.isExpandable(node) && !this.hasShiftMask(event) && !this.hasCtrlCmdMask(event)) {
564
- this.model.toggleNodeExpansion(node);
565
- }
566
- } else {
567
- this.handleClickEvent(node, event);
568
- }
569
- }
570
- event.stopPropagation();
571
- }
572
-
573
- /**
574
- * Render the node expansion toggle.
575
- * @param node the tree node.
576
- * @param props the node properties.
577
- */
578
- protected renderExpansionToggle(node: TreeNode, props: NodeProps): React.ReactNode {
579
- if (!this.isExpandable(node)) {
580
- // eslint-disable-next-line no-null/no-null
581
- return null;
582
- }
583
- const classes = [TREE_NODE_SEGMENT_CLASS, EXPANSION_TOGGLE_CLASS];
584
- if (!node.expanded) {
585
- classes.push(COLLAPSED_CLASS);
586
- }
587
- if (node.busy) {
588
- classes.push(BUSY_CLASS, ...CODICON_LOADING_CLASSES);
589
- } else {
590
- classes.push(...CODICON_TREE_ITEM_CLASSES);
591
- }
592
- const className = classes.join(' ');
593
- return <div
594
- data-node-id={node.id}
595
- className={className}
596
- onClick={this.toggle}
597
- onDoubleClick={this.handleExpansionToggleDblClickEvent}>
598
- </div>;
599
- }
600
-
601
- /**
602
- * Render the node expansion toggle.
603
- * @param node the tree node.
604
- * @param props the node properties.
605
- */
606
- protected renderCheckbox(node: TreeNode, props: NodeProps): React.ReactNode {
607
- if (node.checkboxInfo === undefined) {
608
- // eslint-disable-next-line no-null/no-null
609
- return null;
610
- }
611
- return <input data-node-id={node.id}
612
- readOnly
613
- type='checkbox'
614
- checked={!!node.checkboxInfo.checked}
615
- title={node.checkboxInfo.tooltip}
616
- aria-label={node.checkboxInfo.accessibilityInformation?.label}
617
- role={node.checkboxInfo.accessibilityInformation?.role}
618
- className='theia-input'
619
- onClick={event => this.toggleChecked(event)} />;
620
- }
621
-
622
- protected toggleChecked(event: React.MouseEvent<HTMLElement>): void {
623
- const nodeId = event.currentTarget.getAttribute('data-node-id');
624
- if (nodeId) {
625
- const node = this.model.getNode(nodeId);
626
- if (node) {
627
- this.model.markAsChecked(node, !node.checkboxInfo!.checked);
628
- } else {
629
- this.handleClickEvent(node, event);
630
- }
631
- }
632
- event.preventDefault();
633
- event.stopPropagation();
634
- }
635
- /**
636
- * Render the tree node caption given the node properties.
637
- * @param node the tree node.
638
- * @param props the node properties.
639
- */
640
- protected renderCaption(node: TreeNode, props: NodeProps): React.ReactNode {
641
- const attrs = this.getCaptionAttributes(node, props);
642
- const children = this.getCaptionChildren(node, props);
643
- return React.createElement('div', attrs, children);
644
- }
645
-
646
- protected getCaptionAttributes(node: TreeNode, props: NodeProps): React.Attributes & React.HTMLAttributes<HTMLElement> {
647
- const tooltip = this.getDecorationData(node, 'tooltip').filter(notEmpty).join(' • ');
648
- const classes = [TREE_NODE_SEGMENT_CLASS];
649
- if (!this.hasTrailingSuffixes(node)) {
650
- classes.push(TREE_NODE_SEGMENT_GROW_CLASS);
651
- }
652
- const className = classes.join(' ');
653
- let attrs = this.decorateCaption(node, {
654
- className, id: node.id
655
- });
656
- if (tooltip.length > 0) {
657
- attrs = {
658
- ...attrs,
659
- title: tooltip
660
- };
661
- }
662
- return attrs;
663
- }
664
-
665
- protected getCaptionChildren(node: TreeNode, props: NodeProps): React.ReactNode {
666
- const children = [];
667
- const caption = this.toNodeName(node);
668
- const highlight = this.getDecorationData(node, 'highlight')[0];
669
- if (highlight) {
670
- children.push(this.toReactNode(caption, highlight));
671
- }
672
- const searchHighlight = this.searchHighlights ? this.searchHighlights.get(node.id) : undefined;
673
- if (searchHighlight) {
674
- children.push(...this.toReactNode(caption, searchHighlight));
675
- } else if (!highlight) {
676
- children.push(caption);
677
- }
678
- return children;
679
- }
680
-
681
- /**
682
- * Update the node given the caption and highlight.
683
- * @param caption the caption.
684
- * @param highlight the tree decoration caption highlight.
685
- */
686
- protected toReactNode(caption: string, highlight: TreeDecoration.CaptionHighlight): React.ReactNode[] {
687
- let style: React.CSSProperties = {};
688
- if (highlight.color) {
689
- style = {
690
- ...style,
691
- color: highlight.color
692
- };
693
- }
694
- if (highlight.backgroundColor) {
695
- style = {
696
- ...style,
697
- backgroundColor: highlight.backgroundColor
698
- };
699
- }
700
- const createChildren = (fragment: TreeDecoration.CaptionHighlight.Fragment, index: number) => {
701
- const { data } = fragment;
702
- if (fragment.highlight) {
703
- return <mark className={TreeDecoration.Styles.CAPTION_HIGHLIGHT_CLASS} style={style} key={index}>{data}</mark>;
704
- } else {
705
- return data;
706
- }
707
- };
708
- return TreeDecoration.CaptionHighlight.split(caption, highlight).map(createChildren);
709
- }
710
-
711
- /**
712
- * Decorate the tree caption.
713
- * @param node the tree node.
714
- * @param attrs the additional attributes.
715
- */
716
- protected decorateCaption(node: TreeNode, attrs: React.HTMLAttributes<HTMLElement>): React.Attributes & React.HTMLAttributes<HTMLElement> {
717
- const style = this.getDecorationData(node, 'fontData')
718
- .filter(notEmpty)
719
- .reverse()
720
- .map(fontData => this.applyFontStyles({}, fontData))
721
- .reduce((acc, current) => ({
722
- ...acc,
723
- ...current
724
- }), {});
725
- return {
726
- ...attrs,
727
- style
728
- };
729
- }
730
-
731
- /**
732
- * Determine if the tree node contains trailing suffixes.
733
- * @param node the tree node.
734
- *
735
- * @returns `true` if the tree node contains trailing suffices.
736
- */
737
- protected hasTrailingSuffixes(node: TreeNode): boolean {
738
- return this.getDecorationData(node, 'captionSuffixes').filter(notEmpty).reduce((acc, current) => acc.concat(current), []).length > 0;
739
- }
740
-
741
- /**
742
- * Apply font styles to the tree.
743
- * @param original the original css properties.
744
- * @param fontData the optional `fontData`.
745
- */
746
- protected applyFontStyles(original: React.CSSProperties, fontData: TreeDecoration.FontData | undefined): React.CSSProperties {
747
- if (fontData === undefined) {
748
- return original;
749
- }
750
- const modified = { ...original }; // make a copy to mutate
751
- const { color, style } = fontData;
752
- if (color) {
753
- modified.color = color;
754
- }
755
- if (style) {
756
- (Array.isArray(style) ? style : [style]).forEach(s => {
757
- switch (s) {
758
- case 'bold':
759
- modified.fontWeight = s;
760
- break;
761
- case 'normal':
762
- case 'oblique':
763
- case 'italic':
764
- modified.fontStyle = s;
765
- break;
766
- case 'underline':
767
- case 'line-through':
768
- modified.textDecoration = s;
769
- break;
770
- default:
771
- throw new Error(`Unexpected font style: "${s}".`);
772
- }
773
- });
774
- }
775
- return modified;
776
- }
777
-
778
- /**
779
- * Render caption affixes for the given tree node.
780
- * @param node the tree node.
781
- * @param props the node properties.
782
- * @param affixKey the affix key.
783
- */
784
- protected renderCaptionAffixes(node: TreeNode, props: NodeProps, affixKey: 'captionPrefixes' | 'captionSuffixes'): React.ReactNode {
785
- const suffix = affixKey === 'captionSuffixes';
786
- const affixClass = suffix ? TreeDecoration.Styles.CAPTION_SUFFIX_CLASS : TreeDecoration.Styles.CAPTION_PREFIX_CLASS;
787
- const classes = [TREE_NODE_SEGMENT_CLASS, affixClass];
788
- const affixes = this.getDecorationData(node, affixKey).filter(notEmpty).reduce((acc, current) => acc.concat(current), []);
789
- const children: React.ReactNode[] = [];
790
- for (let i = 0; i < affixes.length; i++) {
791
- const affix = affixes[i];
792
- if (suffix && i === affixes.length - 1) {
793
- classes.push(TREE_NODE_SEGMENT_GROW_CLASS);
794
- }
795
- const style = this.applyFontStyles({}, affix.fontData);
796
- const className = classes.join(' ');
797
- const key = node.id + '_' + i;
798
- const attrs = {
799
- className,
800
- style,
801
- key
802
- };
803
- children.push(React.createElement('div', attrs, affix.data));
804
- }
805
- return <React.Fragment>{children}</React.Fragment>;
806
- }
807
-
808
- /**
809
- * Decorate the tree node icon.
810
- * @param node the tree node.
811
- * @param icon the icon.
812
- */
813
- protected decorateIcon(node: TreeNode, icon: React.ReactNode): React.ReactNode {
814
- if (!icon) {
815
- return;
816
- }
817
- const overlayIcons: React.ReactNode[] = [];
818
- // if multiple overlays have the same overlay.position attribute, we'll de-duplicate those and only process the first one from the decoration array
819
- const seenPositions = new Set<TreeDecoration.IconOverlayPosition>();
820
- const overlays = this.getDecorationData(node, 'iconOverlay').filter(notEmpty);
821
-
822
- for (const overlay of overlays) {
823
- if (!seenPositions.has(overlay.position)) {
824
- seenPositions.add(overlay.position);
825
- const iconClasses = [TreeDecoration.Styles.DECORATOR_SIZE_CLASS, TreeDecoration.IconOverlayPosition.getStyle(overlay.position)];
826
- const style = (color?: string) => color === undefined ? {} : { color };
827
-
828
- if (overlay.background) {
829
- overlayIcons.push(<span key={node.id + 'bg'} className={this.getIconClass(overlay.background.shape, iconClasses)}
830
- style={style(overlay.background.color)}></span>);
831
- }
832
-
833
- const overlayIcon = 'icon' in overlay ? overlay.icon : overlay.iconClass;
834
- overlayIcons.push(<span key={node.id} className={this.getIconClass(overlayIcon, iconClasses)} style={style(overlay.color)}></span>);
835
- }
836
- }
837
-
838
- if (overlayIcons.length > 0) {
839
- return <div className={TreeDecoration.Styles.ICON_WRAPPER_CLASS}>{icon}{overlayIcons}</div>;
840
- }
841
-
842
- return icon;
843
- }
844
-
845
- /**
846
- * Render the tree node tail decorations.
847
- * @param node the tree node.
848
- * @param props the node properties.
849
- */
850
- protected renderTailDecorations(node: TreeNode, props: NodeProps): React.ReactNode {
851
- const tailDecorations = this.getDecorationData(node, 'tailDecorations').reduce((acc, current) => acc.concat(current), []);
852
- if (tailDecorations.length === 0) {
853
- return;
854
- }
855
- return this.renderTailDecorationsForNode(node, props, tailDecorations);
856
- }
857
-
858
- protected renderTailDecorationsForNode(node: TreeNode, props: NodeProps, tailDecorations: TreeDecoration.TailDecoration.AnyPartial[]): React.ReactNode {
859
- let dotDecoration: TreeDecoration.TailDecoration.AnyPartial | undefined;
860
- const otherDecorations: TreeDecoration.TailDecoration.AnyPartial[] = [];
861
- tailDecorations.reverse().forEach(decoration => {
862
- if (TreeDecoration.TailDecoration.isDotDecoration(decoration)) {
863
- dotDecoration ||= decoration;
864
- } else if (decoration.data || decoration.icon || decoration.iconClass) {
865
- otherDecorations.push(decoration);
866
- }
867
- });
868
- const decorationsToRender = dotDecoration ? [dotDecoration, ...otherDecorations] : otherDecorations;
869
- return <React.Fragment>
870
- {decorationsToRender.map((decoration, index) => {
871
- const { tooltip, data, fontData, color, icon, iconClass } = decoration;
872
- const iconToRender = icon ?? iconClass;
873
- const className = [TREE_NODE_SEGMENT_CLASS, TREE_NODE_TAIL_CLASS, 'flex'].join(' ');
874
- const style = fontData ? this.applyFontStyles({}, fontData) : color ? { color } : undefined;
875
- const content = data ? data : iconToRender
876
- ? <span
877
- key={node.id + 'icon' + index}
878
- className={this.getIconClass(iconToRender, iconToRender === 'circle' ? [TreeDecoration.Styles.DECORATOR_SIZE_CLASS] : [])}
879
- ></span>
880
- : '';
881
- return <div key={node.id + className + index} className={className} style={style} title={tooltip}>
882
- {content}{index !== decorationsToRender.length - 1 ? ',' : ''}
883
- </div>;
884
- })}
885
- </React.Fragment>;
886
- }
887
-
888
- /**
889
- * Determine the classes to use for an icon
890
- * - Assumes a Font Awesome name when passed a single string, otherwise uses the passed string array
891
- * @param iconName the icon name or list of icon names.
892
- * @param additionalClasses additional CSS classes.
893
- *
894
- * @returns the icon class name.
895
- */
896
- protected getIconClass(iconName: string | string[], additionalClasses: string[] = []): string {
897
- const iconClass = (typeof iconName === 'string') ? ['a', 'fa', `fa-${iconName}`] : ['a'].concat(iconName);
898
- return iconClass.concat(additionalClasses).join(' ');
899
- }
900
-
901
- /**
902
- * Render indent for the file tree based on the depth
903
- * @param node the tree node.
904
- * @param depth the depth of the tree node.
905
- */
906
- protected renderIndent(node: TreeNode, props: NodeProps): React.ReactNode {
907
- const renderIndentGuides = this.corePreferences['workbench.tree.renderIndentGuides'];
908
- if (renderIndentGuides === 'none') {
909
- return undefined;
910
- }
911
-
912
- const indentDivs: React.ReactNode[] = [];
913
- let current: TreeNode | undefined = node;
914
- let depth = props.depth;
915
- while (current && depth) {
916
- if (this.shouldRenderIndent(current)) {
917
- const classNames: string[] = [TREE_NODE_INDENT_GUIDE_CLASS];
918
- if (this.needsActiveIndentGuideline(current)) {
919
- classNames.push('active');
920
- } else {
921
- classNames.push(renderIndentGuides === 'onHover' ? 'hover' : 'always');
922
- }
923
- const paddingLeft = this.getDepthPadding(depth);
924
- indentDivs.unshift(<div key={depth} className={classNames.join(' ')} style={{
925
- paddingLeft: `${paddingLeft}px`
926
- }} />);
927
- depth--;
928
- }
929
- current = current.parent;
930
- }
931
- return indentDivs;
932
- }
933
-
934
- /**
935
- * Determines whether an indentation div should be rendered for the specified tree node.
936
- * If there are multiple tree nodes inside of a single rendered row,
937
- * this method should only return true for the first node.
938
- */
939
- protected shouldRenderIndent(node: TreeNode): boolean {
940
- return true;
941
- }
942
-
943
- protected needsActiveIndentGuideline(node: TreeNode): boolean {
944
- const parent = node.parent;
945
- if (!parent || !this.isExpandable(parent)) {
946
- return false;
947
- }
948
- if (SelectableTreeNode.isSelected(parent)) {
949
- return true;
950
- }
951
- if (parent.expanded) {
952
- for (const sibling of parent.children) {
953
- if (SelectableTreeNode.isSelected(sibling) && !(this.isExpandable(sibling) && sibling.expanded)) {
954
- return true;
955
- }
956
- }
957
- }
958
- return false;
959
- }
960
-
961
- /**
962
- * Render the node given the tree node and node properties.
963
- * @param node the tree node.
964
- * @param props the node properties.
965
- */
966
- protected renderNode(node: TreeNode, props: NodeProps): React.ReactNode {
967
- if (!TreeNode.isVisible(node)) {
968
- return undefined;
969
- }
970
- const attributes = this.createNodeAttributes(node, props);
971
- const content = <div className={TREE_NODE_CONTENT_CLASS}>
972
- {this.renderExpansionToggle(node, props)}
973
- {this.renderCheckbox(node, props)}
974
- {this.decorateIcon(node, this.renderIcon(node, props))}
975
- {this.renderCaptionAffixes(node, props, 'captionPrefixes')}
976
- {this.renderCaption(node, props)}
977
- {this.renderCaptionAffixes(node, props, 'captionSuffixes')}
978
- {this.renderTailDecorations(node, props)}
979
- </div>;
980
- return React.createElement('div', attributes, content);
981
- }
982
-
983
- /**
984
- * Create node attributes for the tree node given the node properties.
985
- * @param node the tree node.
986
- * @param props the node properties.
987
- */
988
- protected createNodeAttributes(node: TreeNode, props: NodeProps): React.Attributes & React.HTMLAttributes<HTMLElement> {
989
- const className = this.createNodeClassNames(node, props).join(' ');
990
- const style = this.createNodeStyle(node, props);
991
- return {
992
- className,
993
- style,
994
- onClick: event => this.handleClickEvent(node, event),
995
- onDoubleClick: event => this.handleDblClickEvent(node, event),
996
- onAuxClick: event => this.handleAuxClickEvent(node, event),
997
- onContextMenu: event => this.handleContextMenuEvent(node, event),
998
- };
999
- }
1000
-
1001
- /**
1002
- * Create the node class names.
1003
- * @param node the tree node.
1004
- * @param props the node properties.
1005
- *
1006
- * @returns the list of tree node class names.
1007
- */
1008
- protected createNodeClassNames(node: TreeNode, props: NodeProps): string[] {
1009
- const classNames = [TREE_NODE_CLASS];
1010
- if (CompositeTreeNode.is(node)) {
1011
- classNames.push(COMPOSITE_TREE_NODE_CLASS);
1012
- }
1013
- if (this.isExpandable(node)) {
1014
- classNames.push(EXPANDABLE_TREE_NODE_CLASS);
1015
- }
1016
- if (this.rowIsSelected(node, props)) {
1017
- classNames.push(SELECTED_CLASS);
1018
- }
1019
- if (this.focusService.hasFocus(node)) {
1020
- classNames.push(FOCUS_CLASS);
1021
- }
1022
- return classNames;
1023
- }
1024
-
1025
- protected rowIsSelected(node: TreeNode, props: NodeProps): boolean {
1026
- return SelectableTreeNode.isSelected(node);
1027
- }
1028
-
1029
- /**
1030
- * Get the default node style.
1031
- * @param node the tree node.
1032
- * @param props the node properties.
1033
- *
1034
- * @returns the CSS properties if available.
1035
- */
1036
- protected getDefaultNodeStyle(node: TreeNode, props: NodeProps): React.CSSProperties | undefined {
1037
- const paddingLeft = this.getPaddingLeft(node, props) + 'px';
1038
- return { paddingLeft };
1039
- }
1040
-
1041
- protected getPaddingLeft(node: TreeNode, props: NodeProps): number {
1042
- return this.getDepthPadding(props.depth) + (this.needsExpansionTogglePadding(node) ? this.props.expansionTogglePadding : 0);
1043
- }
1044
-
1045
- /**
1046
- * If the node is a composite, a toggle will be rendered.
1047
- * Otherwise we need to add the width and the left, right padding => 18px
1048
- */
1049
- protected needsExpansionTogglePadding(node: TreeNode): boolean {
1050
- return !this.isExpandable(node);
1051
- }
1052
-
1053
- /**
1054
- * Create the tree node style.
1055
- * @param node the tree node.
1056
- * @param props the node properties.
1057
- */
1058
- protected createNodeStyle(node: TreeNode, props: NodeProps): React.CSSProperties | undefined {
1059
- return this.decorateNodeStyle(node, this.getDefaultNodeStyle(node, props));
1060
- }
1061
-
1062
- /**
1063
- * Decorate the node style.
1064
- * @param node the tree node.
1065
- * @param style the optional CSS properties.
1066
- *
1067
- * @returns the CSS styles if available.
1068
- */
1069
- protected decorateNodeStyle(node: TreeNode, style: React.CSSProperties | undefined): React.CSSProperties | undefined {
1070
- const backgroundColor = this.getDecorationData(node, 'backgroundColor').filter(notEmpty).shift();
1071
- if (backgroundColor) {
1072
- style = {
1073
- ...(style || {}),
1074
- backgroundColor
1075
- };
1076
- }
1077
- return style;
1078
- }
1079
-
1080
- /**
1081
- * Determine if the tree node is expandable.
1082
- * @param node the tree node.
1083
- *
1084
- * @returns `true` if the tree node is expandable.
1085
- */
1086
- protected isExpandable(node: TreeNode): node is ExpandableTreeNode {
1087
- return ExpandableTreeNode.is(node);
1088
- }
1089
-
1090
- /**
1091
- * Get the tree node decorations.
1092
- * @param node the tree node.
1093
- *
1094
- * @returns the list of tree decoration data.
1095
- */
1096
- protected getDecorations(node: TreeNode): TreeDecoration.Data[] {
1097
- const decorations: TreeDecoration.Data[] = [];
1098
- if (DecoratedTreeNode.is(node)) {
1099
- decorations.push(node.decorationData);
1100
- }
1101
- if (this.decorations.has(node.id)) {
1102
- decorations.push(...this.decorations.get(node.id)!);
1103
- }
1104
- return decorations.sort(TreeDecoration.Data.comparePriority);
1105
- }
1106
-
1107
- /**
1108
- * Get the tree decoration data for the given key.
1109
- * @param node the tree node.
1110
- * @param key the tree decoration data key.
1111
- *
1112
- * @returns the tree decoration data at the given key.
1113
- */
1114
- protected getDecorationData<K extends keyof TreeDecoration.Data>(node: TreeNode, key: K): Required<Pick<TreeDecoration.Data, K>>[K][] {
1115
- return this.getDecorations(node).filter(data => data[key] !== undefined).map(data => data[key]);
1116
- }
1117
-
1118
- /**
1119
- * Store the last scroll state.
1120
- */
1121
- protected lastScrollState: {
1122
- /**
1123
- * The scroll top value.
1124
- */
1125
- scrollTop: number,
1126
- /**
1127
- * The scroll left value.
1128
- */
1129
- scrollLeft: number
1130
- } | undefined;
1131
-
1132
- /**
1133
- * Get the scroll container.
1134
- */
1135
- protected override getScrollContainer(): MaybePromise<HTMLElement> {
1136
- this.toDisposeOnDetach.push(Disposable.create(() => {
1137
- const { scrollTop, scrollLeft } = this.node;
1138
- this.lastScrollState = { scrollTop, scrollLeft };
1139
- }));
1140
- if (this.lastScrollState) {
1141
- const { scrollTop, scrollLeft } = this.lastScrollState;
1142
- this.node.scrollTop = scrollTop;
1143
- this.node.scrollLeft = scrollLeft;
1144
- }
1145
- return this.node;
1146
- }
1147
-
1148
- protected override onAfterAttach(msg: Message): void {
1149
- const up = [
1150
- Key.ARROW_UP,
1151
- KeyCode.createKeyCode({ first: Key.ARROW_UP, modifiers: [KeyModifier.Shift] })
1152
- ];
1153
- const down = [
1154
- Key.ARROW_DOWN,
1155
- KeyCode.createKeyCode({ first: Key.ARROW_DOWN, modifiers: [KeyModifier.Shift] })
1156
- ];
1157
- if (this.props.search) {
1158
- if (this.searchBox.isAttached) {
1159
- Widget.detach(this.searchBox);
1160
- }
1161
- UnsafeWidgetUtilities.attach(this.searchBox, this.node.parentElement!);
1162
- this.addKeyListener(this.node, this.searchBox.keyCodePredicate.bind(this.searchBox), this.searchBox.handle.bind(this.searchBox));
1163
- this.toDisposeOnDetach.push(Disposable.create(() => {
1164
- Widget.detach(this.searchBox);
1165
- }));
1166
- }
1167
- super.onAfterAttach(msg);
1168
- this.addKeyListener(this.node, Key.ARROW_LEFT, event => this.handleLeft(event));
1169
- this.addKeyListener(this.node, Key.ARROW_RIGHT, event => this.handleRight(event));
1170
- this.addKeyListener(this.node, up, event => this.handleUp(event));
1171
- this.addKeyListener(this.node, down, event => this.handleDown(event));
1172
- this.addKeyListener(this.node, Key.ENTER, event => this.handleEnter(event));
1173
- this.addKeyListener(this.node, Key.SPACE, event => this.handleSpace(event));
1174
- this.addKeyListener(this.node, Key.ESCAPE, event => this.handleEscape(event));
1175
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
1176
- this.addEventListener<any>(this.node, 'ps-scroll-y', (e: Event & { target: { scrollTop: number } }) => {
1177
- if (this.view && this.view.list) {
1178
- const { scrollTop } = e.target;
1179
- this.view.list.scrollTo({
1180
- top: scrollTop
1181
- });
1182
- }
1183
- });
1184
- }
1185
-
1186
- /**
1187
- * Handle the `left arrow` keyboard event.
1188
- * @param event the `left arrow` keyboard event.
1189
- */
1190
- protected async handleLeft(event: KeyboardEvent): Promise<void> {
1191
- if (!!this.props.multiSelect && (this.hasCtrlCmdMask(event) || this.hasShiftMask(event))) {
1192
- return;
1193
- }
1194
- if (!await this.model.collapseNode()) {
1195
- this.model.selectParent();
1196
- }
1197
- }
1198
-
1199
- /**
1200
- * Handle the `right arrow` keyboard event.
1201
- * @param event the `right arrow` keyboard event.
1202
- */
1203
- protected async handleRight(event: KeyboardEvent): Promise<void> {
1204
- if (!!this.props.multiSelect && (this.hasCtrlCmdMask(event) || this.hasShiftMask(event))) {
1205
- return;
1206
- }
1207
- if (!await this.model.expandNode()) {
1208
- this.model.selectNextNode();
1209
- }
1210
- }
1211
-
1212
- /**
1213
- * Handle the `up arrow` keyboard event.
1214
- * @param event the `up arrow` keyboard event.
1215
- */
1216
- protected handleUp(event: KeyboardEvent): void {
1217
- if (!!this.props.multiSelect && this.hasShiftMask(event)) {
1218
- this.model.selectPrevNode(TreeSelection.SelectionType.RANGE);
1219
- } else {
1220
- this.model.selectPrevNode();
1221
- }
1222
- this.node.focus();
1223
- }
1224
-
1225
- /**
1226
- * Handle the `down arrow` keyboard event.
1227
- * @param event the `down arrow` keyboard event.
1228
- */
1229
- protected handleDown(event: KeyboardEvent): void {
1230
- if (!!this.props.multiSelect && this.hasShiftMask(event)) {
1231
- this.model.selectNextNode(TreeSelection.SelectionType.RANGE);
1232
- } else {
1233
- this.model.selectNextNode();
1234
- }
1235
- this.node.focus();
1236
- }
1237
-
1238
- /**
1239
- * Handle the `enter key` keyboard event.
1240
- * - `enter` opens the tree node.
1241
- * @param event the `enter key` keyboard event.
1242
- */
1243
- protected handleEnter(event: KeyboardEvent): void {
1244
- this.model.openNode();
1245
- }
1246
-
1247
- /**
1248
- * Handle the `space key` keyboard event.
1249
- * - If the element has a checkbox, it will be toggled.
1250
- * - Otherwise, it should be similar to a single-click action.
1251
- * @param event the `space key` keyboard event.
1252
- */
1253
- protected handleSpace(event: KeyboardEvent): void {
1254
- const { focusedNode } = this.focusService;
1255
- if (focusedNode && focusedNode.checkboxInfo) {
1256
- this.model.markAsChecked(focusedNode, !focusedNode.checkboxInfo.checked);
1257
- } else if (!this.props.multiSelect || (!event.ctrlKey && !event.metaKey && !event.shiftKey)) {
1258
- this.tapNode(focusedNode);
1259
- }
1260
- }
1261
-
1262
- protected handleEscape(event: KeyboardEvent): void {
1263
- if (this.model.selectedNodes.length <= 1) {
1264
- this.focusService.setFocus(undefined);
1265
- this.node.focus();
1266
- }
1267
- this.model.clearSelection();
1268
- }
1269
-
1270
- /**
1271
- * Handle the single-click mouse event.
1272
- * @param node the tree node if available.
1273
- * @param event the mouse single-click event.
1274
- */
1275
- protected handleClickEvent(node: TreeNode | undefined, event: React.MouseEvent<HTMLElement>): void {
1276
- if (node) {
1277
- event.stopPropagation();
1278
- const shiftMask = this.hasShiftMask(event);
1279
- const ctrlCmdMask = this.hasCtrlCmdMask(event);
1280
- if (this.props.multiSelect && (shiftMask || ctrlCmdMask) && SelectableTreeNode.is(node)) {
1281
- if (shiftMask) {
1282
- this.model.selectRange(node);
1283
- } else if (ctrlCmdMask) {
1284
- this.model.toggleNode(node);
1285
- }
1286
- } else {
1287
- this.tapNode(node);
1288
- }
1289
- }
1290
- }
1291
-
1292
- /**
1293
- * The effective handler of an unmodified single-click event.
1294
- */
1295
- protected tapNode(node?: TreeNode): void {
1296
- if (SelectableTreeNode.is(node)) {
1297
- this.model.selectNode(node);
1298
- }
1299
- if (node && !this.props.expandOnlyOnExpansionToggleClick && this.isExpandable(node)) {
1300
- this.model.toggleNodeExpansion(node);
1301
- }
1302
- }
1303
-
1304
- /**
1305
- * Handle the double-click mouse event.
1306
- * @param node the tree node if available.
1307
- * @param event the double-click mouse event.
1308
- */
1309
- protected handleDblClickEvent(node: TreeNode | undefined, event: React.MouseEvent<HTMLElement>): void {
1310
- this.model.openNode(node);
1311
- event.stopPropagation();
1312
- }
1313
-
1314
- /**
1315
- * Handle the middle-click mouse event.
1316
- * @param node the tree node if available.
1317
- * @param event the middle-click mouse event.
1318
- */
1319
- protected handleAuxClickEvent(node: TreeNode | undefined, event: React.MouseEvent<HTMLElement>): void {
1320
- if (event.button === 1) {
1321
- this.model.openNode(node);
1322
- if (SelectableTreeNode.is(node)) {
1323
- this.model.selectNode(node);
1324
- }
1325
- }
1326
- event.stopPropagation();
1327
- }
1328
-
1329
- /**
1330
- * Handle the middle-click mouse event.
1331
- * @param event the middle-click mouse event.
1332
- */
1333
- protected handleMiddleClickEvent(event: MouseEvent): void {
1334
- // Prevents auto-scrolling behavior when middle-clicking.
1335
- if (event.button === 1) {
1336
- event.preventDefault();
1337
- }
1338
- }
1339
-
1340
- /**
1341
- * Handle the context menu click event.
1342
- * - The context menu click event is triggered by the right-click.
1343
- * @param node the tree node if available.
1344
- * @param event the right-click mouse event.
1345
- */
1346
- protected handleContextMenuEvent(node: TreeNode | undefined, event: React.MouseEvent<HTMLElement>): void {
1347
- if (SelectableTreeNode.is(node)) {
1348
- // Keep the selection for the context menu, if the widget support multi-selection and the right click happens on an already selected node.
1349
- if (!this.props.multiSelect || !node.selected) {
1350
- const type = !!this.props.multiSelect && this.hasCtrlCmdMask(event) ? TreeSelection.SelectionType.TOGGLE : TreeSelection.SelectionType.DEFAULT;
1351
- this.model.addSelection({ node, type });
1352
- }
1353
- this.focusService.setFocus(node);
1354
- const contextMenuPath = this.props.contextMenuPath;
1355
- if (contextMenuPath) {
1356
- const { x, y } = event.nativeEvent;
1357
- const args = this.toContextMenuArgs(node);
1358
- setTimeout(() => this.contextMenuRenderer.render({
1359
- menuPath: contextMenuPath,
1360
- anchor: { x, y },
1361
- args
1362
- }), 10);
1363
- }
1364
- }
1365
- event.stopPropagation();
1366
- event.preventDefault();
1367
- }
1368
-
1369
- /**
1370
- * Handle the double-click mouse event on the expansion toggle.
1371
- */
1372
- protected readonly handleExpansionToggleDblClickEvent = (event: React.MouseEvent<HTMLElement>) => this.doHandleExpansionToggleDblClickEvent(event);
1373
- /**
1374
- * Actually handle the double-click mouse event on the expansion toggle.
1375
- * @param event the double-click mouse event.
1376
- */
1377
- protected doHandleExpansionToggleDblClickEvent(event: React.MouseEvent<HTMLElement>): void {
1378
- if (this.props.expandOnlyOnExpansionToggleClick) {
1379
- // Ignore the double-click event.
1380
- event.stopPropagation();
1381
- }
1382
- }
1383
-
1384
- /**
1385
- * Convert the tree node to context menu arguments.
1386
- * @param node the selectable tree node.
1387
- */
1388
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
1389
- protected toContextMenuArgs(node: SelectableTreeNode): any[] | undefined {
1390
- return undefined;
1391
- }
1392
-
1393
- /**
1394
- * Determine if the tree modifier aware event has a `ctrlcmd` mask.
1395
- * @param event the tree modifier aware event.
1396
- *
1397
- * @returns `true` if the tree modifier aware event contains the `ctrlcmd` mask.
1398
- */
1399
- protected hasCtrlCmdMask(event: TreeWidget.ModifierAwareEvent): boolean {
1400
- return isOSX ? event.metaKey : event.ctrlKey;
1401
- }
1402
-
1403
- /**
1404
- * Determine if the tree modifier aware event has a `shift` mask.
1405
- * @param event the tree modifier aware event.
1406
- *
1407
- * @returns `true` if the tree modifier aware event contains the `shift` mask.
1408
- */
1409
- protected hasShiftMask(event: TreeWidget.ModifierAwareEvent): boolean {
1410
- // Ctrl/Cmd mask overrules the Shift mask.
1411
- if (this.hasCtrlCmdMask(event)) {
1412
- return false;
1413
- }
1414
- return event.shiftKey;
1415
- }
1416
-
1417
- /**
1418
- * Deflate the tree node for storage.
1419
- * @param node the tree node.
1420
- */
1421
- protected deflateForStorage(node: TreeNode): object {
1422
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
1423
- const copy = Object.assign({}, node) as any;
1424
- if (copy.parent) {
1425
- delete copy.parent;
1426
- }
1427
- if ('previousSibling' in copy) {
1428
- delete copy.previousSibling;
1429
- }
1430
- if ('nextSibling' in copy) {
1431
- delete copy.nextSibling;
1432
- }
1433
- if ('busy' in copy) {
1434
- delete copy.busy;
1435
- }
1436
- if (CompositeTreeNode.is(node)) {
1437
- copy.children = [];
1438
- for (const child of node.children) {
1439
- copy.children.push(this.deflateForStorage(child));
1440
- }
1441
- }
1442
- return copy;
1443
- }
1444
-
1445
- /**
1446
- * Inflate the tree node from storage.
1447
- * @param node the tree node.
1448
- * @param parent the optional tree node.
1449
- */
1450
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
1451
- protected inflateFromStorage(node: any, parent?: TreeNode): TreeNode {
1452
- if (node.selected) {
1453
- node.selected = false;
1454
- }
1455
- if (parent) {
1456
- node.parent = parent;
1457
- }
1458
- if (Array.isArray(node.children)) {
1459
- for (const child of node.children as TreeNode[]) {
1460
- this.inflateFromStorage(child, node);
1461
- }
1462
- }
1463
- return node;
1464
- }
1465
-
1466
- /**
1467
- * Store the tree state.
1468
- */
1469
- storeState(): object {
1470
- const decorations = this.decoratorService.deflateDecorators(this.decorations);
1471
- let state: object = {
1472
- decorations
1473
- };
1474
- if (this.model.root) {
1475
- state = {
1476
- ...state,
1477
- root: this.deflateForStorage(this.model.root),
1478
- model: this.model.storeState(),
1479
- focusedNodeId: this.focusService.focusedNode?.id
1480
- };
1481
- }
1482
-
1483
- return state;
1484
- }
1485
-
1486
- /**
1487
- * Restore the state.
1488
- * @param oldState the old state object.
1489
- */
1490
- restoreState(oldState: object): void {
1491
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
1492
- const { root, decorations, model, focusedNodeId } = (oldState as any);
1493
- if (root) {
1494
- this.model.root = this.inflateFromStorage(root);
1495
- }
1496
- if (decorations) {
1497
- this.decorations = this.decoratorService.inflateDecorators(decorations);
1498
- }
1499
- if (model) {
1500
- this.model.restoreState(model);
1501
- }
1502
- if (focusedNodeId) {
1503
- const candidate = this.model.getNode(focusedNodeId);
1504
- if (SelectableTreeNode.is(candidate)) {
1505
- this.focusService.setFocus(candidate);
1506
- }
1507
- }
1508
- }
1509
-
1510
- protected toNodeIcon(node: TreeNode): string {
1511
- return this.labelProvider.getIcon(node);
1512
- }
1513
-
1514
- protected toNodeName(node: TreeNode): string {
1515
- return this.labelProvider.getName(node);
1516
- }
1517
-
1518
- protected toNodeDescription(node: TreeNode): string {
1519
- return this.labelProvider.getLongName(node);
1520
- }
1521
- protected getDepthPadding(depth: number): number {
1522
- if (depth === 1) {
1523
- return this.props.leftPadding;
1524
- }
1525
- return depth * this.treeIndent;
1526
- }
1527
- }
1528
- export namespace TreeWidget {
1529
- /**
1530
- * Representation of a tree node row.
1531
- */
1532
- export interface NodeRow {
1533
- /**
1534
- * The node row index.
1535
- */
1536
- index: number
1537
- /**
1538
- * The actual node.
1539
- */
1540
- node: TreeNode
1541
- /**
1542
- * A root relative number representing the hierarchical depth of the actual node. Root is `0`, its children have `1` and so on.
1543
- */
1544
- depth: number
1545
- }
1546
- /**
1547
- * Representation of the tree view properties.
1548
- */
1549
- export interface ViewProps {
1550
- /**
1551
- * The width property.
1552
- */
1553
- width: number
1554
- /**
1555
- * The height property.
1556
- */
1557
- height: number
1558
- /**
1559
- * The scroll to row value.
1560
- */
1561
- scrollToRow?: number
1562
- /**
1563
- * The list of node rows.
1564
- */
1565
- rows: NodeRow[]
1566
- renderNodeRow: (row: NodeRow) => React.ReactNode
1567
- }
1568
- export class View extends React.Component<ViewProps> {
1569
- list: VirtuosoHandle | undefined;
1570
- override render(): React.ReactNode {
1571
- const { rows, width, height, scrollToRow } = this.props;
1572
- return <Virtuoso
1573
- ref={list => {
1574
- this.list = (list || undefined);
1575
- if (this.list && scrollToRow !== undefined) {
1576
- this.list.scrollIntoView({
1577
- index: scrollToRow,
1578
- align: 'center'
1579
- });
1580
- }
1581
- }}
1582
- totalCount={rows.length}
1583
- itemContent={index => this.props.renderNodeRow(rows[index])}
1584
- width={width}
1585
- height={height}
1586
- // This is a pixel value, it will scan 200px to the top and bottom of the current view
1587
- overscan={500}
1588
- />;
1589
- }
1590
- }
1591
- }
1
+ // *****************************************************************************
2
+ // Copyright (C) 2018 TypeFox and others.
3
+ //
4
+ // This program and the accompanying materials are made available under the
5
+ // terms of the Eclipse Public License v. 2.0 which is available at
6
+ // http://www.eclipse.org/legal/epl-2.0.
7
+ //
8
+ // This Source Code may also be made available under the following Secondary
9
+ // Licenses when the conditions for such availability set forth in the Eclipse
10
+ // Public License v. 2.0 are satisfied: GNU General Public License, version 2
11
+ // with the GNU Classpath Exception which is available at
12
+ // https://www.gnu.org/software/classpath/license.html.
13
+ //
14
+ // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
15
+ // *****************************************************************************
16
+
17
+ import { injectable, inject, postConstruct } from 'inversify';
18
+ import { Message } from '@phosphor/messaging';
19
+ import { Disposable, MenuPath, SelectionService } from '../../common';
20
+ import { Key, KeyCode, KeyModifier } from '../keyboard/keys';
21
+ import { ContextMenuRenderer } from '../context-menu-renderer';
22
+ import { StatefulWidget } from '../shell';
23
+ import {
24
+ EXPANSION_TOGGLE_CLASS, SELECTED_CLASS, COLLAPSED_CLASS, FOCUS_CLASS, BUSY_CLASS, CODICON_TREE_ITEM_CLASSES, CODICON_LOADING_CLASSES, Widget, UnsafeWidgetUtilities
25
+ } from '../widgets';
26
+ import { TreeNode, CompositeTreeNode } from './tree';
27
+ import { TreeModel } from './tree-model';
28
+ import { ExpandableTreeNode } from './tree-expansion';
29
+ import { SelectableTreeNode, TreeSelection } from './tree-selection';
30
+ import { TreeDecoratorService, TreeDecoration, DecoratedTreeNode } from './tree-decorator';
31
+ import { notEmpty } from '../../common/objects';
32
+ import { isOSX } from '../../common/os';
33
+ import { ReactWidget } from '../widgets/react-widget';
34
+ import * as React from 'react';
35
+ import { Virtuoso, VirtuosoHandle } from 'react-virtuoso';
36
+ import { TopDownTreeIterator } from './tree-iterator';
37
+ import { SearchBox, SearchBoxFactory, SearchBoxProps } from './search-box';
38
+ import { TreeSearch } from './tree-search';
39
+ import { ElementExt } from '@phosphor/domutils';
40
+ import { TreeWidgetSelection } from './tree-widget-selection';
41
+ import { MaybePromise } from '../../common/types';
42
+ import { LabelProvider } from '../label-provider';
43
+ import { CorePreferences } from '../core-preferences';
44
+ import { TreeFocusService } from './tree-focus-service';
45
+ import { useEffect } from 'react';
46
+ import { PreferenceService, PreferenceChange } from '../preferences';
47
+ import { PREFERENCE_NAME_TREE_INDENT } from './tree-preference';
48
+
49
+ const debounce = require('lodash.debounce');
50
+
51
+ export const TREE_CLASS = 'theia-Tree';
52
+ export const TREE_CONTAINER_CLASS = 'theia-TreeContainer';
53
+ export const TREE_NODE_CLASS = 'theia-TreeNode';
54
+ export const TREE_NODE_CONTENT_CLASS = 'theia-TreeNodeContent';
55
+ export const TREE_NODE_INFO_CLASS = 'theia-TreeNodeInfo';
56
+ export const TREE_NODE_TAIL_CLASS = 'theia-TreeNodeTail';
57
+ export const TREE_NODE_SEGMENT_CLASS = 'theia-TreeNodeSegment';
58
+ export const TREE_NODE_SEGMENT_GROW_CLASS = 'theia-TreeNodeSegmentGrow';
59
+
60
+ export const EXPANDABLE_TREE_NODE_CLASS = 'theia-ExpandableTreeNode';
61
+ export const COMPOSITE_TREE_NODE_CLASS = 'theia-CompositeTreeNode';
62
+ export const TREE_NODE_CAPTION_CLASS = 'theia-TreeNodeCaption';
63
+ export const TREE_NODE_INDENT_GUIDE_CLASS = 'theia-tree-node-indent';
64
+
65
+ export const TreeProps = Symbol('TreeProps');
66
+
67
+ /**
68
+ * Representation of tree properties.
69
+ */
70
+ export interface TreeProps {
71
+
72
+ /**
73
+ * The path of the context menu that one can use to contribute context menu items to the tree widget.
74
+ */
75
+ readonly contextMenuPath?: MenuPath;
76
+
77
+ /**
78
+ * The size of the padding (in pixels) for the root node of the tree.
79
+ */
80
+ readonly leftPadding: number;
81
+
82
+ readonly expansionTogglePadding: number;
83
+
84
+ /**
85
+ * `true` if the tree widget support multi-selection. Otherwise, `false`. Defaults to `false`.
86
+ */
87
+ readonly multiSelect?: boolean;
88
+
89
+ /**
90
+ * `true` if the tree widget support searching. Otherwise, `false`. Defaults to `false`.
91
+ */
92
+ readonly search?: boolean
93
+
94
+ /**
95
+ * `true` if the tree widget should be virtualized searching. Otherwise, `false`. Defaults to `true`.
96
+ */
97
+ readonly virtualized?: boolean
98
+
99
+ /**
100
+ * `true` if the selected node should be auto scrolled only if the widget is active. Otherwise, `false`. Defaults to `false`.
101
+ */
102
+ readonly scrollIfActive?: boolean
103
+
104
+ /**
105
+ * `true` if a tree widget contributes to the global selection. Defaults to `false`.
106
+ */
107
+ readonly globalSelection?: boolean;
108
+
109
+ /**
110
+ * `true` if the tree widget supports expansion only when clicking the expansion toggle. Defaults to `false`.
111
+ */
112
+ readonly expandOnlyOnExpansionToggleClick?: boolean;
113
+
114
+ }
115
+
116
+ /**
117
+ * Representation of node properties.
118
+ */
119
+ export interface NodeProps {
120
+
121
+ /**
122
+ * A root relative number representing the hierarchical depth of the actual node. Root is `0`, its children have `1` and so on.
123
+ */
124
+ readonly depth: number;
125
+
126
+ }
127
+
128
+ /**
129
+ * The default tree properties.
130
+ */
131
+ export const defaultTreeProps: TreeProps = {
132
+ leftPadding: 8,
133
+ expansionTogglePadding: 22
134
+ };
135
+
136
+ export namespace TreeWidget {
137
+
138
+ /**
139
+ * Bare minimum common interface of the keyboard and the mouse event with respect to the key maskings.
140
+ */
141
+ export interface ModifierAwareEvent {
142
+ /**
143
+ * Determines if the modifier aware event has the `meta` key masking.
144
+ */
145
+ readonly metaKey: boolean;
146
+ /**
147
+ * Determines if the modifier aware event has the `ctrl` key masking.
148
+ */
149
+ readonly ctrlKey: boolean;
150
+ /**
151
+ * Determines if the modifier aware event has the `shift` key masking.
152
+ */
153
+ readonly shiftKey: boolean;
154
+ }
155
+
156
+ }
157
+
158
+ @injectable()
159
+ export class TreeWidget extends ReactWidget implements StatefulWidget {
160
+
161
+ protected searchBox: SearchBox;
162
+ protected searchHighlights: Map<string, TreeDecoration.CaptionHighlight>;
163
+
164
+ @inject(TreeDecoratorService)
165
+ protected readonly decoratorService: TreeDecoratorService;
166
+ @inject(TreeSearch)
167
+ protected readonly treeSearch: TreeSearch;
168
+ @inject(SearchBoxFactory)
169
+ protected readonly searchBoxFactory: SearchBoxFactory;
170
+ @inject(TreeFocusService)
171
+ protected readonly focusService: TreeFocusService;
172
+
173
+ protected decorations: Map<string, TreeDecoration.Data[]> = new Map();
174
+
175
+ @inject(SelectionService)
176
+ protected readonly selectionService: SelectionService;
177
+
178
+ @inject(PreferenceService)
179
+ protected readonly preferenceService: PreferenceService;
180
+
181
+ @inject(LabelProvider)
182
+ protected readonly labelProvider: LabelProvider;
183
+
184
+ @inject(CorePreferences)
185
+ protected readonly corePreferences: CorePreferences;
186
+
187
+ protected shouldScrollToRow = true;
188
+
189
+ protected treeIndent: number = 8;
190
+
191
+ constructor(
192
+ @inject(TreeProps) readonly props: TreeProps,
193
+ @inject(TreeModel) readonly model: TreeModel,
194
+ @inject(ContextMenuRenderer) protected readonly contextMenuRenderer: ContextMenuRenderer,
195
+ ) {
196
+ super();
197
+ this.scrollOptions = {
198
+ suppressScrollX: true,
199
+ minScrollbarLength: 35
200
+ };
201
+ this.addClass(TREE_CLASS);
202
+ this.node.tabIndex = 0;
203
+ }
204
+
205
+ @postConstruct()
206
+ protected init(): void {
207
+ this.treeIndent = this.preferenceService.get(PREFERENCE_NAME_TREE_INDENT, this.treeIndent);
208
+ if (this.props.search) {
209
+ this.searchBox = this.searchBoxFactory({ ...SearchBoxProps.DEFAULT, showButtons: true, showFilter: true });
210
+ this.searchBox.node.addEventListener('focus', () => {
211
+ this.node.focus();
212
+ });
213
+ this.toDispose.pushAll([
214
+ this.searchBox,
215
+ this.searchBox.onTextChange(async data => {
216
+ await this.treeSearch.filter(data);
217
+ this.searchHighlights = this.treeSearch.getHighlights();
218
+ this.searchBox.updateHighlightInfo({
219
+ filterText: data,
220
+ total: this.rows.size,
221
+ matched: this.searchHighlights.size
222
+ });
223
+ this.update();
224
+ }),
225
+ this.searchBox.onClose(data => this.treeSearch.filter(undefined)),
226
+ this.searchBox.onNext(() => {
227
+ // Enable next selection if there are currently highlights.
228
+ if (this.searchHighlights.size > 1) {
229
+ this.model.selectNextNode();
230
+ }
231
+ }),
232
+ this.searchBox.onPrevious(() => {
233
+ // Enable previous selection if there are currently highlights.
234
+ if (this.searchHighlights.size > 1) {
235
+ this.model.selectPrevNode();
236
+ }
237
+ }),
238
+ this.searchBox.onFilterToggled(e => {
239
+ this.updateRows();
240
+ }),
241
+ this.treeSearch,
242
+ this.treeSearch.onFilteredNodesChanged(nodes => {
243
+ if (this.searchBox.isFiltering) {
244
+ this.updateRows();
245
+ }
246
+ const node = nodes.find(SelectableTreeNode.is);
247
+ if (node) {
248
+ this.model.selectNode(node);
249
+ }
250
+ }),
251
+ ]);
252
+ }
253
+ this.node.addEventListener('mousedown', this.handleMiddleClickEvent.bind(this));
254
+ this.node.addEventListener('mouseup', this.handleMiddleClickEvent.bind(this));
255
+ this.node.addEventListener('auxclick', this.handleMiddleClickEvent.bind(this));
256
+ this.toDispose.pushAll([
257
+ this.model,
258
+ this.model.onChanged(() => this.updateRows()),
259
+ this.model.onSelectionChanged(() => this.scheduleUpdateScrollToRow({ resize: false })),
260
+ this.focusService.onDidChangeFocus(() => this.scheduleUpdateScrollToRow({ resize: false })),
261
+ this.model.onDidChangeBusy(() => this.update()),
262
+ this.model.onDidUpdate(() => this.update()),
263
+ this.model.onNodeRefreshed(() => this.updateDecorations()),
264
+ this.model.onExpansionChanged(() => this.updateDecorations()),
265
+ this.decoratorService,
266
+ this.decoratorService.onDidChangeDecorations(() => this.updateDecorations()),
267
+ this.labelProvider.onDidChange(e => {
268
+ for (const row of this.rows.values()) {
269
+ if (e.affects(row)) {
270
+ this.update();
271
+ return;
272
+ }
273
+ }
274
+ }),
275
+ this.preferenceService.onPreferenceChanged((event: PreferenceChange) => {
276
+ if (event.preferenceName === PREFERENCE_NAME_TREE_INDENT) {
277
+ this.treeIndent = event.newValue;
278
+ this.update();
279
+ }
280
+ })
281
+ ]);
282
+ setTimeout(() => {
283
+ this.updateRows();
284
+ this.updateDecorations();
285
+ });
286
+ if (this.props.globalSelection) {
287
+ this.toDispose.pushAll([
288
+ this.model.onSelectionChanged(() => {
289
+ if (this.node.contains(document.activeElement)) {
290
+ this.updateGlobalSelection();
291
+ }
292
+ }),
293
+ this.focusService.onDidChangeFocus(focus => {
294
+ if (focus && this.node.contains(document.activeElement) && this.model.selectedNodes[0] !== focus && this.model.selectedNodes.includes(focus)) {
295
+ this.updateGlobalSelection();
296
+ }
297
+ }),
298
+ Disposable.create(() => {
299
+ const selection = this.selectionService.selection;
300
+ if (TreeWidgetSelection.isSource(selection, this)) {
301
+ this.selectionService.selection = undefined;
302
+ }
303
+ })
304
+ ]);
305
+
306
+ this.node.addEventListener('focusin', e => {
307
+ if (this.model.selectedNodes.length && (!this.selectionService.selection || !TreeWidgetSelection.isSource(this.selectionService.selection, this))) {
308
+ this.updateGlobalSelection();
309
+ }
310
+ });
311
+ }
312
+ this.toDispose.push(this.corePreferences.onPreferenceChanged(preference => {
313
+ if (preference.preferenceName === 'workbench.tree.renderIndentGuides') {
314
+ this.update();
315
+ }
316
+ }));
317
+ }
318
+
319
+ /**
320
+ * Update the global selection for the tree.
321
+ */
322
+ protected updateGlobalSelection(): void {
323
+ this.selectionService.selection = TreeWidgetSelection.create(this);
324
+ }
325
+
326
+ protected rows = new Map<string, TreeWidget.NodeRow>();
327
+ protected updateRows = debounce(() => this.doUpdateRows(), 10);
328
+ protected doUpdateRows(): void {
329
+ const root = this.model.root;
330
+ const rowsToUpdate: Array<[string, TreeWidget.NodeRow]> = [];
331
+ if (root) {
332
+ const depths = new Map<CompositeTreeNode | undefined, number>();
333
+ let index = 0;
334
+ for (const node of new TopDownTreeIterator(root, {
335
+ pruneCollapsed: true,
336
+ pruneSiblings: true
337
+ })) {
338
+ if (this.shouldDisplayNode(node)) {
339
+ const depth = this.getDepthForNode(node, depths);
340
+ if (CompositeTreeNode.is(node)) {
341
+ depths.set(node, depth);
342
+ }
343
+ rowsToUpdate.push([node.id, this.toNodeRow(node, index++, depth)]);
344
+ }
345
+ }
346
+ }
347
+ this.rows = new Map(rowsToUpdate);
348
+ this.update();
349
+ }
350
+
351
+ protected getDepthForNode(node: TreeNode, depths: Map<CompositeTreeNode | undefined, number>): number {
352
+ const parentDepth = depths.get(node.parent);
353
+ return parentDepth === undefined ? 0 : TreeNode.isVisible(node.parent) ? parentDepth + 1 : parentDepth;
354
+ }
355
+
356
+ protected toNodeRow(node: TreeNode, index: number, depth: number): TreeWidget.NodeRow {
357
+ return { node, index, depth };
358
+ }
359
+
360
+ protected shouldDisplayNode(node: TreeNode): boolean {
361
+ return TreeNode.isVisible(node) && (!this.searchBox?.isFiltering || this.treeSearch.passesFilters(node));
362
+ }
363
+
364
+ /**
365
+ * Row index to ensure visibility.
366
+ * - Used to forcefully scroll if necessary.
367
+ */
368
+ protected scrollToRow: number | undefined;
369
+ /**
370
+ * Update the `scrollToRow`.
371
+ * @param updateOptions the tree widget force update options.
372
+ */
373
+ protected updateScrollToRow(): void {
374
+ this.scrollToRow = this.getScrollToRow();
375
+ this.update();
376
+ }
377
+
378
+ protected scheduleUpdateScrollToRow = debounce(this.updateScrollToRow);
379
+
380
+ /**
381
+ * Get the `scrollToRow`.
382
+ *
383
+ * @returns the `scrollToRow` if available.
384
+ */
385
+ protected getScrollToRow(): number | undefined {
386
+ if (!this.shouldScrollToRow) {
387
+ return undefined;
388
+ }
389
+ const { focusedNode } = this.focusService;
390
+ return focusedNode && this.rows.get(focusedNode.id)?.index;
391
+ }
392
+
393
+ /**
394
+ * Update tree decorations.
395
+ * - Updating decorations are debounced in order to limit the number of expensive updates.
396
+ */
397
+ protected readonly updateDecorations = debounce(() => this.doUpdateDecorations(), 150);
398
+ protected async doUpdateDecorations(): Promise<void> {
399
+ this.decorations = await this.decoratorService.getDecorations(this.model);
400
+ this.update();
401
+ }
402
+
403
+ protected override onActivateRequest(msg: Message): void {
404
+ super.onActivateRequest(msg);
405
+ this.node.focus({ preventScroll: true });
406
+ }
407
+
408
+ /**
409
+ * Actually focus the tree node.
410
+ */
411
+ protected doFocus(): void {
412
+ if (!this.model.selectedNodes.length) {
413
+ const node = this.getNodeToFocus();
414
+ if (SelectableTreeNode.is(node)) {
415
+ this.model.selectNode(node);
416
+ }
417
+ }
418
+ }
419
+
420
+ /**
421
+ * Get the tree node to focus.
422
+ *
423
+ * @returns the node to focus if available.
424
+ */
425
+ protected getNodeToFocus(): SelectableTreeNode | undefined {
426
+ const { focusedNode } = this.focusService;
427
+ if (focusedNode) {
428
+ return focusedNode;
429
+ }
430
+ const { root } = this.model;
431
+ if (SelectableTreeNode.isVisible(root)) {
432
+ return root;
433
+ }
434
+ return this.model.getNextSelectableNode(root);
435
+ }
436
+
437
+ protected override onUpdateRequest(msg: Message): void {
438
+ if (!this.isAttached || !this.isVisible) {
439
+ return;
440
+ }
441
+ super.onUpdateRequest(msg);
442
+ }
443
+
444
+ protected override onResize(msg: Widget.ResizeMessage): void {
445
+ super.onResize(msg);
446
+ this.update();
447
+ }
448
+
449
+ protected render(): React.ReactNode {
450
+ return React.createElement('div', this.createContainerAttributes(), this.renderTree(this.model));
451
+ }
452
+
453
+ /**
454
+ * Create the container attributes for the widget.
455
+ */
456
+ protected createContainerAttributes(): React.HTMLAttributes<HTMLElement> {
457
+ const classNames = [TREE_CONTAINER_CLASS];
458
+ if (!this.rows.size) {
459
+ classNames.push('empty');
460
+ }
461
+ if (this.model.selectedNodes.length === 0 && !this.focusService.focusedNode) {
462
+ classNames.push('focused');
463
+ }
464
+ return {
465
+ className: classNames.join(' '),
466
+ onContextMenu: event => this.handleContextMenuEvent(this.getContainerTreeNode(), event)
467
+ };
468
+ }
469
+ /**
470
+ * Get the container tree node.
471
+ *
472
+ * @returns the tree node for the container if available.
473
+ */
474
+ protected getContainerTreeNode(): TreeNode | undefined {
475
+ return this.model.root;
476
+ }
477
+
478
+ protected ScrollingRowRenderer: React.FC<{ rows: TreeWidget.NodeRow[] }> = ({ rows }) => {
479
+ useEffect(() => this.scrollToSelected());
480
+ return <>{rows.map(row => <div key={row.index}>{this.renderNodeRow(row)}</div>)}</>;
481
+ };
482
+
483
+ protected view: TreeWidget.View | undefined;
484
+ /**
485
+ * Render the tree widget.
486
+ * @param model the tree model.
487
+ */
488
+ protected renderTree(model: TreeModel): React.ReactNode {
489
+ if (model.root) {
490
+ const rows = Array.from(this.rows.values());
491
+ if (this.props.virtualized === false) {
492
+ return <this.ScrollingRowRenderer rows={rows} />;
493
+ }
494
+ return <TreeWidget.View
495
+ ref={view => this.view = (view || undefined)}
496
+ width={this.node.offsetWidth}
497
+ height={this.node.offsetHeight}
498
+ rows={rows}
499
+ renderNodeRow={this.renderNodeRow}
500
+ scrollToRow={this.scrollToRow}
501
+ />;
502
+ }
503
+ // eslint-disable-next-line no-null/no-null
504
+ return null;
505
+ }
506
+
507
+ scrollArea: Element = this.node;
508
+ /**
509
+ * Scroll to the selected tree node.
510
+ */
511
+ protected scrollToSelected(): void {
512
+ if (this.props.scrollIfActive === true && !this.node.contains(document.activeElement)) {
513
+ return;
514
+ }
515
+ const focus = this.node.getElementsByClassName(FOCUS_CLASS)[0];
516
+ if (focus) {
517
+ ElementExt.scrollIntoViewIfNeeded(this.scrollArea, focus);
518
+ } else {
519
+ const selected = this.node.getElementsByClassName(SELECTED_CLASS)[0];
520
+ if (selected) {
521
+ ElementExt.scrollIntoViewIfNeeded(this.scrollArea, selected);
522
+ }
523
+ }
524
+ }
525
+
526
+ /**
527
+ * Render the node row.
528
+ */
529
+ protected readonly renderNodeRow = (row: TreeWidget.NodeRow) => this.doRenderNodeRow(row);
530
+ /**
531
+ * Actually render the node row.
532
+ */
533
+ protected doRenderNodeRow({ node, depth }: TreeWidget.NodeRow): React.ReactNode {
534
+ return <React.Fragment>
535
+ {this.renderIndent(node, { depth })}
536
+ {this.renderNode(node, { depth })}
537
+ </React.Fragment>;
538
+ }
539
+
540
+ /**
541
+ * Render the tree node given the node properties.
542
+ * @param node the tree node.
543
+ * @param props the node properties.
544
+ */
545
+ protected renderIcon(node: TreeNode, props: NodeProps): React.ReactNode {
546
+ // eslint-disable-next-line no-null/no-null
547
+ return null;
548
+ }
549
+
550
+ /**
551
+ * Toggle the node.
552
+ */
553
+ protected readonly toggle = (event: React.MouseEvent<HTMLElement>) => this.doToggle(event);
554
+ /**
555
+ * Actually toggle the tree node.
556
+ * @param event the mouse click event.
557
+ */
558
+ protected doToggle(event: React.MouseEvent<HTMLElement>): void {
559
+ const nodeId = event.currentTarget.getAttribute('data-node-id');
560
+ if (nodeId) {
561
+ const node = this.model.getNode(nodeId);
562
+ if (node && this.props.expandOnlyOnExpansionToggleClick) {
563
+ if (this.isExpandable(node) && !this.hasShiftMask(event) && !this.hasCtrlCmdMask(event)) {
564
+ this.model.toggleNodeExpansion(node);
565
+ }
566
+ } else {
567
+ this.handleClickEvent(node, event);
568
+ }
569
+ }
570
+ event.stopPropagation();
571
+ }
572
+
573
+ /**
574
+ * Render the node expansion toggle.
575
+ * @param node the tree node.
576
+ * @param props the node properties.
577
+ */
578
+ protected renderExpansionToggle(node: TreeNode, props: NodeProps): React.ReactNode {
579
+ if (!this.isExpandable(node)) {
580
+ // eslint-disable-next-line no-null/no-null
581
+ return null;
582
+ }
583
+ const classes = [TREE_NODE_SEGMENT_CLASS, EXPANSION_TOGGLE_CLASS];
584
+ if (!node.expanded) {
585
+ classes.push(COLLAPSED_CLASS);
586
+ }
587
+ if (node.busy) {
588
+ classes.push(BUSY_CLASS, ...CODICON_LOADING_CLASSES);
589
+ } else {
590
+ classes.push(...CODICON_TREE_ITEM_CLASSES);
591
+ }
592
+ const className = classes.join(' ');
593
+ return <div
594
+ data-node-id={node.id}
595
+ className={className}
596
+ onClick={this.toggle}
597
+ onDoubleClick={this.handleExpansionToggleDblClickEvent}>
598
+ </div>;
599
+ }
600
+
601
+ /**
602
+ * Render the node expansion toggle.
603
+ * @param node the tree node.
604
+ * @param props the node properties.
605
+ */
606
+ protected renderCheckbox(node: TreeNode, props: NodeProps): React.ReactNode {
607
+ if (node.checkboxInfo === undefined) {
608
+ // eslint-disable-next-line no-null/no-null
609
+ return null;
610
+ }
611
+ return <input data-node-id={node.id}
612
+ readOnly
613
+ type='checkbox'
614
+ checked={!!node.checkboxInfo.checked}
615
+ title={node.checkboxInfo.tooltip}
616
+ aria-label={node.checkboxInfo.accessibilityInformation?.label}
617
+ role={node.checkboxInfo.accessibilityInformation?.role}
618
+ className='theia-input'
619
+ onClick={event => this.toggleChecked(event)} />;
620
+ }
621
+
622
+ protected toggleChecked(event: React.MouseEvent<HTMLElement>): void {
623
+ const nodeId = event.currentTarget.getAttribute('data-node-id');
624
+ if (nodeId) {
625
+ const node = this.model.getNode(nodeId);
626
+ if (node) {
627
+ this.model.markAsChecked(node, !node.checkboxInfo!.checked);
628
+ } else {
629
+ this.handleClickEvent(node, event);
630
+ }
631
+ }
632
+ event.preventDefault();
633
+ event.stopPropagation();
634
+ }
635
+ /**
636
+ * Render the tree node caption given the node properties.
637
+ * @param node the tree node.
638
+ * @param props the node properties.
639
+ */
640
+ protected renderCaption(node: TreeNode, props: NodeProps): React.ReactNode {
641
+ const attrs = this.getCaptionAttributes(node, props);
642
+ const children = this.getCaptionChildren(node, props);
643
+ return React.createElement('div', attrs, children);
644
+ }
645
+
646
+ protected getCaptionAttributes(node: TreeNode, props: NodeProps): React.Attributes & React.HTMLAttributes<HTMLElement> {
647
+ const tooltip = this.getDecorationData(node, 'tooltip').filter(notEmpty).join(' • ');
648
+ const classes = [TREE_NODE_SEGMENT_CLASS];
649
+ if (!this.hasTrailingSuffixes(node)) {
650
+ classes.push(TREE_NODE_SEGMENT_GROW_CLASS);
651
+ }
652
+ const className = classes.join(' ');
653
+ let attrs = this.decorateCaption(node, {
654
+ className, id: node.id
655
+ });
656
+ if (tooltip.length > 0) {
657
+ attrs = {
658
+ ...attrs,
659
+ title: tooltip
660
+ };
661
+ }
662
+ return attrs;
663
+ }
664
+
665
+ protected getCaptionChildren(node: TreeNode, props: NodeProps): React.ReactNode {
666
+ const children = [];
667
+ const caption = this.toNodeName(node);
668
+ const highlight = this.getDecorationData(node, 'highlight')[0];
669
+ if (highlight) {
670
+ children.push(this.toReactNode(caption, highlight));
671
+ }
672
+ const searchHighlight = this.searchHighlights ? this.searchHighlights.get(node.id) : undefined;
673
+ if (searchHighlight) {
674
+ children.push(...this.toReactNode(caption, searchHighlight));
675
+ } else if (!highlight) {
676
+ children.push(caption);
677
+ }
678
+ return children;
679
+ }
680
+
681
+ /**
682
+ * Update the node given the caption and highlight.
683
+ * @param caption the caption.
684
+ * @param highlight the tree decoration caption highlight.
685
+ */
686
+ protected toReactNode(caption: string, highlight: TreeDecoration.CaptionHighlight): React.ReactNode[] {
687
+ let style: React.CSSProperties = {};
688
+ if (highlight.color) {
689
+ style = {
690
+ ...style,
691
+ color: highlight.color
692
+ };
693
+ }
694
+ if (highlight.backgroundColor) {
695
+ style = {
696
+ ...style,
697
+ backgroundColor: highlight.backgroundColor
698
+ };
699
+ }
700
+ const createChildren = (fragment: TreeDecoration.CaptionHighlight.Fragment, index: number) => {
701
+ const { data } = fragment;
702
+ if (fragment.highlight) {
703
+ return <mark className={TreeDecoration.Styles.CAPTION_HIGHLIGHT_CLASS} style={style} key={index}>{data}</mark>;
704
+ } else {
705
+ return data;
706
+ }
707
+ };
708
+ return TreeDecoration.CaptionHighlight.split(caption, highlight).map(createChildren);
709
+ }
710
+
711
+ /**
712
+ * Decorate the tree caption.
713
+ * @param node the tree node.
714
+ * @param attrs the additional attributes.
715
+ */
716
+ protected decorateCaption(node: TreeNode, attrs: React.HTMLAttributes<HTMLElement>): React.Attributes & React.HTMLAttributes<HTMLElement> {
717
+ const style = this.getDecorationData(node, 'fontData')
718
+ .filter(notEmpty)
719
+ .reverse()
720
+ .map(fontData => this.applyFontStyles({}, fontData))
721
+ .reduce((acc, current) => ({
722
+ ...acc,
723
+ ...current
724
+ }), {});
725
+ return {
726
+ ...attrs,
727
+ style
728
+ };
729
+ }
730
+
731
+ /**
732
+ * Determine if the tree node contains trailing suffixes.
733
+ * @param node the tree node.
734
+ *
735
+ * @returns `true` if the tree node contains trailing suffices.
736
+ */
737
+ protected hasTrailingSuffixes(node: TreeNode): boolean {
738
+ return this.getDecorationData(node, 'captionSuffixes').filter(notEmpty).reduce((acc, current) => acc.concat(current), []).length > 0;
739
+ }
740
+
741
+ /**
742
+ * Apply font styles to the tree.
743
+ * @param original the original css properties.
744
+ * @param fontData the optional `fontData`.
745
+ */
746
+ protected applyFontStyles(original: React.CSSProperties, fontData: TreeDecoration.FontData | undefined): React.CSSProperties {
747
+ if (fontData === undefined) {
748
+ return original;
749
+ }
750
+ const modified = { ...original }; // make a copy to mutate
751
+ const { color, style } = fontData;
752
+ if (color) {
753
+ modified.color = color;
754
+ }
755
+ if (style) {
756
+ (Array.isArray(style) ? style : [style]).forEach(s => {
757
+ switch (s) {
758
+ case 'bold':
759
+ modified.fontWeight = s;
760
+ break;
761
+ case 'normal':
762
+ case 'oblique':
763
+ case 'italic':
764
+ modified.fontStyle = s;
765
+ break;
766
+ case 'underline':
767
+ case 'line-through':
768
+ modified.textDecoration = s;
769
+ break;
770
+ default:
771
+ throw new Error(`Unexpected font style: "${s}".`);
772
+ }
773
+ });
774
+ }
775
+ return modified;
776
+ }
777
+
778
+ /**
779
+ * Render caption affixes for the given tree node.
780
+ * @param node the tree node.
781
+ * @param props the node properties.
782
+ * @param affixKey the affix key.
783
+ */
784
+ protected renderCaptionAffixes(node: TreeNode, props: NodeProps, affixKey: 'captionPrefixes' | 'captionSuffixes'): React.ReactNode {
785
+ const suffix = affixKey === 'captionSuffixes';
786
+ const affixClass = suffix ? TreeDecoration.Styles.CAPTION_SUFFIX_CLASS : TreeDecoration.Styles.CAPTION_PREFIX_CLASS;
787
+ const classes = [TREE_NODE_SEGMENT_CLASS, affixClass];
788
+ const affixes = this.getDecorationData(node, affixKey).filter(notEmpty).reduce((acc, current) => acc.concat(current), []);
789
+ const children: React.ReactNode[] = [];
790
+ for (let i = 0; i < affixes.length; i++) {
791
+ const affix = affixes[i];
792
+ if (suffix && i === affixes.length - 1) {
793
+ classes.push(TREE_NODE_SEGMENT_GROW_CLASS);
794
+ }
795
+ const style = this.applyFontStyles({}, affix.fontData);
796
+ const className = classes.join(' ');
797
+ const key = node.id + '_' + i;
798
+ const attrs = {
799
+ className,
800
+ style,
801
+ key
802
+ };
803
+ children.push(React.createElement('div', attrs, affix.data));
804
+ }
805
+ return <React.Fragment>{children}</React.Fragment>;
806
+ }
807
+
808
+ /**
809
+ * Decorate the tree node icon.
810
+ * @param node the tree node.
811
+ * @param icon the icon.
812
+ */
813
+ protected decorateIcon(node: TreeNode, icon: React.ReactNode): React.ReactNode {
814
+ if (!icon) {
815
+ return;
816
+ }
817
+ const overlayIcons: React.ReactNode[] = [];
818
+ // if multiple overlays have the same overlay.position attribute, we'll de-duplicate those and only process the first one from the decoration array
819
+ const seenPositions = new Set<TreeDecoration.IconOverlayPosition>();
820
+ const overlays = this.getDecorationData(node, 'iconOverlay').filter(notEmpty);
821
+
822
+ for (const overlay of overlays) {
823
+ if (!seenPositions.has(overlay.position)) {
824
+ seenPositions.add(overlay.position);
825
+ const iconClasses = [TreeDecoration.Styles.DECORATOR_SIZE_CLASS, TreeDecoration.IconOverlayPosition.getStyle(overlay.position)];
826
+ const style = (color?: string) => color === undefined ? {} : { color };
827
+
828
+ if (overlay.background) {
829
+ overlayIcons.push(<span key={node.id + 'bg'} className={this.getIconClass(overlay.background.shape, iconClasses)}
830
+ style={style(overlay.background.color)}></span>);
831
+ }
832
+
833
+ const overlayIcon = 'icon' in overlay ? overlay.icon : overlay.iconClass;
834
+ overlayIcons.push(<span key={node.id} className={this.getIconClass(overlayIcon, iconClasses)} style={style(overlay.color)}></span>);
835
+ }
836
+ }
837
+
838
+ if (overlayIcons.length > 0) {
839
+ return <div className={TreeDecoration.Styles.ICON_WRAPPER_CLASS}>{icon}{overlayIcons}</div>;
840
+ }
841
+
842
+ return icon;
843
+ }
844
+
845
+ /**
846
+ * Render the tree node tail decorations.
847
+ * @param node the tree node.
848
+ * @param props the node properties.
849
+ */
850
+ protected renderTailDecorations(node: TreeNode, props: NodeProps): React.ReactNode {
851
+ const tailDecorations = this.getDecorationData(node, 'tailDecorations').reduce((acc, current) => acc.concat(current), []);
852
+ if (tailDecorations.length === 0) {
853
+ return;
854
+ }
855
+ return this.renderTailDecorationsForNode(node, props, tailDecorations);
856
+ }
857
+
858
+ protected renderTailDecorationsForNode(node: TreeNode, props: NodeProps, tailDecorations: TreeDecoration.TailDecoration.AnyPartial[]): React.ReactNode {
859
+ let dotDecoration: TreeDecoration.TailDecoration.AnyPartial | undefined;
860
+ const otherDecorations: TreeDecoration.TailDecoration.AnyPartial[] = [];
861
+ tailDecorations.reverse().forEach(decoration => {
862
+ if (TreeDecoration.TailDecoration.isDotDecoration(decoration)) {
863
+ dotDecoration ||= decoration;
864
+ } else if (decoration.data || decoration.icon || decoration.iconClass) {
865
+ otherDecorations.push(decoration);
866
+ }
867
+ });
868
+ const decorationsToRender = dotDecoration ? [dotDecoration, ...otherDecorations] : otherDecorations;
869
+ return <React.Fragment>
870
+ {decorationsToRender.map((decoration, index) => {
871
+ const { tooltip, data, fontData, color, icon, iconClass } = decoration;
872
+ const iconToRender = icon ?? iconClass;
873
+ const className = [TREE_NODE_SEGMENT_CLASS, TREE_NODE_TAIL_CLASS, 'flex'].join(' ');
874
+ const style = fontData ? this.applyFontStyles({}, fontData) : color ? { color } : undefined;
875
+ const content = data ? data : iconToRender
876
+ ? <span
877
+ key={node.id + 'icon' + index}
878
+ className={this.getIconClass(iconToRender, iconToRender === 'circle' ? [TreeDecoration.Styles.DECORATOR_SIZE_CLASS] : [])}
879
+ ></span>
880
+ : '';
881
+ return <div key={node.id + className + index} className={className} style={style} title={tooltip}>
882
+ {content}{index !== decorationsToRender.length - 1 ? ',' : ''}
883
+ </div>;
884
+ })}
885
+ </React.Fragment>;
886
+ }
887
+
888
+ /**
889
+ * Determine the classes to use for an icon
890
+ * - Assumes a Font Awesome name when passed a single string, otherwise uses the passed string array
891
+ * @param iconName the icon name or list of icon names.
892
+ * @param additionalClasses additional CSS classes.
893
+ *
894
+ * @returns the icon class name.
895
+ */
896
+ protected getIconClass(iconName: string | string[], additionalClasses: string[] = []): string {
897
+ const iconClass = (typeof iconName === 'string') ? ['a', 'fa', `fa-${iconName}`] : ['a'].concat(iconName);
898
+ return iconClass.concat(additionalClasses).join(' ');
899
+ }
900
+
901
+ /**
902
+ * Render indent for the file tree based on the depth
903
+ * @param node the tree node.
904
+ * @param depth the depth of the tree node.
905
+ */
906
+ protected renderIndent(node: TreeNode, props: NodeProps): React.ReactNode {
907
+ const renderIndentGuides = this.corePreferences['workbench.tree.renderIndentGuides'];
908
+ if (renderIndentGuides === 'none') {
909
+ return undefined;
910
+ }
911
+
912
+ const indentDivs: React.ReactNode[] = [];
913
+ let current: TreeNode | undefined = node;
914
+ let depth = props.depth;
915
+ while (current && depth) {
916
+ if (this.shouldRenderIndent(current)) {
917
+ const classNames: string[] = [TREE_NODE_INDENT_GUIDE_CLASS];
918
+ if (this.needsActiveIndentGuideline(current)) {
919
+ classNames.push('active');
920
+ } else {
921
+ classNames.push(renderIndentGuides === 'onHover' ? 'hover' : 'always');
922
+ }
923
+ const paddingLeft = this.getDepthPadding(depth);
924
+ indentDivs.unshift(<div key={depth} className={classNames.join(' ')} style={{
925
+ paddingLeft: `${paddingLeft}px`
926
+ }} />);
927
+ depth--;
928
+ }
929
+ current = current.parent;
930
+ }
931
+ return indentDivs;
932
+ }
933
+
934
+ /**
935
+ * Determines whether an indentation div should be rendered for the specified tree node.
936
+ * If there are multiple tree nodes inside of a single rendered row,
937
+ * this method should only return true for the first node.
938
+ */
939
+ protected shouldRenderIndent(node: TreeNode): boolean {
940
+ return true;
941
+ }
942
+
943
+ protected needsActiveIndentGuideline(node: TreeNode): boolean {
944
+ const parent = node.parent;
945
+ if (!parent || !this.isExpandable(parent)) {
946
+ return false;
947
+ }
948
+ if (SelectableTreeNode.isSelected(parent)) {
949
+ return true;
950
+ }
951
+ if (parent.expanded) {
952
+ for (const sibling of parent.children) {
953
+ if (SelectableTreeNode.isSelected(sibling) && !(this.isExpandable(sibling) && sibling.expanded)) {
954
+ return true;
955
+ }
956
+ }
957
+ }
958
+ return false;
959
+ }
960
+
961
+ /**
962
+ * Render the node given the tree node and node properties.
963
+ * @param node the tree node.
964
+ * @param props the node properties.
965
+ */
966
+ protected renderNode(node: TreeNode, props: NodeProps): React.ReactNode {
967
+ if (!TreeNode.isVisible(node)) {
968
+ return undefined;
969
+ }
970
+ const attributes = this.createNodeAttributes(node, props);
971
+ const content = <div className={TREE_NODE_CONTENT_CLASS}>
972
+ {this.renderExpansionToggle(node, props)}
973
+ {this.renderCheckbox(node, props)}
974
+ {this.decorateIcon(node, this.renderIcon(node, props))}
975
+ {this.renderCaptionAffixes(node, props, 'captionPrefixes')}
976
+ {this.renderCaption(node, props)}
977
+ {this.renderCaptionAffixes(node, props, 'captionSuffixes')}
978
+ {this.renderTailDecorations(node, props)}
979
+ </div>;
980
+ return React.createElement('div', attributes, content);
981
+ }
982
+
983
+ /**
984
+ * Create node attributes for the tree node given the node properties.
985
+ * @param node the tree node.
986
+ * @param props the node properties.
987
+ */
988
+ protected createNodeAttributes(node: TreeNode, props: NodeProps): React.Attributes & React.HTMLAttributes<HTMLElement> {
989
+ const className = this.createNodeClassNames(node, props).join(' ');
990
+ const style = this.createNodeStyle(node, props);
991
+ return {
992
+ className,
993
+ style,
994
+ onClick: event => this.handleClickEvent(node, event),
995
+ onDoubleClick: event => this.handleDblClickEvent(node, event),
996
+ onAuxClick: event => this.handleAuxClickEvent(node, event),
997
+ onContextMenu: event => this.handleContextMenuEvent(node, event),
998
+ };
999
+ }
1000
+
1001
+ /**
1002
+ * Create the node class names.
1003
+ * @param node the tree node.
1004
+ * @param props the node properties.
1005
+ *
1006
+ * @returns the list of tree node class names.
1007
+ */
1008
+ protected createNodeClassNames(node: TreeNode, props: NodeProps): string[] {
1009
+ const classNames = [TREE_NODE_CLASS];
1010
+ if (CompositeTreeNode.is(node)) {
1011
+ classNames.push(COMPOSITE_TREE_NODE_CLASS);
1012
+ }
1013
+ if (this.isExpandable(node)) {
1014
+ classNames.push(EXPANDABLE_TREE_NODE_CLASS);
1015
+ }
1016
+ if (this.rowIsSelected(node, props)) {
1017
+ classNames.push(SELECTED_CLASS);
1018
+ }
1019
+ if (this.focusService.hasFocus(node)) {
1020
+ classNames.push(FOCUS_CLASS);
1021
+ }
1022
+ return classNames;
1023
+ }
1024
+
1025
+ protected rowIsSelected(node: TreeNode, props: NodeProps): boolean {
1026
+ return SelectableTreeNode.isSelected(node);
1027
+ }
1028
+
1029
+ /**
1030
+ * Get the default node style.
1031
+ * @param node the tree node.
1032
+ * @param props the node properties.
1033
+ *
1034
+ * @returns the CSS properties if available.
1035
+ */
1036
+ protected getDefaultNodeStyle(node: TreeNode, props: NodeProps): React.CSSProperties | undefined {
1037
+ const paddingLeft = this.getPaddingLeft(node, props) + 'px';
1038
+ return { paddingLeft };
1039
+ }
1040
+
1041
+ protected getPaddingLeft(node: TreeNode, props: NodeProps): number {
1042
+ return this.getDepthPadding(props.depth) + (this.needsExpansionTogglePadding(node) ? this.props.expansionTogglePadding : 0);
1043
+ }
1044
+
1045
+ /**
1046
+ * If the node is a composite, a toggle will be rendered.
1047
+ * Otherwise we need to add the width and the left, right padding => 18px
1048
+ */
1049
+ protected needsExpansionTogglePadding(node: TreeNode): boolean {
1050
+ return !this.isExpandable(node);
1051
+ }
1052
+
1053
+ /**
1054
+ * Create the tree node style.
1055
+ * @param node the tree node.
1056
+ * @param props the node properties.
1057
+ */
1058
+ protected createNodeStyle(node: TreeNode, props: NodeProps): React.CSSProperties | undefined {
1059
+ return this.decorateNodeStyle(node, this.getDefaultNodeStyle(node, props));
1060
+ }
1061
+
1062
+ /**
1063
+ * Decorate the node style.
1064
+ * @param node the tree node.
1065
+ * @param style the optional CSS properties.
1066
+ *
1067
+ * @returns the CSS styles if available.
1068
+ */
1069
+ protected decorateNodeStyle(node: TreeNode, style: React.CSSProperties | undefined): React.CSSProperties | undefined {
1070
+ const backgroundColor = this.getDecorationData(node, 'backgroundColor').filter(notEmpty).shift();
1071
+ if (backgroundColor) {
1072
+ style = {
1073
+ ...(style || {}),
1074
+ backgroundColor
1075
+ };
1076
+ }
1077
+ return style;
1078
+ }
1079
+
1080
+ /**
1081
+ * Determine if the tree node is expandable.
1082
+ * @param node the tree node.
1083
+ *
1084
+ * @returns `true` if the tree node is expandable.
1085
+ */
1086
+ protected isExpandable(node: TreeNode): node is ExpandableTreeNode {
1087
+ return ExpandableTreeNode.is(node);
1088
+ }
1089
+
1090
+ /**
1091
+ * Get the tree node decorations.
1092
+ * @param node the tree node.
1093
+ *
1094
+ * @returns the list of tree decoration data.
1095
+ */
1096
+ protected getDecorations(node: TreeNode): TreeDecoration.Data[] {
1097
+ const decorations: TreeDecoration.Data[] = [];
1098
+ if (DecoratedTreeNode.is(node)) {
1099
+ decorations.push(node.decorationData);
1100
+ }
1101
+ if (this.decorations.has(node.id)) {
1102
+ decorations.push(...this.decorations.get(node.id)!);
1103
+ }
1104
+ return decorations.sort(TreeDecoration.Data.comparePriority);
1105
+ }
1106
+
1107
+ /**
1108
+ * Get the tree decoration data for the given key.
1109
+ * @param node the tree node.
1110
+ * @param key the tree decoration data key.
1111
+ *
1112
+ * @returns the tree decoration data at the given key.
1113
+ */
1114
+ protected getDecorationData<K extends keyof TreeDecoration.Data>(node: TreeNode, key: K): Required<Pick<TreeDecoration.Data, K>>[K][] {
1115
+ return this.getDecorations(node).filter(data => data[key] !== undefined).map(data => data[key]);
1116
+ }
1117
+
1118
+ /**
1119
+ * Store the last scroll state.
1120
+ */
1121
+ protected lastScrollState: {
1122
+ /**
1123
+ * The scroll top value.
1124
+ */
1125
+ scrollTop: number,
1126
+ /**
1127
+ * The scroll left value.
1128
+ */
1129
+ scrollLeft: number
1130
+ } | undefined;
1131
+
1132
+ /**
1133
+ * Get the scroll container.
1134
+ */
1135
+ protected override getScrollContainer(): MaybePromise<HTMLElement> {
1136
+ this.toDisposeOnDetach.push(Disposable.create(() => {
1137
+ const { scrollTop, scrollLeft } = this.node;
1138
+ this.lastScrollState = { scrollTop, scrollLeft };
1139
+ }));
1140
+ if (this.lastScrollState) {
1141
+ const { scrollTop, scrollLeft } = this.lastScrollState;
1142
+ this.node.scrollTop = scrollTop;
1143
+ this.node.scrollLeft = scrollLeft;
1144
+ }
1145
+ return this.node;
1146
+ }
1147
+
1148
+ protected override onAfterAttach(msg: Message): void {
1149
+ const up = [
1150
+ Key.ARROW_UP,
1151
+ KeyCode.createKeyCode({ first: Key.ARROW_UP, modifiers: [KeyModifier.Shift] })
1152
+ ];
1153
+ const down = [
1154
+ Key.ARROW_DOWN,
1155
+ KeyCode.createKeyCode({ first: Key.ARROW_DOWN, modifiers: [KeyModifier.Shift] })
1156
+ ];
1157
+ if (this.props.search) {
1158
+ if (this.searchBox.isAttached) {
1159
+ Widget.detach(this.searchBox);
1160
+ }
1161
+ UnsafeWidgetUtilities.attach(this.searchBox, this.node.parentElement!);
1162
+ this.addKeyListener(this.node, this.searchBox.keyCodePredicate.bind(this.searchBox), this.searchBox.handle.bind(this.searchBox));
1163
+ this.toDisposeOnDetach.push(Disposable.create(() => {
1164
+ Widget.detach(this.searchBox);
1165
+ }));
1166
+ }
1167
+ super.onAfterAttach(msg);
1168
+ this.addKeyListener(this.node, Key.ARROW_LEFT, event => this.handleLeft(event));
1169
+ this.addKeyListener(this.node, Key.ARROW_RIGHT, event => this.handleRight(event));
1170
+ this.addKeyListener(this.node, up, event => this.handleUp(event));
1171
+ this.addKeyListener(this.node, down, event => this.handleDown(event));
1172
+ this.addKeyListener(this.node, Key.ENTER, event => this.handleEnter(event));
1173
+ this.addKeyListener(this.node, Key.SPACE, event => this.handleSpace(event));
1174
+ this.addKeyListener(this.node, Key.ESCAPE, event => this.handleEscape(event));
1175
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
1176
+ this.addEventListener<any>(this.node, 'ps-scroll-y', (e: Event & { target: { scrollTop: number } }) => {
1177
+ if (this.view && this.view.list) {
1178
+ const { scrollTop } = e.target;
1179
+ this.view.list.scrollTo({
1180
+ top: scrollTop
1181
+ });
1182
+ }
1183
+ });
1184
+ }
1185
+
1186
+ /**
1187
+ * Handle the `left arrow` keyboard event.
1188
+ * @param event the `left arrow` keyboard event.
1189
+ */
1190
+ protected async handleLeft(event: KeyboardEvent): Promise<void> {
1191
+ if (!!this.props.multiSelect && (this.hasCtrlCmdMask(event) || this.hasShiftMask(event))) {
1192
+ return;
1193
+ }
1194
+ if (!await this.model.collapseNode()) {
1195
+ this.model.selectParent();
1196
+ }
1197
+ }
1198
+
1199
+ /**
1200
+ * Handle the `right arrow` keyboard event.
1201
+ * @param event the `right arrow` keyboard event.
1202
+ */
1203
+ protected async handleRight(event: KeyboardEvent): Promise<void> {
1204
+ if (!!this.props.multiSelect && (this.hasCtrlCmdMask(event) || this.hasShiftMask(event))) {
1205
+ return;
1206
+ }
1207
+ if (!await this.model.expandNode()) {
1208
+ this.model.selectNextNode();
1209
+ }
1210
+ }
1211
+
1212
+ /**
1213
+ * Handle the `up arrow` keyboard event.
1214
+ * @param event the `up arrow` keyboard event.
1215
+ */
1216
+ protected handleUp(event: KeyboardEvent): void {
1217
+ if (!!this.props.multiSelect && this.hasShiftMask(event)) {
1218
+ this.model.selectPrevNode(TreeSelection.SelectionType.RANGE);
1219
+ } else {
1220
+ this.model.selectPrevNode();
1221
+ }
1222
+ this.node.focus();
1223
+ }
1224
+
1225
+ /**
1226
+ * Handle the `down arrow` keyboard event.
1227
+ * @param event the `down arrow` keyboard event.
1228
+ */
1229
+ protected handleDown(event: KeyboardEvent): void {
1230
+ if (!!this.props.multiSelect && this.hasShiftMask(event)) {
1231
+ this.model.selectNextNode(TreeSelection.SelectionType.RANGE);
1232
+ } else {
1233
+ this.model.selectNextNode();
1234
+ }
1235
+ this.node.focus();
1236
+ }
1237
+
1238
+ /**
1239
+ * Handle the `enter key` keyboard event.
1240
+ * - `enter` opens the tree node.
1241
+ * @param event the `enter key` keyboard event.
1242
+ */
1243
+ protected handleEnter(event: KeyboardEvent): void {
1244
+ this.model.openNode();
1245
+ }
1246
+
1247
+ /**
1248
+ * Handle the `space key` keyboard event.
1249
+ * - If the element has a checkbox, it will be toggled.
1250
+ * - Otherwise, it should be similar to a single-click action.
1251
+ * @param event the `space key` keyboard event.
1252
+ */
1253
+ protected handleSpace(event: KeyboardEvent): void {
1254
+ const { focusedNode } = this.focusService;
1255
+ if (focusedNode && focusedNode.checkboxInfo) {
1256
+ this.model.markAsChecked(focusedNode, !focusedNode.checkboxInfo.checked);
1257
+ } else if (!this.props.multiSelect || (!event.ctrlKey && !event.metaKey && !event.shiftKey)) {
1258
+ this.tapNode(focusedNode);
1259
+ }
1260
+ }
1261
+
1262
+ protected handleEscape(event: KeyboardEvent): void {
1263
+ if (this.model.selectedNodes.length <= 1) {
1264
+ this.focusService.setFocus(undefined);
1265
+ this.node.focus();
1266
+ }
1267
+ this.model.clearSelection();
1268
+ }
1269
+
1270
+ /**
1271
+ * Handle the single-click mouse event.
1272
+ * @param node the tree node if available.
1273
+ * @param event the mouse single-click event.
1274
+ */
1275
+ protected handleClickEvent(node: TreeNode | undefined, event: React.MouseEvent<HTMLElement>): void {
1276
+ if (node) {
1277
+ event.stopPropagation();
1278
+ const shiftMask = this.hasShiftMask(event);
1279
+ const ctrlCmdMask = this.hasCtrlCmdMask(event);
1280
+ if (this.props.multiSelect && (shiftMask || ctrlCmdMask) && SelectableTreeNode.is(node)) {
1281
+ if (shiftMask) {
1282
+ this.model.selectRange(node);
1283
+ } else if (ctrlCmdMask) {
1284
+ this.model.toggleNode(node);
1285
+ }
1286
+ } else {
1287
+ this.tapNode(node);
1288
+ }
1289
+ }
1290
+ }
1291
+
1292
+ /**
1293
+ * The effective handler of an unmodified single-click event.
1294
+ */
1295
+ protected tapNode(node?: TreeNode): void {
1296
+ if (SelectableTreeNode.is(node)) {
1297
+ this.model.selectNode(node);
1298
+ }
1299
+ if (node && !this.props.expandOnlyOnExpansionToggleClick && this.isExpandable(node)) {
1300
+ this.model.toggleNodeExpansion(node);
1301
+ }
1302
+ }
1303
+
1304
+ /**
1305
+ * Handle the double-click mouse event.
1306
+ * @param node the tree node if available.
1307
+ * @param event the double-click mouse event.
1308
+ */
1309
+ protected handleDblClickEvent(node: TreeNode | undefined, event: React.MouseEvent<HTMLElement>): void {
1310
+ this.model.openNode(node);
1311
+ event.stopPropagation();
1312
+ }
1313
+
1314
+ /**
1315
+ * Handle the middle-click mouse event.
1316
+ * @param node the tree node if available.
1317
+ * @param event the middle-click mouse event.
1318
+ */
1319
+ protected handleAuxClickEvent(node: TreeNode | undefined, event: React.MouseEvent<HTMLElement>): void {
1320
+ if (event.button === 1) {
1321
+ this.model.openNode(node);
1322
+ if (SelectableTreeNode.is(node)) {
1323
+ this.model.selectNode(node);
1324
+ }
1325
+ }
1326
+ event.stopPropagation();
1327
+ }
1328
+
1329
+ /**
1330
+ * Handle the middle-click mouse event.
1331
+ * @param event the middle-click mouse event.
1332
+ */
1333
+ protected handleMiddleClickEvent(event: MouseEvent): void {
1334
+ // Prevents auto-scrolling behavior when middle-clicking.
1335
+ if (event.button === 1) {
1336
+ event.preventDefault();
1337
+ }
1338
+ }
1339
+
1340
+ /**
1341
+ * Handle the context menu click event.
1342
+ * - The context menu click event is triggered by the right-click.
1343
+ * @param node the tree node if available.
1344
+ * @param event the right-click mouse event.
1345
+ */
1346
+ protected handleContextMenuEvent(node: TreeNode | undefined, event: React.MouseEvent<HTMLElement>): void {
1347
+ if (SelectableTreeNode.is(node)) {
1348
+ // Keep the selection for the context menu, if the widget support multi-selection and the right click happens on an already selected node.
1349
+ if (!this.props.multiSelect || !node.selected) {
1350
+ const type = !!this.props.multiSelect && this.hasCtrlCmdMask(event) ? TreeSelection.SelectionType.TOGGLE : TreeSelection.SelectionType.DEFAULT;
1351
+ this.model.addSelection({ node, type });
1352
+ }
1353
+ this.focusService.setFocus(node);
1354
+ const contextMenuPath = this.props.contextMenuPath;
1355
+ if (contextMenuPath) {
1356
+ const { x, y } = event.nativeEvent;
1357
+ const args = this.toContextMenuArgs(node);
1358
+ setTimeout(() => this.contextMenuRenderer.render({
1359
+ menuPath: contextMenuPath,
1360
+ anchor: { x, y },
1361
+ args
1362
+ }), 10);
1363
+ }
1364
+ }
1365
+ event.stopPropagation();
1366
+ event.preventDefault();
1367
+ }
1368
+
1369
+ /**
1370
+ * Handle the double-click mouse event on the expansion toggle.
1371
+ */
1372
+ protected readonly handleExpansionToggleDblClickEvent = (event: React.MouseEvent<HTMLElement>) => this.doHandleExpansionToggleDblClickEvent(event);
1373
+ /**
1374
+ * Actually handle the double-click mouse event on the expansion toggle.
1375
+ * @param event the double-click mouse event.
1376
+ */
1377
+ protected doHandleExpansionToggleDblClickEvent(event: React.MouseEvent<HTMLElement>): void {
1378
+ if (this.props.expandOnlyOnExpansionToggleClick) {
1379
+ // Ignore the double-click event.
1380
+ event.stopPropagation();
1381
+ }
1382
+ }
1383
+
1384
+ /**
1385
+ * Convert the tree node to context menu arguments.
1386
+ * @param node the selectable tree node.
1387
+ */
1388
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
1389
+ protected toContextMenuArgs(node: SelectableTreeNode): any[] | undefined {
1390
+ return undefined;
1391
+ }
1392
+
1393
+ /**
1394
+ * Determine if the tree modifier aware event has a `ctrlcmd` mask.
1395
+ * @param event the tree modifier aware event.
1396
+ *
1397
+ * @returns `true` if the tree modifier aware event contains the `ctrlcmd` mask.
1398
+ */
1399
+ protected hasCtrlCmdMask(event: TreeWidget.ModifierAwareEvent): boolean {
1400
+ return isOSX ? event.metaKey : event.ctrlKey;
1401
+ }
1402
+
1403
+ /**
1404
+ * Determine if the tree modifier aware event has a `shift` mask.
1405
+ * @param event the tree modifier aware event.
1406
+ *
1407
+ * @returns `true` if the tree modifier aware event contains the `shift` mask.
1408
+ */
1409
+ protected hasShiftMask(event: TreeWidget.ModifierAwareEvent): boolean {
1410
+ // Ctrl/Cmd mask overrules the Shift mask.
1411
+ if (this.hasCtrlCmdMask(event)) {
1412
+ return false;
1413
+ }
1414
+ return event.shiftKey;
1415
+ }
1416
+
1417
+ /**
1418
+ * Deflate the tree node for storage.
1419
+ * @param node the tree node.
1420
+ */
1421
+ protected deflateForStorage(node: TreeNode): object {
1422
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
1423
+ const copy = Object.assign({}, node) as any;
1424
+ if (copy.parent) {
1425
+ delete copy.parent;
1426
+ }
1427
+ if ('previousSibling' in copy) {
1428
+ delete copy.previousSibling;
1429
+ }
1430
+ if ('nextSibling' in copy) {
1431
+ delete copy.nextSibling;
1432
+ }
1433
+ if ('busy' in copy) {
1434
+ delete copy.busy;
1435
+ }
1436
+ if (CompositeTreeNode.is(node)) {
1437
+ copy.children = [];
1438
+ for (const child of node.children) {
1439
+ copy.children.push(this.deflateForStorage(child));
1440
+ }
1441
+ }
1442
+ return copy;
1443
+ }
1444
+
1445
+ /**
1446
+ * Inflate the tree node from storage.
1447
+ * @param node the tree node.
1448
+ * @param parent the optional tree node.
1449
+ */
1450
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
1451
+ protected inflateFromStorage(node: any, parent?: TreeNode): TreeNode {
1452
+ if (node.selected) {
1453
+ node.selected = false;
1454
+ }
1455
+ if (parent) {
1456
+ node.parent = parent;
1457
+ }
1458
+ if (Array.isArray(node.children)) {
1459
+ for (const child of node.children as TreeNode[]) {
1460
+ this.inflateFromStorage(child, node);
1461
+ }
1462
+ }
1463
+ return node;
1464
+ }
1465
+
1466
+ /**
1467
+ * Store the tree state.
1468
+ */
1469
+ storeState(): object {
1470
+ const decorations = this.decoratorService.deflateDecorators(this.decorations);
1471
+ let state: object = {
1472
+ decorations
1473
+ };
1474
+ if (this.model.root) {
1475
+ state = {
1476
+ ...state,
1477
+ root: this.deflateForStorage(this.model.root),
1478
+ model: this.model.storeState(),
1479
+ focusedNodeId: this.focusService.focusedNode?.id
1480
+ };
1481
+ }
1482
+
1483
+ return state;
1484
+ }
1485
+
1486
+ /**
1487
+ * Restore the state.
1488
+ * @param oldState the old state object.
1489
+ */
1490
+ restoreState(oldState: object): void {
1491
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
1492
+ const { root, decorations, model, focusedNodeId } = (oldState as any);
1493
+ if (root) {
1494
+ this.model.root = this.inflateFromStorage(root);
1495
+ }
1496
+ if (decorations) {
1497
+ this.decorations = this.decoratorService.inflateDecorators(decorations);
1498
+ }
1499
+ if (model) {
1500
+ this.model.restoreState(model);
1501
+ }
1502
+ if (focusedNodeId) {
1503
+ const candidate = this.model.getNode(focusedNodeId);
1504
+ if (SelectableTreeNode.is(candidate)) {
1505
+ this.focusService.setFocus(candidate);
1506
+ }
1507
+ }
1508
+ }
1509
+
1510
+ protected toNodeIcon(node: TreeNode): string {
1511
+ return this.labelProvider.getIcon(node);
1512
+ }
1513
+
1514
+ protected toNodeName(node: TreeNode): string {
1515
+ return this.labelProvider.getName(node);
1516
+ }
1517
+
1518
+ protected toNodeDescription(node: TreeNode): string {
1519
+ return this.labelProvider.getLongName(node);
1520
+ }
1521
+ protected getDepthPadding(depth: number): number {
1522
+ if (depth === 1) {
1523
+ return this.props.leftPadding;
1524
+ }
1525
+ return depth * this.treeIndent;
1526
+ }
1527
+ }
1528
+ export namespace TreeWidget {
1529
+ /**
1530
+ * Representation of a tree node row.
1531
+ */
1532
+ export interface NodeRow {
1533
+ /**
1534
+ * The node row index.
1535
+ */
1536
+ index: number
1537
+ /**
1538
+ * The actual node.
1539
+ */
1540
+ node: TreeNode
1541
+ /**
1542
+ * A root relative number representing the hierarchical depth of the actual node. Root is `0`, its children have `1` and so on.
1543
+ */
1544
+ depth: number
1545
+ }
1546
+ /**
1547
+ * Representation of the tree view properties.
1548
+ */
1549
+ export interface ViewProps {
1550
+ /**
1551
+ * The width property.
1552
+ */
1553
+ width: number
1554
+ /**
1555
+ * The height property.
1556
+ */
1557
+ height: number
1558
+ /**
1559
+ * The scroll to row value.
1560
+ */
1561
+ scrollToRow?: number
1562
+ /**
1563
+ * The list of node rows.
1564
+ */
1565
+ rows: NodeRow[]
1566
+ renderNodeRow: (row: NodeRow) => React.ReactNode
1567
+ }
1568
+ export class View extends React.Component<ViewProps> {
1569
+ list: VirtuosoHandle | undefined;
1570
+ override render(): React.ReactNode {
1571
+ const { rows, width, height, scrollToRow } = this.props;
1572
+ return <Virtuoso
1573
+ ref={list => {
1574
+ this.list = (list || undefined);
1575
+ if (this.list && scrollToRow !== undefined) {
1576
+ this.list.scrollIntoView({
1577
+ index: scrollToRow,
1578
+ align: 'center'
1579
+ });
1580
+ }
1581
+ }}
1582
+ totalCount={rows.length}
1583
+ itemContent={index => this.props.renderNodeRow(rows[index])}
1584
+ width={width}
1585
+ height={height}
1586
+ // This is a pixel value, it will scan 200px to the top and bottom of the current view
1587
+ overscan={500}
1588
+ />;
1589
+ }
1590
+ }
1591
+ }