cx 26.1.3 → 26.1.4

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 (569) hide show
  1. package/.mocharc.json +5 -5
  2. package/LICENSE-THIRD-PARTY.md +91 -91
  3. package/LICENSE.md +7 -7
  4. package/README.md +46 -46
  5. package/build/ui/Widget.d.ts +1 -1
  6. package/build/ui/exprHelpers.d.ts +8 -0
  7. package/build/ui/exprHelpers.js +11 -0
  8. package/build/widgets/overlay/Overlay.d.ts +3 -3
  9. package/build.js +133 -133
  10. package/dist/manifest.js +893 -893
  11. package/dist/ui.js +18 -4
  12. package/dist/util.js +0 -4
  13. package/dist/widgets.js +320 -395
  14. package/package.json +100 -100
  15. package/src/charts/Bar.scss +28 -28
  16. package/src/charts/Bar.ts +114 -114
  17. package/src/charts/BarGraph.scss +28 -28
  18. package/src/charts/BarGraph.tsx +145 -145
  19. package/src/charts/BubbleGraph.scss +31 -31
  20. package/src/charts/BubbleGraph.tsx +165 -165
  21. package/src/charts/Chart.ts +108 -108
  22. package/src/charts/ColorMap.ts +150 -150
  23. package/src/charts/Column.scss +28 -28
  24. package/src/charts/Column.ts +124 -124
  25. package/src/charts/ColumnBarBase.tsx +284 -284
  26. package/src/charts/ColumnBarGraphBase.tsx +229 -229
  27. package/src/charts/ColumnGraph.scss +29 -29
  28. package/src/charts/ColumnGraph.tsx +153 -153
  29. package/src/charts/Grid.ts +5 -5
  30. package/src/charts/Gridlines.scss +24 -24
  31. package/src/charts/Gridlines.tsx +88 -88
  32. package/src/charts/Legend.scss +50 -50
  33. package/src/charts/Legend.tsx +270 -270
  34. package/src/charts/LegendEntry.scss +29 -29
  35. package/src/charts/LegendEntry.tsx +197 -197
  36. package/src/charts/LineGraph.scss +24 -24
  37. package/src/charts/LineGraph.tsx +455 -455
  38. package/src/charts/Marker.scss +43 -43
  39. package/src/charts/Marker.tsx +483 -483
  40. package/src/charts/MarkerLine.scss +19 -19
  41. package/src/charts/MarkerLine.tsx +214 -214
  42. package/src/charts/MouseTracker.tsx +112 -112
  43. package/src/charts/Pie.ts +8 -8
  44. package/src/charts/PieChart.scss +28 -28
  45. package/src/charts/PieChart.tsx +717 -717
  46. package/src/charts/PieLabel.tsx +106 -106
  47. package/src/charts/PieLabelsContainer.ts +68 -68
  48. package/src/charts/Range.scss +19 -19
  49. package/src/charts/Range.tsx +318 -318
  50. package/src/charts/RangeMarker.scss +17 -17
  51. package/src/charts/RangeMarker.tsx +233 -233
  52. package/src/charts/ScatterGraph.scss +23 -23
  53. package/src/charts/ScatterGraph.tsx +245 -245
  54. package/src/charts/Swimlane.scss +16 -16
  55. package/src/charts/Swimlane.tsx +195 -195
  56. package/src/charts/Swimlanes.scss +16 -16
  57. package/src/charts/Swimlanes.tsx +179 -179
  58. package/src/charts/axis/Axis.scss +22 -22
  59. package/src/charts/axis/Axis.tsx +444 -444
  60. package/src/charts/axis/CategoryAxis.scss +34 -34
  61. package/src/charts/axis/CategoryAxis.tsx +313 -313
  62. package/src/charts/axis/NumericAxis.scss +34 -34
  63. package/src/charts/axis/NumericAxis.tsx +437 -437
  64. package/src/charts/axis/Stack.ts +61 -61
  65. package/src/charts/axis/TimeAxis.scss +33 -33
  66. package/src/charts/axis/TimeAxis.tsx +718 -718
  67. package/src/charts/axis/index.scss +5 -5
  68. package/src/charts/axis/index.ts +3 -3
  69. package/src/charts/axis/variables.scss +2 -2
  70. package/src/charts/helpers/MinMaxFinder.ts +66 -66
  71. package/src/charts/helpers/PointReducer.ts +135 -135
  72. package/src/charts/helpers/SnapPointFinder.ts +136 -136
  73. package/src/charts/helpers/ValueAtFinder.ts +72 -72
  74. package/src/charts/helpers/index.ts +4 -4
  75. package/src/charts/index.scss +22 -22
  76. package/src/charts/index.ts +34 -34
  77. package/src/charts/palette.scss +97 -97
  78. package/src/charts/shapes.tsx +86 -86
  79. package/src/charts/variables.scss +22 -22
  80. package/src/core.d.ts +182 -182
  81. package/src/data/AggregateFunction.ts +171 -171
  82. package/src/data/ArrayElementView.spec.ts +88 -88
  83. package/src/data/ArrayElementView.ts +91 -91
  84. package/src/data/ArrayRef.ts +34 -34
  85. package/src/data/AugmentedViewBase.ts +88 -88
  86. package/src/data/Binding.spec.ts +69 -69
  87. package/src/data/Binding.ts +104 -104
  88. package/src/data/ExposedRecordView.ts +95 -95
  89. package/src/data/ExposedValueView.ts +89 -89
  90. package/src/data/Expression.spec.ts +229 -229
  91. package/src/data/Expression.ts +233 -233
  92. package/src/data/Grouper.spec.ts +57 -57
  93. package/src/data/Grouper.ts +158 -158
  94. package/src/data/NestedDataView.ts +43 -43
  95. package/src/data/ReadOnlyDataView.ts +39 -39
  96. package/src/data/Ref.spec.ts +79 -79
  97. package/src/data/Ref.ts +104 -104
  98. package/src/data/Selector.ts +10 -10
  99. package/src/data/Store.spec.ts +22 -22
  100. package/src/data/Store.ts +52 -52
  101. package/src/data/StoreProxy.ts +19 -19
  102. package/src/data/StoreRef.spec.ts +24 -24
  103. package/src/data/StoreRef.ts +66 -66
  104. package/src/data/StringTemplate.spec.ts +132 -132
  105. package/src/data/StringTemplate.ts +93 -93
  106. package/src/data/StructuredSelector.spec.ts +113 -113
  107. package/src/data/StructuredSelector.ts +146 -146
  108. package/src/data/SubscribableView.ts +63 -63
  109. package/src/data/View.spec.ts +60 -60
  110. package/src/data/View.ts +289 -289
  111. package/src/data/ZoomIntoPropertyView.spec.ts +64 -64
  112. package/src/data/ZoomIntoPropertyView.ts +45 -45
  113. package/src/data/comparer.spec.ts +60 -60
  114. package/src/data/comparer.ts +78 -78
  115. package/src/data/computable.spec.ts +87 -87
  116. package/src/data/computable.ts +69 -69
  117. package/src/data/createAccessorModelProxy.spec.tsx +145 -145
  118. package/src/data/createAccessorModelProxy.ts +66 -66
  119. package/src/data/createStructuredSelector.spec.ts +45 -45
  120. package/src/data/createStructuredSelector.ts +62 -62
  121. package/src/data/defaultCompare.ts +14 -14
  122. package/src/data/diff/diffArrays.ts +49 -49
  123. package/src/data/diff/diffs.spec.ts +49 -49
  124. package/src/data/diff/index.ts +1 -1
  125. package/src/data/enableFatArrowExpansion.ts +6 -6
  126. package/src/data/getAccessor.spec.ts +11 -11
  127. package/src/data/getAccessor.ts +74 -74
  128. package/src/data/getSelector.spec.ts +43 -43
  129. package/src/data/getSelector.ts +66 -66
  130. package/src/data/index.ts +30 -30
  131. package/src/data/isSelector.ts +26 -26
  132. package/src/data/ops/append.spec.ts +28 -28
  133. package/src/data/ops/append.ts +5 -5
  134. package/src/data/ops/filter.spec.ts +35 -35
  135. package/src/data/ops/filter.ts +9 -9
  136. package/src/data/ops/findTreeNode.spec.ts +23 -23
  137. package/src/data/ops/findTreeNode.ts +14 -14
  138. package/src/data/ops/findTreePath.ts +23 -23
  139. package/src/data/ops/index.ts +11 -11
  140. package/src/data/ops/insertElement.ts +3 -3
  141. package/src/data/ops/merge.spec.ts +27 -27
  142. package/src/data/ops/merge.ts +13 -13
  143. package/src/data/ops/moveElement.ts +21 -21
  144. package/src/data/ops/removeTreeNodes.spec.ts +37 -37
  145. package/src/data/ops/removeTreeNodes.ts +15 -15
  146. package/src/data/ops/updateArray.spec.ts +69 -69
  147. package/src/data/ops/updateArray.ts +31 -31
  148. package/src/data/ops/updateTree.spec.ts +54 -54
  149. package/src/data/ops/updateTree.ts +23 -23
  150. package/src/data/test-types.ts +7 -7
  151. package/src/global.scss +13 -13
  152. package/src/hooks/createLocalStorageRef.ts +21 -21
  153. package/src/hooks/index.ts +8 -8
  154. package/src/hooks/invokeCallback.spec.tsx +59 -59
  155. package/src/hooks/invokeCallback.ts +8 -8
  156. package/src/hooks/resolveCallback.spec.tsx +71 -71
  157. package/src/hooks/resolveCallback.ts +16 -16
  158. package/src/hooks/store.spec.tsx +67 -67
  159. package/src/hooks/store.ts +46 -46
  160. package/src/hooks/useEffect.ts +14 -14
  161. package/src/hooks/useInterval.ts +8 -8
  162. package/src/hooks/useState.ts +20 -20
  163. package/src/hooks/useTrigger.spec.tsx +105 -105
  164. package/src/hooks/useTrigger.ts +26 -26
  165. package/src/index.scss +6 -6
  166. package/src/index.ts +7 -7
  167. package/src/jsx-dev-runtime.ts +4 -4
  168. package/src/jsx-runtime.spec.tsx +431 -431
  169. package/src/jsx-runtime.ts +79 -79
  170. package/src/locale/de-de.ts +76 -76
  171. package/src/locale/en-us.ts +75 -75
  172. package/src/locale/es-es.ts +76 -76
  173. package/src/locale/fr-fr.ts +76 -76
  174. package/src/locale/nl-nl.ts +76 -76
  175. package/src/locale/pt-pt.ts +76 -76
  176. package/src/locale/sr-latn-ba.ts +76 -76
  177. package/src/svg/BoundedObject.ts +101 -101
  178. package/src/svg/ClipRect.tsx +29 -29
  179. package/src/svg/Ellipse.tsx +68 -68
  180. package/src/svg/Line.tsx +58 -58
  181. package/src/svg/NonOverlappingRect.ts +26 -26
  182. package/src/svg/NonOverlappingRectGroup.ts +49 -49
  183. package/src/svg/Rectangle.tsx +90 -90
  184. package/src/svg/Svg.scss +27 -27
  185. package/src/svg/Svg.tsx +241 -241
  186. package/src/svg/Text.tsx +134 -134
  187. package/src/svg/TextualBoundedObject.ts +35 -35
  188. package/src/svg/index.scss +8 -8
  189. package/src/svg/index.ts +17 -17
  190. package/src/svg/util/Rect.ts +105 -105
  191. package/src/ui/CSS.ts +87 -87
  192. package/src/ui/CSSHelper.ts +17 -17
  193. package/src/ui/Container.tsx +216 -216
  194. package/src/ui/ContentResolver.spec.tsx +585 -585
  195. package/src/ui/ContentResolver.ts +132 -132
  196. package/src/ui/Controller.spec.tsx +574 -574
  197. package/src/ui/Controller.ts +202 -202
  198. package/src/ui/Culture.ts +159 -159
  199. package/src/ui/Cx.spec.tsx +210 -210
  200. package/src/ui/Cx.tsx +386 -386
  201. package/src/ui/DataProxy.spec.tsx +337 -337
  202. package/src/ui/DataProxy.ts +55 -55
  203. package/src/ui/DetachedScope.tsx +159 -159
  204. package/src/ui/FocusManager.ts +171 -171
  205. package/src/ui/Format.ts +108 -108
  206. package/src/ui/HoverSync.tsx +189 -189
  207. package/src/ui/Instance.ts +866 -866
  208. package/src/ui/IsolatedScope.spec.tsx +62 -62
  209. package/src/ui/IsolatedScope.ts +50 -50
  210. package/src/ui/Localization.ts +70 -70
  211. package/src/ui/Prop.ts +140 -140
  212. package/src/ui/PureContainer.spec.tsx +232 -232
  213. package/src/ui/PureContainer.tsx +19 -19
  214. package/src/ui/RenderingContext.ts +99 -99
  215. package/src/ui/Repeater.spec.tsx +143 -143
  216. package/src/ui/Repeater.ts +194 -194
  217. package/src/ui/Rescope.spec.tsx +199 -199
  218. package/src/ui/Rescope.ts +49 -49
  219. package/src/ui/ResizeManager.ts +30 -30
  220. package/src/ui/Restate.spec.tsx +422 -422
  221. package/src/ui/Restate.tsx +217 -217
  222. package/src/ui/StaticText.ts +11 -11
  223. package/src/ui/StructuredInstanceDataAccessor.ts +32 -32
  224. package/src/ui/Text.ts +49 -49
  225. package/src/ui/VDOM.ts +1 -1
  226. package/src/ui/Widget.spec.tsx +53 -53
  227. package/src/ui/Widget.tsx +301 -301
  228. package/src/ui/ZIndexManager.ts +11 -11
  229. package/src/ui/adapter/ArrayAdapter.spec.ts +55 -55
  230. package/src/ui/adapter/ArrayAdapter.ts +229 -229
  231. package/src/ui/adapter/DataAdapter.ts +52 -52
  232. package/src/ui/adapter/GroupAdapter.ts +235 -235
  233. package/src/ui/adapter/TreeAdapter.spec.ts +76 -76
  234. package/src/ui/adapter/TreeAdapter.ts +185 -185
  235. package/src/ui/adapter/index.ts +4 -4
  236. package/src/ui/app/History.ts +133 -133
  237. package/src/ui/app/Url.spec.ts +50 -50
  238. package/src/ui/app/Url.ts +102 -102
  239. package/src/ui/app/index.ts +5 -5
  240. package/src/ui/app/startAppLoop.tsx +71 -71
  241. package/src/ui/app/startHotAppLoop.ts +41 -41
  242. package/src/ui/batchUpdates.ts +77 -77
  243. package/src/ui/bind.ts +10 -10
  244. package/src/ui/createFunctionalComponent.spec.tsx +454 -454
  245. package/src/ui/createFunctionalComponent.ts +86 -86
  246. package/src/ui/expr.ts +47 -47
  247. package/src/ui/exprHelpers.spec.ts +412 -379
  248. package/src/ui/exprHelpers.ts +95 -78
  249. package/src/ui/flattenProps.ts +21 -21
  250. package/src/ui/index.scss +2 -2
  251. package/src/ui/index.ts +47 -47
  252. package/src/ui/keyboardShortcuts.ts +40 -40
  253. package/src/ui/layout/Content.ts +30 -30
  254. package/src/ui/layout/ContentPlaceholder.spec.tsx +599 -599
  255. package/src/ui/layout/ContentPlaceholder.ts +133 -133
  256. package/src/ui/layout/FirstVisibleChildLayout.spec.tsx +207 -207
  257. package/src/ui/layout/FirstVisibleChildLayout.ts +60 -60
  258. package/src/ui/layout/LabelsLeftLayout.scss +46 -46
  259. package/src/ui/layout/LabelsLeftLayout.tsx +76 -76
  260. package/src/ui/layout/LabelsTopLayout.scss +64 -64
  261. package/src/ui/layout/LabelsTopLayout.tsx +156 -156
  262. package/src/ui/layout/UseParentLayout.ts +8 -8
  263. package/src/ui/layout/exploreChildren.ts +38 -38
  264. package/src/ui/layout/index.scss +3 -3
  265. package/src/ui/layout/index.ts +10 -10
  266. package/src/ui/layout/variables.scss +2 -2
  267. package/src/ui/selection/KeySelection.ts +153 -153
  268. package/src/ui/selection/PropertySelection.ts +87 -87
  269. package/src/ui/selection/Selection.ts +128 -128
  270. package/src/ui/selection/index.ts +3 -3
  271. package/src/ui/tpl.ts +4 -4
  272. package/src/ui/variables.scss +1 -1
  273. package/src/util/Component.spec.ts +411 -411
  274. package/src/util/Component.ts +301 -301
  275. package/src/util/Console.ts +13 -13
  276. package/src/util/DOM.ts +88 -88
  277. package/src/util/Debug.ts +71 -71
  278. package/src/util/Format.spec.ts +69 -69
  279. package/src/util/Format.ts +267 -267
  280. package/src/util/GlobalCacheIdentifier.ts +11 -11
  281. package/src/util/KeyCode.ts +21 -21
  282. package/src/util/SubscriberList.ts +86 -86
  283. package/src/util/Timing.ts +58 -58
  284. package/src/util/TraversalStack.spec.ts +53 -53
  285. package/src/util/TraversalStack.ts +47 -47
  286. package/src/util/addEventListenerWithOptions.ts +41 -41
  287. package/src/util/browserSupportsPassiveEventHandlers.ts +20 -20
  288. package/src/util/calculateNaturalElementHeight.ts +22 -22
  289. package/src/util/call-once.scss +6 -6
  290. package/src/util/capitalize.ts +4 -4
  291. package/src/util/coalesce.ts +6 -6
  292. package/src/util/color/hslToRgb.ts +34 -34
  293. package/src/util/color/index.ts +4 -4
  294. package/src/util/color/parseColor.ts +173 -173
  295. package/src/util/color/rgbToHex.ts +14 -14
  296. package/src/util/color/rgbToHsl.ts +35 -35
  297. package/src/util/date/dateDiff.ts +9 -9
  298. package/src/util/date/diff.ts +13 -13
  299. package/src/util/date/encodeDate.ts +8 -8
  300. package/src/util/date/encodeDateWithTimezoneOffset.ts +18 -18
  301. package/src/util/date/index.ts +11 -11
  302. package/src/util/date/lowerBoundCheck.ts +13 -13
  303. package/src/util/date/maxDate.ts +14 -14
  304. package/src/util/date/minDate.ts +14 -14
  305. package/src/util/date/monthStart.ts +8 -8
  306. package/src/util/date/parseDateInvariant.ts +20 -20
  307. package/src/util/date/sameDate.ts +11 -11
  308. package/src/util/date/upperBoundCheck.spec.ts +30 -30
  309. package/src/util/date/upperBoundCheck.ts +13 -13
  310. package/src/util/date/zeroTime.ts +9 -9
  311. package/src/util/debounce.ts +26 -26
  312. package/src/util/dummyCallback.ts +1 -1
  313. package/src/util/escapeSpecialRegexCharacters.ts +8 -8
  314. package/src/util/eventCallbacks.ts +12 -12
  315. package/src/util/expandFatArrows.ts +118 -118
  316. package/src/util/findScrollableParent.ts +15 -15
  317. package/src/util/getActiveElement.ts +4 -4
  318. package/src/util/getParentFrameBoundingClientRect.ts +13 -13
  319. package/src/util/getScrollerBoundingClientRect.ts +12 -12
  320. package/src/util/getSearchQueryPredicate.spec.ts +40 -40
  321. package/src/util/getSearchQueryPredicate.ts +58 -58
  322. package/src/util/getTopLevelBoundingClientRect.ts +7 -7
  323. package/src/util/getVendorPrefix.ts +33 -33
  324. package/src/util/hasKey.ts +18 -18
  325. package/src/util/index.scss +10 -10
  326. package/src/util/index.ts +55 -55
  327. package/src/util/innerTextTrim.ts +10 -10
  328. package/src/util/isArray.ts +3 -3
  329. package/src/util/isDataRecord.ts +5 -5
  330. package/src/util/isDefined.ts +3 -3
  331. package/src/util/isDigit.ts +8 -8
  332. package/src/util/isFunction.ts +3 -3
  333. package/src/util/isNonEmptyArray.ts +3 -3
  334. package/src/util/isNumber.ts +3 -3
  335. package/src/util/isObject.ts +3 -3
  336. package/src/util/isPromise.ts +6 -6
  337. package/src/util/isString.ts +3 -3
  338. package/src/util/isTextInputElement.ts +2 -2
  339. package/src/util/isTouchDevice.ts +7 -7
  340. package/src/util/isTouchEvent.ts +64 -64
  341. package/src/util/isUndefined.ts +3 -3
  342. package/src/util/isValidIdentifierName.spec.ts +33 -33
  343. package/src/util/isValidIdentifierName.ts +5 -5
  344. package/src/util/onIdleCallback.ts +10 -10
  345. package/src/util/parseStyle.ts +29 -29
  346. package/src/util/quote.ts +6 -6
  347. package/src/util/reverseSlice.ts +9 -9
  348. package/src/util/routeAppend.spec.ts +19 -19
  349. package/src/util/routeAppend.ts +15 -15
  350. package/src/util/scrollElementIntoView.ts +40 -40
  351. package/src/util/scss/add-rules.scss +40 -40
  352. package/src/util/scss/calc.scss +44 -44
  353. package/src/util/scss/call-once.scss +12 -12
  354. package/src/util/scss/clockwise.scss +49 -49
  355. package/src/util/scss/colors.scss +9 -9
  356. package/src/util/scss/deep-get.scss +11 -11
  357. package/src/util/scss/deep-merge.scss +21 -21
  358. package/src/util/scss/divide.scss +3 -3
  359. package/src/util/scss/include.scss +48 -48
  360. package/src/util/scss/index.scss +9 -9
  361. package/src/util/shallowEquals.ts +43 -43
  362. package/src/util/test/createTestRenderer.tsx +19 -19
  363. package/src/util/throttle.ts +21 -21
  364. package/src/util/validatedDebounce.ts +23 -23
  365. package/src/variables.scss +217 -217
  366. package/src/widgets/AccessorBindings.spec.tsx +90 -90
  367. package/src/widgets/Button.scss +119 -119
  368. package/src/widgets/Button.tsx +189 -189
  369. package/src/widgets/Button.variables.scss +117 -117
  370. package/src/widgets/CxCredit.scss +39 -39
  371. package/src/widgets/CxCredit.tsx +46 -46
  372. package/src/widgets/DocumentTitle.ts +95 -95
  373. package/src/widgets/FlexBox.scss +148 -148
  374. package/src/widgets/FlexBox.tsx +168 -168
  375. package/src/widgets/Heading.scss +40 -40
  376. package/src/widgets/Heading.ts +42 -42
  377. package/src/widgets/HighlightedSearchText.scss +20 -20
  378. package/src/widgets/HighlightedSearchText.tsx +54 -54
  379. package/src/widgets/HtmlElement.spec.helpers.tsx +108 -108
  380. package/src/widgets/HtmlElement.spec.tsx +89 -89
  381. package/src/widgets/HtmlElement.tsx +407 -407
  382. package/src/widgets/Icon.scss +22 -22
  383. package/src/widgets/Icon.ts +64 -64
  384. package/src/widgets/List.scss +93 -93
  385. package/src/widgets/List.tsx +793 -793
  386. package/src/widgets/ProgressBar.scss +50 -50
  387. package/src/widgets/ProgressBar.tsx +66 -66
  388. package/src/widgets/ReactElementWrapper.spec.tsx +452 -452
  389. package/src/widgets/ReactElementWrapper.tsx +108 -108
  390. package/src/widgets/Resizer.scss +43 -43
  391. package/src/widgets/Resizer.tsx +200 -200
  392. package/src/widgets/Sandbox.ts +103 -103
  393. package/src/widgets/Section.scss +55 -55
  394. package/src/widgets/Section.tsx +187 -187
  395. package/src/widgets/animations.scss +10 -10
  396. package/src/widgets/autoFocus.ts +9 -9
  397. package/src/widgets/cx.ts +63 -63
  398. package/src/widgets/drag-drop/DragClone.scss +35 -35
  399. package/src/widgets/drag-drop/DragHandle.scss +18 -18
  400. package/src/widgets/drag-drop/DragHandle.tsx +47 -47
  401. package/src/widgets/drag-drop/DragSource.scss +26 -26
  402. package/src/widgets/drag-drop/DragSource.tsx +237 -237
  403. package/src/widgets/drag-drop/DropZone.scss +76 -76
  404. package/src/widgets/drag-drop/DropZone.tsx +353 -353
  405. package/src/widgets/drag-drop/index.scss +3 -3
  406. package/src/widgets/drag-drop/index.ts +4 -4
  407. package/src/widgets/drag-drop/ops.tsx +422 -422
  408. package/src/widgets/drag-drop/variables.scss +14 -14
  409. package/src/widgets/enableAllInternalDependencies.ts +11 -11
  410. package/src/widgets/form/Calendar.scss +199 -199
  411. package/src/widgets/form/Calendar.tsx +760 -760
  412. package/src/widgets/form/Calendar.variables.scss +63 -63
  413. package/src/widgets/form/Checkbox.scss +129 -129
  414. package/src/widgets/form/Checkbox.tsx +287 -287
  415. package/src/widgets/form/Checkbox.variables.scss +39 -39
  416. package/src/widgets/form/ColorField.scss +98 -98
  417. package/src/widgets/form/ColorField.tsx +497 -497
  418. package/src/widgets/form/ColorPicker.scss +285 -285
  419. package/src/widgets/form/ColorPicker.tsx +544 -544
  420. package/src/widgets/form/ColorPicker.variables.scss +22 -22
  421. package/src/widgets/form/DateField.ts +21 -21
  422. package/src/widgets/form/DateTimeField.scss +92 -92
  423. package/src/widgets/form/DateTimeField.tsx +726 -726
  424. package/src/widgets/form/DateTimePicker.scss +46 -46
  425. package/src/widgets/form/DateTimePicker.tsx +429 -429
  426. package/src/widgets/form/Field.scss +164 -164
  427. package/src/widgets/form/Field.tsx +608 -608
  428. package/src/widgets/form/FieldGroup.ts +10 -10
  429. package/src/widgets/form/FieldIcon.ts +61 -61
  430. package/src/widgets/form/HelpText.scss +24 -24
  431. package/src/widgets/form/HelpText.ts +15 -15
  432. package/src/widgets/form/Label.scss +37 -37
  433. package/src/widgets/form/Label.tsx +117 -117
  434. package/src/widgets/form/LabeledContainer.ts +77 -77
  435. package/src/widgets/form/LookupField.scss +221 -221
  436. package/src/widgets/form/LookupField.spec.tsx +93 -93
  437. package/src/widgets/form/LookupField.tsx +1421 -1421
  438. package/src/widgets/form/MonthField.scss +100 -100
  439. package/src/widgets/form/MonthField.tsx +670 -670
  440. package/src/widgets/form/MonthPicker.scss +125 -125
  441. package/src/widgets/form/MonthPicker.tsx +822 -822
  442. package/src/widgets/form/NumberField.scss +63 -63
  443. package/src/widgets/form/NumberField.tsx +543 -543
  444. package/src/widgets/form/Radio.scss +123 -123
  445. package/src/widgets/form/Radio.tsx +249 -249
  446. package/src/widgets/form/Radio.variables.scss +45 -45
  447. package/src/widgets/form/Select.scss +101 -101
  448. package/src/widgets/form/Select.tsx +327 -327
  449. package/src/widgets/form/Slider.scss +121 -121
  450. package/src/widgets/form/Slider.tsx +473 -473
  451. package/src/widgets/form/Switch.scss +142 -142
  452. package/src/widgets/form/Switch.tsx +176 -176
  453. package/src/widgets/form/TextArea.scss +45 -45
  454. package/src/widgets/form/TextArea.tsx +229 -229
  455. package/src/widgets/form/TextField.scss +57 -57
  456. package/src/widgets/form/TextField.tsx +407 -407
  457. package/src/widgets/form/TimeField.ts +10 -10
  458. package/src/widgets/form/TimeList.tsx +105 -105
  459. package/src/widgets/form/UploadButton.scss +49 -49
  460. package/src/widgets/form/UploadButton.tsx +307 -307
  461. package/src/widgets/form/ValidationError.scss +22 -22
  462. package/src/widgets/form/ValidationError.tsx +72 -72
  463. package/src/widgets/form/ValidationGroup.spec.tsx +147 -147
  464. package/src/widgets/form/ValidationGroup.ts +141 -141
  465. package/src/widgets/form/Validator.ts +60 -60
  466. package/src/widgets/form/Wheel.scss +152 -152
  467. package/src/widgets/form/Wheel.tsx +314 -314
  468. package/src/widgets/form/index.scss +24 -24
  469. package/src/widgets/form/index.ts +28 -28
  470. package/src/widgets/form/variables.scss +355 -355
  471. package/src/widgets/grid/Grid.scss +640 -640
  472. package/src/widgets/grid/Grid.tsx +4243 -4243
  473. package/src/widgets/grid/GridCell.ts +143 -143
  474. package/src/widgets/grid/GridCellEditor.tsx +58 -58
  475. package/src/widgets/grid/GridRow.ts +302 -302
  476. package/src/widgets/grid/GridRowLine.ts +49 -49
  477. package/src/widgets/grid/Pagination.scss +115 -115
  478. package/src/widgets/grid/Pagination.tsx +126 -126
  479. package/src/widgets/grid/TreeNode.scss +90 -90
  480. package/src/widgets/grid/TreeNode.tsx +154 -154
  481. package/src/widgets/grid/createGridCellEditor.tsx +18 -18
  482. package/src/widgets/grid/index.scss +3 -3
  483. package/src/widgets/grid/index.ts +16 -16
  484. package/src/widgets/grid/variables.scss +137 -137
  485. package/src/widgets/icons/arrow-down.svg +3 -3
  486. package/src/widgets/icons/arrow-right.svg +2 -2
  487. package/src/widgets/icons/base.svg +104 -104
  488. package/src/widgets/icons/calendar-old.svg +169 -169
  489. package/src/widgets/icons/calendar.svg +187 -187
  490. package/src/widgets/icons/calendar.tsx +22 -22
  491. package/src/widgets/icons/check.tsx +14 -14
  492. package/src/widgets/icons/clear.svg +74 -74
  493. package/src/widgets/icons/clear.tsx +16 -16
  494. package/src/widgets/icons/close.svg +74 -74
  495. package/src/widgets/icons/close.tsx +20 -20
  496. package/src/widgets/icons/cx.tsx +39 -39
  497. package/src/widgets/icons/drop-down.tsx +16 -16
  498. package/src/widgets/icons/dropdown-arrow.svg +61 -61
  499. package/src/widgets/icons/file.svg +4 -4
  500. package/src/widgets/icons/file.tsx +14 -14
  501. package/src/widgets/icons/folder-open.svg +5 -5
  502. package/src/widgets/icons/folder-open.tsx +16 -16
  503. package/src/widgets/icons/folder.svg +58 -58
  504. package/src/widgets/icons/folder.tsx +14 -14
  505. package/src/widgets/icons/forward.svg +67 -67
  506. package/src/widgets/icons/forward.tsx +23 -23
  507. package/src/widgets/icons/index.ts +14 -14
  508. package/src/widgets/icons/loading.svg +4 -4
  509. package/src/widgets/icons/loading.tsx +25 -25
  510. package/src/widgets/icons/menu.tsx +18 -18
  511. package/src/widgets/icons/pixel-picker.tsx +18 -18
  512. package/src/widgets/icons/registry.ts +56 -56
  513. package/src/widgets/icons/search.svg +107 -107
  514. package/src/widgets/icons/search.tsx +14 -14
  515. package/src/widgets/icons/sort-asc.svg +3 -3
  516. package/src/widgets/icons/sort-asc.tsx +15 -15
  517. package/src/widgets/icons/square.tsx +19 -19
  518. package/src/widgets/index.d.ts +55 -55
  519. package/src/widgets/index.scss +16 -16
  520. package/src/widgets/index.ts +58 -58
  521. package/src/widgets/nav/Link.scss +20 -20
  522. package/src/widgets/nav/Link.ts +11 -11
  523. package/src/widgets/nav/LinkButton.ts +176 -176
  524. package/src/widgets/nav/Menu.scss +76 -76
  525. package/src/widgets/nav/Menu.tsx +489 -489
  526. package/src/widgets/nav/Menu.variables.scss +25 -25
  527. package/src/widgets/nav/MenuItem.scss +130 -130
  528. package/src/widgets/nav/MenuItem.tsx +525 -525
  529. package/src/widgets/nav/MenuSpacer.ts +18 -18
  530. package/src/widgets/nav/RedirectRoute.ts +49 -49
  531. package/src/widgets/nav/Route.spec.tsx +24 -24
  532. package/src/widgets/nav/Route.ts +142 -142
  533. package/src/widgets/nav/Scroller.scss +148 -148
  534. package/src/widgets/nav/Scroller.tsx +252 -252
  535. package/src/widgets/nav/Submenu.ts +6 -6
  536. package/src/widgets/nav/Tab.scss +82 -82
  537. package/src/widgets/nav/Tab.ts +120 -120
  538. package/src/widgets/nav/Tab.variables.scss +84 -84
  539. package/src/widgets/nav/cover.scss +22 -22
  540. package/src/widgets/nav/index.scss +5 -5
  541. package/src/widgets/nav/index.ts +10 -10
  542. package/src/widgets/nav/variables.scss +27 -27
  543. package/src/widgets/overlay/ContextMenu.ts +42 -42
  544. package/src/widgets/overlay/Dropdown.scss +186 -186
  545. package/src/widgets/overlay/Dropdown.tsx +762 -762
  546. package/src/widgets/overlay/FlyweightTooltipTracker.ts +57 -57
  547. package/src/widgets/overlay/MsgBox.tsx +141 -141
  548. package/src/widgets/overlay/Overlay.scss +68 -68
  549. package/src/widgets/overlay/Overlay.tsx +947 -947
  550. package/src/widgets/overlay/Toast.scss +163 -163
  551. package/src/widgets/overlay/Toast.ts +111 -111
  552. package/src/widgets/overlay/Tooltip.scss +177 -177
  553. package/src/widgets/overlay/Tooltip.tsx +393 -393
  554. package/src/widgets/overlay/Window.scss +129 -129
  555. package/src/widgets/overlay/Window.tsx +299 -299
  556. package/src/widgets/overlay/Window.variables.scss +62 -62
  557. package/src/widgets/overlay/alerts.ts +46 -46
  558. package/src/widgets/overlay/captureMouse.scss +13 -13
  559. package/src/widgets/overlay/captureMouse.ts +195 -195
  560. package/src/widgets/overlay/createHotPromiseWindowFactory.ts +71 -71
  561. package/src/widgets/overlay/index.d.ts +11 -11
  562. package/src/widgets/overlay/index.scss +15 -15
  563. package/src/widgets/overlay/index.ts +11 -11
  564. package/src/widgets/overlay/tooltip-ops.ts +173 -173
  565. package/src/widgets/overlay/variables.scss +85 -85
  566. package/src/widgets/variables.scss +146 -146
  567. package/tsconfig.compile.json +4 -4
  568. package/tsconfig.json +34 -34
  569. package/tsconfig.mocha.json +14 -14
@@ -1,793 +1,793 @@
1
- /**@jsxImportSource react */
2
- import { Instance } from "../ui/Instance";
3
- import type { RenderingContext } from "../ui/RenderingContext";
4
- import { getAccessor } from "../data/getAccessor";
5
- import { GroupAdapter, GroupingConfig } from "../ui/adapter/GroupAdapter";
6
- import { batchUpdates } from "../ui/batchUpdates";
7
- import { Container, StyledContainerBase, StyledContainerConfig } from "../ui/Container";
8
- import { FocusManager, offFocusOut, oneFocusOut, preventFocusOnTouch } from "../ui/FocusManager";
9
- import { Selection } from "../ui/selection/Selection";
10
- import { VDOM, Widget, getContent } from "../ui/Widget";
11
- import { addEventListenerWithOptions } from "../util/addEventListenerWithOptions";
12
- import { isArray } from "../util/isArray";
13
- import { isString } from "../util/isString";
14
- import { KeyCode } from "../util/KeyCode";
15
- import { scrollElementIntoView } from "../util/scrollElementIntoView";
16
- import {
17
- BooleanProp,
18
- ClassProp,
19
- CollatorOptions,
20
- Prop,
21
- RecordAlias,
22
- StringProp,
23
- StructuredProp,
24
- StyleProp,
25
- } from "../ui/Prop";
26
- import { Create } from "../util/Component";
27
-
28
- export interface ListConfig<T = any> extends StyledContainerConfig {
29
- /** An array of records to be displayed in the list. */
30
- records?: Prop<T[]>;
31
-
32
- /** Record alias. Default is `$record`. */
33
- recordName?: RecordAlias;
34
-
35
- /** Record alias. Alias for `recordName`. Default is `$record`. */
36
- recordAlias?: RecordAlias;
37
-
38
- /** Index alias. Default is `$index`. */
39
- indexName?: RecordAlias;
40
-
41
- /** Index alias. Alias for `indexName`. Default is `$index`. */
42
- indexAlias?: RecordAlias;
43
-
44
- /** Style to be applied to each list item. */
45
- itemStyle?: StyleProp;
46
-
47
- /** CSS class to be applied to each list item. */
48
- itemClass?: ClassProp;
49
-
50
- /** CSS class to be applied to each list item. */
51
- itemClassName?: ClassProp;
52
-
53
- /** Text to be displayed when the list is empty. */
54
- emptyText?: StringProp;
55
-
56
- /** A grouping definition, field name, or an array of grouping level definitions. */
57
- grouping?: string | GroupingConfig | (string | GroupingConfig)[];
58
-
59
- /** Base CSS class to be applied to the element. Default is 'list'. */
60
- baseClass?: string;
61
-
62
- /** Set to `true` to allow focus on the list. */
63
- focusable?: BooleanProp;
64
-
65
- /** Boolean for focus state. */
66
- focused?: BooleanProp;
67
-
68
- /** Boolean for item padding. */
69
- itemPad?: BooleanProp;
70
-
71
- /** Set to `true` to enable row caching. */
72
- cached?: BooleanProp;
73
-
74
- /** Selection configuration. */
75
- selection?: StructuredProp;
76
-
77
- /** Parameters that affect filtering. */
78
- filterParams?: StructuredProp;
79
-
80
- /** Callback to create a filter function for given filter params. */
81
- onCreateFilter?: (filterParams: any, instance?: Instance) => (record: T) => boolean;
82
-
83
- /** Scroll selection into the view. Default value is false. */
84
- scrollSelectionIntoView?: BooleanProp;
85
-
86
- /** Options for data sorting. */
87
- sortOptions?: CollatorOptions;
88
-
89
- /** Parameter for disabling specific items. */
90
- itemDisabled?: BooleanProp;
91
-
92
- /** Automatic selection without cursor navigation. */
93
- selectMode?: BooleanProp;
94
-
95
- /** Tab key selects item under cursor. */
96
- selectOnTab?: BooleanProp;
97
-
98
- /** Callback invoked during scrolling. */
99
- onScroll?: string | ((event: Event, instance: Instance) => void);
100
-
101
- /** Callback for item click. */
102
- onItemClick?: string | ((e: React.MouseEvent, instance: Instance) => void);
103
-
104
- /** Callback for item double click. */
105
- onItemDoubleClick?: string | ((e: React.MouseEvent, instance: Instance) => void);
106
-
107
- /** Callback for keyboard down events. */
108
- pipeKeyDown?: string | ((handler: ((e: React.KeyboardEvent) => void) | null, instance: Instance) => void);
109
-
110
- /** A field used to get the unique identifier of the record. */
111
- keyField?: string;
112
-
113
- /** Data adapter used to convert data in list of records. Used to enable grouping and tree operations. */
114
- dataAdapter?: Create<typeof GroupAdapter>;
115
- }
116
-
117
- /*
118
- - renders list of items
119
- - focusable (keyboard navigation)
120
- - selection
121
- - fake focus - list appears focused and receives keyboard inputs redirected from other control (dropdown scenario)
122
- */
123
-
124
- export class List extends StyledContainerBase<ListConfig> {
125
- constructor(config?: ListConfig) {
126
- super(config);
127
- }
128
-
129
- declare public recordAlias?: string;
130
- declare public recordName: string;
131
- declare public indexAlias?: string;
132
- declare public indexName: string;
133
- declare public adapter: GroupAdapter;
134
- declare public child: ListItem;
135
- declare public selection: Selection;
136
- declare public itemClass?: string;
137
- declare public itemClassName?: string;
138
- declare public itemStyle?: string;
139
- declare public itemDisabled?: boolean;
140
- declare public item?: Widget;
141
- declare public layout?: any;
142
- declare public keyField?: string;
143
- declare public records?: any[];
144
- declare public sortOptions?: any;
145
- declare public grouping?: string | GroupingConfig | (string | GroupingConfig)[];
146
- declare public focusable?: boolean;
147
- declare public focused?: boolean;
148
- declare public itemPad?: boolean;
149
- declare public cached?: boolean;
150
- declare public scrollSelectionIntoView?: boolean;
151
- declare public selectMode?: boolean;
152
- declare public selectOnTab?: boolean;
153
- declare public pipeKeyDown?:
154
- | string
155
- | ((handler: ((e: React.KeyboardEvent) => void) | null, instance: Instance) => void);
156
- declare public autoFocus?: boolean;
157
- declare public baseClass: string;
158
- declare public filter?: (item: unknown, filterParams: Record<string, unknown>) => boolean;
159
- declare public onCreateFilter?: (
160
- filterParams: Record<string, unknown>,
161
- instance: Instance,
162
- ) => (record: unknown) => boolean;
163
- declare public onItemClick?: (e: React.MouseEvent, instance: Instance) => void;
164
- declare public onItemDoubleClick?: (e: React.MouseEvent, instance: Instance) => void;
165
- declare public onKeyDown?: (e: React.KeyboardEvent, instance: Instance) => void;
166
- declare public onScroll?: (event: Event, instance: Instance) => void;
167
- declare public onFocus?: (event: FocusEvent, instance: Instance) => void;
168
- declare public onBlur?: (event: FocusEvent, instance: Instance) => void;
169
- declare public onMouseLeave?: (event: React.MouseEvent, instance: Instance) => void;
170
- declare public onMouseEnter?: (event: React.MouseEvent, instance: Instance) => void;
171
- declare public onMouseMove?: (event: React.MouseEvent, instance: Instance) => void;
172
- declare public onMouseUp?: (event: React.MouseEvent, instance: Instance) => void;
173
- declare public onMouseDown?: (event: React.MouseEvent, instance: Instance) => void;
174
- declare public onMouseOver?: (event: React.MouseEvent, instance: Instance) => void;
175
- declare public onMouseOut?: (event: React.MouseEvent, instance: Instance) => void;
176
-
177
- init() {
178
- if (this.recordAlias) this.recordName = this.recordAlias;
179
-
180
- if (this.indexAlias) this.indexName = this.indexAlias;
181
-
182
- this.adapter = GroupAdapter.create(this.adapter || GroupAdapter, {
183
- recordName: this.recordName,
184
- indexName: this.indexName,
185
- recordsAccessor: getAccessor(this.records),
186
- keyField: this.keyField,
187
- sortOptions: this.sortOptions,
188
- });
189
-
190
- this.child = ListItem.create({
191
- layout: this.layout,
192
- items: this.items,
193
- children: this.children,
194
- styled: true,
195
- class: this.itemClass,
196
- className: this.itemClassName,
197
- style: this.itemStyle,
198
- disabled: this.itemDisabled,
199
- ...this.item,
200
- }) as ListItem;
201
-
202
- delete this.children;
203
-
204
- this.selection = Selection.create(this.selection, {
205
- records: this.records,
206
- });
207
-
208
- super.init();
209
-
210
- if (this.grouping) {
211
- this.groupBy(this.grouping);
212
- }
213
- }
214
-
215
- initInstance(context: RenderingContext, instance: Instance) {
216
- this.adapter.initInstance(context, instance);
217
- }
218
-
219
- declareData() {
220
- let selection = this.selection.configureWidget(this);
221
-
222
- super.declareData(
223
- selection,
224
- {
225
- records: undefined,
226
- sorters: undefined,
227
- sortField: undefined,
228
- sortDirection: undefined,
229
- filterParams: {
230
- structured: true,
231
- },
232
- itemStyle: {
233
- structured: true,
234
- },
235
- emptyText: undefined,
236
- tabIndex: undefined,
237
- },
238
- ...arguments,
239
- );
240
- }
241
-
242
- prepareData(context: RenderingContext, instance: Instance) {
243
- let { data } = instance;
244
-
245
- if (data.sortField)
246
- data.sorters = [
247
- {
248
- field: data.sortField,
249
- direction: data.sortDirection || "ASC",
250
- },
251
- ];
252
- this.adapter.sort(data.sorters);
253
-
254
- let filter = null;
255
- if (this.onCreateFilter) filter = instance.invoke("onCreateFilter", data.filterParams, instance);
256
- else if (this.filter) filter = (item: unknown) => this.filter!(item, data.filterParams);
257
- this.adapter.setFilter(filter);
258
- instance.mappedRecords = this.adapter.getRecords(context, instance, data.records, instance.store);
259
-
260
- data.stateMods = Object.assign(data.stateMods || {}, {
261
- selectable: !this.selection.isDummy || this.onItemClick,
262
- empty: instance.mappedRecords.length == 0,
263
- });
264
-
265
- super.prepareData(context, instance);
266
- }
267
-
268
- applyParentStore(instance: Instance) {
269
- super.applyParentStore(instance);
270
-
271
- // force prepareData to execute again and propagate the store change to the records
272
- if (instance.cached) delete instance.cached.rawData;
273
- }
274
-
275
- explore(context: RenderingContext, instance: Instance): void {
276
- let instances: Instance[] = [];
277
- let isSelected = this.selection.getIsSelectedDelegate(instance.store);
278
- instance.mappedRecords!.forEach((record) => {
279
- if (record.type == "data") {
280
- let itemInstance = instance.getChild(context, this.child, record.key, record.store);
281
- itemInstance.record = record;
282
- itemInstance.selected = isSelected(record.data, record.index);
283
-
284
- let changed = false;
285
- if (itemInstance.cache("recordData", record.data)) changed = true;
286
- if (itemInstance.cache("selected", itemInstance.selected)) changed = true;
287
-
288
- if (this.cached && !changed && itemInstance.visible && !itemInstance.childStateDirty) {
289
- instances.push(itemInstance);
290
- itemInstance.shouldUpdate = false;
291
- } else if (itemInstance.scheduleExploreIfVisible(context)) instances.push(itemInstance);
292
- } else if (record.type == "group-header" && record.grouping.header) {
293
- let itemInstance = instance.getChild(context, record.grouping.header, record.key, record.store);
294
- itemInstance.record = record;
295
- if (itemInstance.scheduleExploreIfVisible(context)) instances.push(itemInstance);
296
- } else if (record.type == "group-footer" && record.grouping.footer) {
297
- let itemInstance = instance.getChild(context, record.grouping.footer, record.key, record.store);
298
- itemInstance.record = record;
299
- if (itemInstance.scheduleExploreIfVisible(context)) instances.push(itemInstance);
300
- }
301
- });
302
- instance.instances = instances;
303
- }
304
-
305
- render(context: RenderingContext, instance: Instance, key: string): React.ReactNode {
306
- let items = instance.instances!.map((x) => ({
307
- instance: x,
308
- key: x.record.key,
309
- type: x.record.type,
310
- content: getContent(x.render(context)),
311
- }));
312
- return (
313
- <ListComponent
314
- key={key}
315
- instance={instance}
316
- items={items}
317
- selectable={(!this.selection.isDummy || !!this.onItemClick) as boolean}
318
- />
319
- );
320
- }
321
-
322
- groupBy(grouping: string | GroupingConfig | (string | GroupingConfig)[]): void {
323
- if (!isArray(grouping)) {
324
- if (isString(grouping) || typeof grouping == "object") return this.groupBy([grouping]);
325
- throw new Error("DynamicGrouping should be an array of grouping objects");
326
- }
327
-
328
- let normalized = grouping.map((g) => {
329
- if (isString(g)) {
330
- return {
331
- key: {
332
- [g]: {
333
- bind: this.recordName + "." + g,
334
- },
335
- },
336
- } as GroupingConfig;
337
- }
338
- return g;
339
- });
340
-
341
- normalized.forEach((g) => {
342
- if (g.header) g.header = Widget.create(g.header);
343
-
344
- if (g.footer) g.footer = Widget.create(g.footer);
345
- });
346
-
347
- this.adapter.groupBy(normalized);
348
- this.update();
349
- }
350
- }
351
-
352
- List.prototype.recordName = "$record";
353
- List.prototype.indexName = "$index";
354
- List.prototype.baseClass = "list";
355
- List.prototype.focusable = true;
356
- List.prototype.focused = false;
357
- List.prototype.itemPad = true;
358
- List.prototype.cached = false;
359
- List.prototype.styled = true;
360
- List.prototype.scrollSelectionIntoView = false;
361
- List.prototype.selectMode = false;
362
- List.prototype.selectOnTab = false;
363
-
364
- Widget.alias("list", List);
365
-
366
- interface ListItemData {
367
- instance: Instance;
368
- key: string;
369
- type: string;
370
- content: React.ReactNode;
371
- }
372
-
373
- interface ListComponentProps {
374
- instance: Instance;
375
- items: ListItemData[];
376
- selectable: boolean | ((e: MouseEvent, instance: Instance) => void);
377
- }
378
-
379
- interface ListComponentState {
380
- cursor: number;
381
- focused: boolean;
382
- selectionStart?: number;
383
- }
384
-
385
- class ListComponent extends VDOM.Component<ListComponentProps, ListComponentState> {
386
- declare el?: HTMLUListElement;
387
- cursorChildIndex: number[] = [];
388
- declare selectedEl?: Element | null;
389
- unsubscribeScroll?: () => void;
390
- onKeyDown?: (e: React.KeyboardEvent, instance: Instance) => boolean | void;
391
-
392
- constructor(props: ListComponentProps) {
393
- super(props);
394
- let { widget } = props.instance;
395
- let { focused } = widget as unknown as { focused: boolean };
396
- this.state = {
397
- cursor: focused && props.selectable ? 0 : -1,
398
- focused: focused,
399
- };
400
-
401
- this.handleItemMouseDown = this.handleItemMouseDown.bind(this);
402
- this.handleItemDoubleClick = this.handleItemDoubleClick.bind(this);
403
- this.handleItemClick = this.handleItemClick.bind(this);
404
- }
405
-
406
- shouldComponentUpdate(props: ListComponentProps, state: ListComponentState): boolean {
407
- return props.instance.shouldUpdate || state != this.state;
408
- }
409
-
410
- componentDidMount(): void {
411
- let { instance } = this.props;
412
- let { widget } = instance as unknown as { widget: List };
413
- if (widget.pipeKeyDown) {
414
- instance.invoke("pipeKeyDown", this.handleKeyDown.bind(this), instance);
415
- this.showCursor();
416
- }
417
-
418
- if (widget.autoFocus && this.el) FocusManager.focus(this.el);
419
-
420
- if (widget.onScroll && this.el) {
421
- this.unsubscribeScroll = addEventListenerWithOptions(
422
- this.el,
423
- "scroll",
424
- (event) => {
425
- instance.invoke("onScroll", event, instance);
426
- },
427
- { passive: true },
428
- );
429
- }
430
-
431
- this.componentDidUpdate();
432
- }
433
-
434
- UNSAFE_componentWillReceiveProps(props: ListComponentProps): void {
435
- if (this.state.focused && (props.instance.widget as List).selectMode) this.showCursor(true, props.items);
436
- else if (this.state.cursor >= props.items.length) this.moveCursor(props.items.length - 1);
437
- else if (this.state.focused && this.state.cursor < 0) this.moveCursor(0);
438
- }
439
-
440
- componentWillUnmount(): void {
441
- let { instance } = this.props;
442
- let { widget } = instance as unknown as { widget: List };
443
- offFocusOut(this);
444
- if (widget.pipeKeyDown) instance.invoke("pipeKeyDown", null, instance);
445
- }
446
-
447
- handleItemMouseDown(e: React.MouseEvent<HTMLLIElement>): void {
448
- let index = Number((e.currentTarget as HTMLElement).dataset.recordIndex);
449
- this.moveCursor(index);
450
- if (e.shiftKey) e.preventDefault();
451
-
452
- this.moveCursor(index, {
453
- select: true,
454
- selectOptions: {
455
- toggle: e.ctrlKey && !e.shiftKey,
456
- add: e.ctrlKey && e.shiftKey,
457
- },
458
- selectRange: e.shiftKey,
459
- });
460
- }
461
-
462
- handleItemClick(e: React.MouseEvent<HTMLLIElement>): void {
463
- let { instance, items } = this.props;
464
- let index = Number((e.currentTarget as HTMLElement).dataset.recordIndex);
465
- let item = items[this.cursorChildIndex[index]];
466
- if (instance.invoke("onItemClick", e, item.instance) === false) return;
467
-
468
- this.moveCursor(index, {
469
- select: true,
470
- selectOptions: {
471
- toggle: e.ctrlKey && !e.shiftKey,
472
- add: e.ctrlKey && e.shiftKey,
473
- },
474
- selectRange: e.shiftKey,
475
- });
476
- }
477
-
478
- handleItemDoubleClick(e: React.MouseEvent<HTMLLIElement>): void {
479
- let { instance, items } = this.props;
480
- let index = Number((e.currentTarget as HTMLElement).dataset.recordIndex);
481
- let item = items[this.cursorChildIndex[index]];
482
- instance.invoke("onItemDoubleClick", e, item.instance);
483
- }
484
-
485
- render(): React.ReactNode {
486
- let { instance, items, selectable } = this.props;
487
- let { data, widget } = instance as unknown as { data: Record<string, any>; widget: List };
488
- let { CSS, baseClass } = widget;
489
- let itemStyle = CSS.parseStyle(data.itemStyle);
490
- this.cursorChildIndex = [];
491
- let cursorIndex = 0;
492
-
493
- let onDblClick: ((e: React.MouseEvent<HTMLLIElement>) => void) | undefined;
494
- let onClick: ((e: React.MouseEvent<HTMLLIElement>) => void) | undefined;
495
-
496
- if (widget.onItemClick) onClick = this.handleItemClick;
497
-
498
- if (widget.onItemDoubleClick) onDblClick = this.handleItemDoubleClick;
499
-
500
- let children: React.ReactNode =
501
- items.length > 0 &&
502
- items.map((x, i) => {
503
- let { data, selected } = x.instance as { data: any; selected?: boolean };
504
- let className;
505
-
506
- if (x.type == "data") {
507
- let ind = cursorIndex++;
508
-
509
- this.cursorChildIndex.push(i);
510
- className = CSS.element(baseClass, "item", {
511
- selected: selected,
512
- cursor: ind == this.state.cursor,
513
- pad: widget.itemPad,
514
- disabled: data.disabled,
515
- });
516
-
517
- return (
518
- <li
519
- key={x.key}
520
- className={CSS.expand(className, data.classNames)}
521
- style={itemStyle}
522
- data-record-index={ind}
523
- onMouseDown={this.handleItemMouseDown}
524
- onClick={onClick}
525
- onDoubleClick={onDblClick}
526
- >
527
- {x.content}
528
- </li>
529
- );
530
- } else {
531
- return (
532
- <li key={x.key} className={CSS.element(baseClass, x.type)}>
533
- {x.content}
534
- </li>
535
- );
536
- }
537
- });
538
-
539
- if (!children && data.emptyText) {
540
- children = <li className={CSS.element(baseClass, "empty-text")}>{data.emptyText}</li>;
541
- }
542
-
543
- return (
544
- <ul
545
- ref={(el) => {
546
- this.el = el as HTMLUListElement;
547
- }}
548
- className={CSS.expand(data.classNames, CSS.state({ focused: this.state.focused }))}
549
- style={data.style}
550
- tabIndex={widget.focusable && selectable && items.length > 0 ? data.tabIndex || 0 : undefined}
551
- onMouseDown={preventFocusOnTouch}
552
- onKeyDown={this.handleKeyDown.bind(this)}
553
- onMouseLeave={this.handleMouseLeave.bind(this)}
554
- onFocus={this.onFocus.bind(this)}
555
- onBlur={this.onBlur.bind(this)}
556
- >
557
- {children}
558
- </ul>
559
- );
560
- }
561
-
562
- componentDidUpdate(): void {
563
- let { widget } = this.props.instance as unknown as { widget: List };
564
- if (widget.scrollSelectionIntoView) {
565
- //The timeout is reqired for use-cases when parent needs to do some measuring that affect scrollbars, i.e. LookupField.
566
- setTimeout(() => this.scrollElementIntoView(), 0);
567
- }
568
- }
569
-
570
- scrollElementIntoView(): void {
571
- if (!this.el) return; //unmount
572
- let { widget } = this.props.instance as unknown as { widget: List };
573
- let { CSS, baseClass } = widget;
574
- let selectedRowSelector = `.${CSS.element(baseClass, "item")}.${CSS.state("selected")}`;
575
- let firstSelectedRow = this.el.querySelector(selectedRowSelector);
576
- if (firstSelectedRow != this.selectedEl) {
577
- if (firstSelectedRow) scrollElementIntoView(firstSelectedRow, true, false, 0, this.el);
578
- this.selectedEl = firstSelectedRow;
579
- }
580
- }
581
-
582
- moveCursor(
583
- index: number,
584
- {
585
- focused,
586
- hover,
587
- scrollIntoView,
588
- select,
589
- selectRange,
590
- selectOptions,
591
- }: {
592
- focused?: boolean;
593
- hover?: boolean;
594
- scrollIntoView?: boolean;
595
- select?: boolean;
596
- selectRange?: boolean;
597
- selectOptions?: { toggle?: boolean; add?: boolean };
598
- } = {},
599
- ): void {
600
- let { instance, selectable } = this.props;
601
- if (!selectable) return;
602
-
603
- let { widget } = instance as unknown as { widget: List };
604
- let newState: Partial<ListComponentState> = {};
605
- if (widget.focused) focused = true;
606
-
607
- if (focused != null && this.state.focused != focused) newState.focused = focused;
608
-
609
- //ignore mouse enter/leave events (support with a flag if a feature request comes)
610
- if (!hover) newState.cursor = index;
611
-
612
- //batch updates to avoid flickering between selection and cursor changes
613
- batchUpdates(() => {
614
- if (select || widget.selectMode) {
615
- let start: number | undefined =
616
- selectRange && this.state.selectionStart !== undefined && this.state.selectionStart >= 0
617
- ? this.state.selectionStart
618
- : index;
619
- if (start < 0) start = index;
620
- this.selectRange(start, index, selectOptions);
621
- if (!selectRange) newState.selectionStart = index;
622
- }
623
- if (Object.keys(newState).length > 0) {
624
- this.setState(newState as ListComponentState, () => {
625
- if (scrollIntoView && this.el) {
626
- let item = this.el.children[this.cursorChildIndex[index]];
627
- if (item) scrollElementIntoView(item);
628
- }
629
- });
630
- }
631
- });
632
- }
633
-
634
- selectRange(from: number, to: number, options?: { toggle?: boolean; add?: boolean }): void {
635
- let { instance, items } = this.props;
636
- let { widget } = instance as unknown as { widget: List };
637
-
638
- if (from > to) {
639
- let tmp = from;
640
- from = to;
641
- to = tmp;
642
- }
643
-
644
- let selection: any[] = [],
645
- indexes: number[] = [];
646
-
647
- for (let cursor = from; cursor <= to; cursor++) {
648
- let item = items[this.cursorChildIndex[cursor]];
649
- if (item) {
650
- let { record, data } = item.instance as { record: any; data: any };
651
- if (data.disabled) continue;
652
- selection.push(record.data);
653
- indexes.push(record.index);
654
- }
655
- }
656
-
657
- widget.selection.selectMultiple(instance.store, selection, indexes, options);
658
- }
659
-
660
- showCursor(force?: boolean, newItems?: ListItemData[]): void {
661
- if (!force && this.state.cursor >= 0) return;
662
-
663
- let items = newItems || this.props.items;
664
- let index = -1,
665
- firstSelected = -1,
666
- firstValid = -1;
667
- for (let i = 0; i < items.length; i++) {
668
- let item = items[i];
669
- if (isDataItem(item)) {
670
- index++;
671
-
672
- if (!isItemDisabled(item) && firstValid == -1) firstValid = index;
673
- if ((item.instance as any).selected) {
674
- firstSelected = index;
675
- break;
676
- }
677
- }
678
- }
679
- this.moveCursor(firstSelected != -1 ? firstSelected : firstValid, {
680
- focused: true,
681
- });
682
- }
683
-
684
- onFocus(): void {
685
- let { widget } = this.props.instance as unknown as { widget: List };
686
-
687
- FocusManager.nudge();
688
- this.showCursor(widget.selectMode);
689
-
690
- if (!widget.focused && this.el)
691
- oneFocusOut(this, this.el, () => {
692
- this.moveCursor(-1, { focused: false });
693
- });
694
-
695
- this.setState({
696
- focused: true,
697
- });
698
- }
699
-
700
- onBlur(): void {
701
- FocusManager.nudge();
702
- }
703
-
704
- handleMouseLeave(): void {
705
- let { widget } = this.props.instance as unknown as { widget: List };
706
- if (!widget.focused) this.moveCursor(-1, { hover: true });
707
- }
708
-
709
- handleKeyDown(e: React.KeyboardEvent): void {
710
- let { instance, items } = this.props;
711
- let { widget } = instance as unknown as { widget: List };
712
-
713
- if (this.onKeyDown && instance.invoke("onKeyDown", e, instance) === false) return;
714
-
715
- switch (e.keyCode) {
716
- case KeyCode.tab:
717
- case KeyCode.enter:
718
- if (!widget.selectOnTab && e.keyCode == KeyCode.tab) break;
719
- let item = items[this.cursorChildIndex[this.state.cursor]];
720
- if (item && widget.onItemClick && instance.invoke("onItemClick", e, item.instance) === false) return;
721
- this.moveCursor(this.state.cursor, {
722
- select: true,
723
- selectOptions: {
724
- toggle: e.ctrlKey && !e.shiftKey,
725
- add: e.ctrlKey && e.shiftKey,
726
- },
727
- selectRange: e.shiftKey,
728
- });
729
- break;
730
-
731
- case KeyCode.down:
732
- for (let index = this.state.cursor + 1; index < this.cursorChildIndex.length; index++) {
733
- let item = items[this.cursorChildIndex[index]];
734
- if (!isItemSelectable(item)) continue;
735
- this.moveCursor(index, {
736
- focused: true,
737
- scrollIntoView: true,
738
- select: e.shiftKey,
739
- selectRange: e.shiftKey,
740
- });
741
- e.stopPropagation();
742
- e.preventDefault();
743
- break;
744
- }
745
- break;
746
-
747
- case KeyCode.up:
748
- for (let index = this.state.cursor - 1; index >= 0; index--) {
749
- let item = items[this.cursorChildIndex[index]];
750
- if (!isItemSelectable(item)) continue;
751
- this.moveCursor(index, {
752
- focused: true,
753
- scrollIntoView: true,
754
- select: e.shiftKey,
755
- selectRange: e.shiftKey,
756
- });
757
- e.stopPropagation();
758
- e.preventDefault();
759
- break;
760
- }
761
- break;
762
-
763
- case KeyCode.a:
764
- if (!e.ctrlKey || !widget.selection.multiple) return;
765
-
766
- this.selectRange(0, this.cursorChildIndex.length);
767
-
768
- e.stopPropagation();
769
- e.preventDefault();
770
- break;
771
- }
772
- }
773
- }
774
-
775
- class ListItem extends Container {
776
- declareData(...args: Record<string, unknown>[]) {
777
- super.declareData(...args, {
778
- disabled: undefined,
779
- });
780
- }
781
- }
782
-
783
- function isItemSelectable(item: any) {
784
- return isDataItem(item) && !isItemDisabled(item);
785
- }
786
-
787
- function isDataItem(item: any) {
788
- return item?.type == "data";
789
- }
790
-
791
- function isItemDisabled(item: any) {
792
- return item?.instance.data.disabled;
793
- }
1
+ /**@jsxImportSource react */
2
+ import { Instance } from "../ui/Instance";
3
+ import type { RenderingContext } from "../ui/RenderingContext";
4
+ import { getAccessor } from "../data/getAccessor";
5
+ import { GroupAdapter, GroupingConfig } from "../ui/adapter/GroupAdapter";
6
+ import { batchUpdates } from "../ui/batchUpdates";
7
+ import { Container, StyledContainerBase, StyledContainerConfig } from "../ui/Container";
8
+ import { FocusManager, offFocusOut, oneFocusOut, preventFocusOnTouch } from "../ui/FocusManager";
9
+ import { Selection } from "../ui/selection/Selection";
10
+ import { VDOM, Widget, getContent } from "../ui/Widget";
11
+ import { addEventListenerWithOptions } from "../util/addEventListenerWithOptions";
12
+ import { isArray } from "../util/isArray";
13
+ import { isString } from "../util/isString";
14
+ import { KeyCode } from "../util/KeyCode";
15
+ import { scrollElementIntoView } from "../util/scrollElementIntoView";
16
+ import {
17
+ BooleanProp,
18
+ ClassProp,
19
+ CollatorOptions,
20
+ Prop,
21
+ RecordAlias,
22
+ StringProp,
23
+ StructuredProp,
24
+ StyleProp,
25
+ } from "../ui/Prop";
26
+ import { Create } from "../util/Component";
27
+
28
+ export interface ListConfig<T = any> extends StyledContainerConfig {
29
+ /** An array of records to be displayed in the list. */
30
+ records?: Prop<T[]>;
31
+
32
+ /** Record alias. Default is `$record`. */
33
+ recordName?: RecordAlias;
34
+
35
+ /** Record alias. Alias for `recordName`. Default is `$record`. */
36
+ recordAlias?: RecordAlias;
37
+
38
+ /** Index alias. Default is `$index`. */
39
+ indexName?: RecordAlias;
40
+
41
+ /** Index alias. Alias for `indexName`. Default is `$index`. */
42
+ indexAlias?: RecordAlias;
43
+
44
+ /** Style to be applied to each list item. */
45
+ itemStyle?: StyleProp;
46
+
47
+ /** CSS class to be applied to each list item. */
48
+ itemClass?: ClassProp;
49
+
50
+ /** CSS class to be applied to each list item. */
51
+ itemClassName?: ClassProp;
52
+
53
+ /** Text to be displayed when the list is empty. */
54
+ emptyText?: StringProp;
55
+
56
+ /** A grouping definition, field name, or an array of grouping level definitions. */
57
+ grouping?: string | GroupingConfig | (string | GroupingConfig)[];
58
+
59
+ /** Base CSS class to be applied to the element. Default is 'list'. */
60
+ baseClass?: string;
61
+
62
+ /** Set to `true` to allow focus on the list. */
63
+ focusable?: BooleanProp;
64
+
65
+ /** Boolean for focus state. */
66
+ focused?: BooleanProp;
67
+
68
+ /** Boolean for item padding. */
69
+ itemPad?: BooleanProp;
70
+
71
+ /** Set to `true` to enable row caching. */
72
+ cached?: BooleanProp;
73
+
74
+ /** Selection configuration. */
75
+ selection?: StructuredProp;
76
+
77
+ /** Parameters that affect filtering. */
78
+ filterParams?: StructuredProp;
79
+
80
+ /** Callback to create a filter function for given filter params. */
81
+ onCreateFilter?: (filterParams: any, instance?: Instance) => (record: T) => boolean;
82
+
83
+ /** Scroll selection into the view. Default value is false. */
84
+ scrollSelectionIntoView?: BooleanProp;
85
+
86
+ /** Options for data sorting. */
87
+ sortOptions?: CollatorOptions;
88
+
89
+ /** Parameter for disabling specific items. */
90
+ itemDisabled?: BooleanProp;
91
+
92
+ /** Automatic selection without cursor navigation. */
93
+ selectMode?: BooleanProp;
94
+
95
+ /** Tab key selects item under cursor. */
96
+ selectOnTab?: BooleanProp;
97
+
98
+ /** Callback invoked during scrolling. */
99
+ onScroll?: string | ((event: Event, instance: Instance) => void);
100
+
101
+ /** Callback for item click. */
102
+ onItemClick?: string | ((e: React.MouseEvent, instance: Instance) => void);
103
+
104
+ /** Callback for item double click. */
105
+ onItemDoubleClick?: string | ((e: React.MouseEvent, instance: Instance) => void);
106
+
107
+ /** Callback for keyboard down events. */
108
+ pipeKeyDown?: string | ((handler: ((e: React.KeyboardEvent) => void) | null, instance: Instance) => void);
109
+
110
+ /** A field used to get the unique identifier of the record. */
111
+ keyField?: string;
112
+
113
+ /** Data adapter used to convert data in list of records. Used to enable grouping and tree operations. */
114
+ dataAdapter?: Create<typeof GroupAdapter>;
115
+ }
116
+
117
+ /*
118
+ - renders list of items
119
+ - focusable (keyboard navigation)
120
+ - selection
121
+ - fake focus - list appears focused and receives keyboard inputs redirected from other control (dropdown scenario)
122
+ */
123
+
124
+ export class List extends StyledContainerBase<ListConfig> {
125
+ constructor(config?: ListConfig) {
126
+ super(config);
127
+ }
128
+
129
+ declare public recordAlias?: string;
130
+ declare public recordName: string;
131
+ declare public indexAlias?: string;
132
+ declare public indexName: string;
133
+ declare public adapter: GroupAdapter;
134
+ declare public child: ListItem;
135
+ declare public selection: Selection;
136
+ declare public itemClass?: string;
137
+ declare public itemClassName?: string;
138
+ declare public itemStyle?: string;
139
+ declare public itemDisabled?: boolean;
140
+ declare public item?: Widget;
141
+ declare public layout?: any;
142
+ declare public keyField?: string;
143
+ declare public records?: any[];
144
+ declare public sortOptions?: any;
145
+ declare public grouping?: string | GroupingConfig | (string | GroupingConfig)[];
146
+ declare public focusable?: boolean;
147
+ declare public focused?: boolean;
148
+ declare public itemPad?: boolean;
149
+ declare public cached?: boolean;
150
+ declare public scrollSelectionIntoView?: boolean;
151
+ declare public selectMode?: boolean;
152
+ declare public selectOnTab?: boolean;
153
+ declare public pipeKeyDown?:
154
+ | string
155
+ | ((handler: ((e: React.KeyboardEvent) => void) | null, instance: Instance) => void);
156
+ declare public autoFocus?: boolean;
157
+ declare public baseClass: string;
158
+ declare public filter?: (item: unknown, filterParams: Record<string, unknown>) => boolean;
159
+ declare public onCreateFilter?: (
160
+ filterParams: Record<string, unknown>,
161
+ instance: Instance,
162
+ ) => (record: unknown) => boolean;
163
+ declare public onItemClick?: (e: React.MouseEvent, instance: Instance) => void;
164
+ declare public onItemDoubleClick?: (e: React.MouseEvent, instance: Instance) => void;
165
+ declare public onKeyDown?: (e: React.KeyboardEvent, instance: Instance) => void;
166
+ declare public onScroll?: (event: Event, instance: Instance) => void;
167
+ declare public onFocus?: (event: FocusEvent, instance: Instance) => void;
168
+ declare public onBlur?: (event: FocusEvent, instance: Instance) => void;
169
+ declare public onMouseLeave?: (event: React.MouseEvent, instance: Instance) => void;
170
+ declare public onMouseEnter?: (event: React.MouseEvent, instance: Instance) => void;
171
+ declare public onMouseMove?: (event: React.MouseEvent, instance: Instance) => void;
172
+ declare public onMouseUp?: (event: React.MouseEvent, instance: Instance) => void;
173
+ declare public onMouseDown?: (event: React.MouseEvent, instance: Instance) => void;
174
+ declare public onMouseOver?: (event: React.MouseEvent, instance: Instance) => void;
175
+ declare public onMouseOut?: (event: React.MouseEvent, instance: Instance) => void;
176
+
177
+ init() {
178
+ if (this.recordAlias) this.recordName = this.recordAlias;
179
+
180
+ if (this.indexAlias) this.indexName = this.indexAlias;
181
+
182
+ this.adapter = GroupAdapter.create(this.adapter || GroupAdapter, {
183
+ recordName: this.recordName,
184
+ indexName: this.indexName,
185
+ recordsAccessor: getAccessor(this.records),
186
+ keyField: this.keyField,
187
+ sortOptions: this.sortOptions,
188
+ });
189
+
190
+ this.child = ListItem.create({
191
+ layout: this.layout,
192
+ items: this.items,
193
+ children: this.children,
194
+ styled: true,
195
+ class: this.itemClass,
196
+ className: this.itemClassName,
197
+ style: this.itemStyle,
198
+ disabled: this.itemDisabled,
199
+ ...this.item,
200
+ }) as ListItem;
201
+
202
+ delete this.children;
203
+
204
+ this.selection = Selection.create(this.selection, {
205
+ records: this.records,
206
+ });
207
+
208
+ super.init();
209
+
210
+ if (this.grouping) {
211
+ this.groupBy(this.grouping);
212
+ }
213
+ }
214
+
215
+ initInstance(context: RenderingContext, instance: Instance) {
216
+ this.adapter.initInstance(context, instance);
217
+ }
218
+
219
+ declareData() {
220
+ let selection = this.selection.configureWidget(this);
221
+
222
+ super.declareData(
223
+ selection,
224
+ {
225
+ records: undefined,
226
+ sorters: undefined,
227
+ sortField: undefined,
228
+ sortDirection: undefined,
229
+ filterParams: {
230
+ structured: true,
231
+ },
232
+ itemStyle: {
233
+ structured: true,
234
+ },
235
+ emptyText: undefined,
236
+ tabIndex: undefined,
237
+ },
238
+ ...arguments,
239
+ );
240
+ }
241
+
242
+ prepareData(context: RenderingContext, instance: Instance) {
243
+ let { data } = instance;
244
+
245
+ if (data.sortField)
246
+ data.sorters = [
247
+ {
248
+ field: data.sortField,
249
+ direction: data.sortDirection || "ASC",
250
+ },
251
+ ];
252
+ this.adapter.sort(data.sorters);
253
+
254
+ let filter = null;
255
+ if (this.onCreateFilter) filter = instance.invoke("onCreateFilter", data.filterParams, instance);
256
+ else if (this.filter) filter = (item: unknown) => this.filter!(item, data.filterParams);
257
+ this.adapter.setFilter(filter);
258
+ instance.mappedRecords = this.adapter.getRecords(context, instance, data.records, instance.store);
259
+
260
+ data.stateMods = Object.assign(data.stateMods || {}, {
261
+ selectable: !this.selection.isDummy || this.onItemClick,
262
+ empty: instance.mappedRecords.length == 0,
263
+ });
264
+
265
+ super.prepareData(context, instance);
266
+ }
267
+
268
+ applyParentStore(instance: Instance) {
269
+ super.applyParentStore(instance);
270
+
271
+ // force prepareData to execute again and propagate the store change to the records
272
+ if (instance.cached) delete instance.cached.rawData;
273
+ }
274
+
275
+ explore(context: RenderingContext, instance: Instance): void {
276
+ let instances: Instance[] = [];
277
+ let isSelected = this.selection.getIsSelectedDelegate(instance.store);
278
+ instance.mappedRecords!.forEach((record) => {
279
+ if (record.type == "data") {
280
+ let itemInstance = instance.getChild(context, this.child, record.key, record.store);
281
+ itemInstance.record = record;
282
+ itemInstance.selected = isSelected(record.data, record.index);
283
+
284
+ let changed = false;
285
+ if (itemInstance.cache("recordData", record.data)) changed = true;
286
+ if (itemInstance.cache("selected", itemInstance.selected)) changed = true;
287
+
288
+ if (this.cached && !changed && itemInstance.visible && !itemInstance.childStateDirty) {
289
+ instances.push(itemInstance);
290
+ itemInstance.shouldUpdate = false;
291
+ } else if (itemInstance.scheduleExploreIfVisible(context)) instances.push(itemInstance);
292
+ } else if (record.type == "group-header" && record.grouping.header) {
293
+ let itemInstance = instance.getChild(context, record.grouping.header, record.key, record.store);
294
+ itemInstance.record = record;
295
+ if (itemInstance.scheduleExploreIfVisible(context)) instances.push(itemInstance);
296
+ } else if (record.type == "group-footer" && record.grouping.footer) {
297
+ let itemInstance = instance.getChild(context, record.grouping.footer, record.key, record.store);
298
+ itemInstance.record = record;
299
+ if (itemInstance.scheduleExploreIfVisible(context)) instances.push(itemInstance);
300
+ }
301
+ });
302
+ instance.instances = instances;
303
+ }
304
+
305
+ render(context: RenderingContext, instance: Instance, key: string): React.ReactNode {
306
+ let items = instance.instances!.map((x) => ({
307
+ instance: x,
308
+ key: x.record.key,
309
+ type: x.record.type,
310
+ content: getContent(x.render(context)),
311
+ }));
312
+ return (
313
+ <ListComponent
314
+ key={key}
315
+ instance={instance}
316
+ items={items}
317
+ selectable={(!this.selection.isDummy || !!this.onItemClick) as boolean}
318
+ />
319
+ );
320
+ }
321
+
322
+ groupBy(grouping: string | GroupingConfig | (string | GroupingConfig)[]): void {
323
+ if (!isArray(grouping)) {
324
+ if (isString(grouping) || typeof grouping == "object") return this.groupBy([grouping]);
325
+ throw new Error("DynamicGrouping should be an array of grouping objects");
326
+ }
327
+
328
+ let normalized = grouping.map((g) => {
329
+ if (isString(g)) {
330
+ return {
331
+ key: {
332
+ [g]: {
333
+ bind: this.recordName + "." + g,
334
+ },
335
+ },
336
+ } as GroupingConfig;
337
+ }
338
+ return g;
339
+ });
340
+
341
+ normalized.forEach((g) => {
342
+ if (g.header) g.header = Widget.create(g.header);
343
+
344
+ if (g.footer) g.footer = Widget.create(g.footer);
345
+ });
346
+
347
+ this.adapter.groupBy(normalized);
348
+ this.update();
349
+ }
350
+ }
351
+
352
+ List.prototype.recordName = "$record";
353
+ List.prototype.indexName = "$index";
354
+ List.prototype.baseClass = "list";
355
+ List.prototype.focusable = true;
356
+ List.prototype.focused = false;
357
+ List.prototype.itemPad = true;
358
+ List.prototype.cached = false;
359
+ List.prototype.styled = true;
360
+ List.prototype.scrollSelectionIntoView = false;
361
+ List.prototype.selectMode = false;
362
+ List.prototype.selectOnTab = false;
363
+
364
+ Widget.alias("list", List);
365
+
366
+ interface ListItemData {
367
+ instance: Instance;
368
+ key: string;
369
+ type: string;
370
+ content: React.ReactNode;
371
+ }
372
+
373
+ interface ListComponentProps {
374
+ instance: Instance;
375
+ items: ListItemData[];
376
+ selectable: boolean | ((e: MouseEvent, instance: Instance) => void);
377
+ }
378
+
379
+ interface ListComponentState {
380
+ cursor: number;
381
+ focused: boolean;
382
+ selectionStart?: number;
383
+ }
384
+
385
+ class ListComponent extends VDOM.Component<ListComponentProps, ListComponentState> {
386
+ declare el?: HTMLUListElement;
387
+ cursorChildIndex: number[] = [];
388
+ declare selectedEl?: Element | null;
389
+ unsubscribeScroll?: () => void;
390
+ onKeyDown?: (e: React.KeyboardEvent, instance: Instance) => boolean | void;
391
+
392
+ constructor(props: ListComponentProps) {
393
+ super(props);
394
+ let { widget } = props.instance;
395
+ let { focused } = widget as unknown as { focused: boolean };
396
+ this.state = {
397
+ cursor: focused && props.selectable ? 0 : -1,
398
+ focused: focused,
399
+ };
400
+
401
+ this.handleItemMouseDown = this.handleItemMouseDown.bind(this);
402
+ this.handleItemDoubleClick = this.handleItemDoubleClick.bind(this);
403
+ this.handleItemClick = this.handleItemClick.bind(this);
404
+ }
405
+
406
+ shouldComponentUpdate(props: ListComponentProps, state: ListComponentState): boolean {
407
+ return props.instance.shouldUpdate || state != this.state;
408
+ }
409
+
410
+ componentDidMount(): void {
411
+ let { instance } = this.props;
412
+ let { widget } = instance as unknown as { widget: List };
413
+ if (widget.pipeKeyDown) {
414
+ instance.invoke("pipeKeyDown", this.handleKeyDown.bind(this), instance);
415
+ this.showCursor();
416
+ }
417
+
418
+ if (widget.autoFocus && this.el) FocusManager.focus(this.el);
419
+
420
+ if (widget.onScroll && this.el) {
421
+ this.unsubscribeScroll = addEventListenerWithOptions(
422
+ this.el,
423
+ "scroll",
424
+ (event) => {
425
+ instance.invoke("onScroll", event, instance);
426
+ },
427
+ { passive: true },
428
+ );
429
+ }
430
+
431
+ this.componentDidUpdate();
432
+ }
433
+
434
+ UNSAFE_componentWillReceiveProps(props: ListComponentProps): void {
435
+ if (this.state.focused && (props.instance.widget as List).selectMode) this.showCursor(true, props.items);
436
+ else if (this.state.cursor >= props.items.length) this.moveCursor(props.items.length - 1);
437
+ else if (this.state.focused && this.state.cursor < 0) this.moveCursor(0);
438
+ }
439
+
440
+ componentWillUnmount(): void {
441
+ let { instance } = this.props;
442
+ let { widget } = instance as unknown as { widget: List };
443
+ offFocusOut(this);
444
+ if (widget.pipeKeyDown) instance.invoke("pipeKeyDown", null, instance);
445
+ }
446
+
447
+ handleItemMouseDown(e: React.MouseEvent<HTMLLIElement>): void {
448
+ let index = Number((e.currentTarget as HTMLElement).dataset.recordIndex);
449
+ this.moveCursor(index);
450
+ if (e.shiftKey) e.preventDefault();
451
+
452
+ this.moveCursor(index, {
453
+ select: true,
454
+ selectOptions: {
455
+ toggle: e.ctrlKey && !e.shiftKey,
456
+ add: e.ctrlKey && e.shiftKey,
457
+ },
458
+ selectRange: e.shiftKey,
459
+ });
460
+ }
461
+
462
+ handleItemClick(e: React.MouseEvent<HTMLLIElement>): void {
463
+ let { instance, items } = this.props;
464
+ let index = Number((e.currentTarget as HTMLElement).dataset.recordIndex);
465
+ let item = items[this.cursorChildIndex[index]];
466
+ if (instance.invoke("onItemClick", e, item.instance) === false) return;
467
+
468
+ this.moveCursor(index, {
469
+ select: true,
470
+ selectOptions: {
471
+ toggle: e.ctrlKey && !e.shiftKey,
472
+ add: e.ctrlKey && e.shiftKey,
473
+ },
474
+ selectRange: e.shiftKey,
475
+ });
476
+ }
477
+
478
+ handleItemDoubleClick(e: React.MouseEvent<HTMLLIElement>): void {
479
+ let { instance, items } = this.props;
480
+ let index = Number((e.currentTarget as HTMLElement).dataset.recordIndex);
481
+ let item = items[this.cursorChildIndex[index]];
482
+ instance.invoke("onItemDoubleClick", e, item.instance);
483
+ }
484
+
485
+ render(): React.ReactNode {
486
+ let { instance, items, selectable } = this.props;
487
+ let { data, widget } = instance as unknown as { data: Record<string, any>; widget: List };
488
+ let { CSS, baseClass } = widget;
489
+ let itemStyle = CSS.parseStyle(data.itemStyle);
490
+ this.cursorChildIndex = [];
491
+ let cursorIndex = 0;
492
+
493
+ let onDblClick: ((e: React.MouseEvent<HTMLLIElement>) => void) | undefined;
494
+ let onClick: ((e: React.MouseEvent<HTMLLIElement>) => void) | undefined;
495
+
496
+ if (widget.onItemClick) onClick = this.handleItemClick;
497
+
498
+ if (widget.onItemDoubleClick) onDblClick = this.handleItemDoubleClick;
499
+
500
+ let children: React.ReactNode =
501
+ items.length > 0 &&
502
+ items.map((x, i) => {
503
+ let { data, selected } = x.instance as { data: any; selected?: boolean };
504
+ let className;
505
+
506
+ if (x.type == "data") {
507
+ let ind = cursorIndex++;
508
+
509
+ this.cursorChildIndex.push(i);
510
+ className = CSS.element(baseClass, "item", {
511
+ selected: selected,
512
+ cursor: ind == this.state.cursor,
513
+ pad: widget.itemPad,
514
+ disabled: data.disabled,
515
+ });
516
+
517
+ return (
518
+ <li
519
+ key={x.key}
520
+ className={CSS.expand(className, data.classNames)}
521
+ style={itemStyle}
522
+ data-record-index={ind}
523
+ onMouseDown={this.handleItemMouseDown}
524
+ onClick={onClick}
525
+ onDoubleClick={onDblClick}
526
+ >
527
+ {x.content}
528
+ </li>
529
+ );
530
+ } else {
531
+ return (
532
+ <li key={x.key} className={CSS.element(baseClass, x.type)}>
533
+ {x.content}
534
+ </li>
535
+ );
536
+ }
537
+ });
538
+
539
+ if (!children && data.emptyText) {
540
+ children = <li className={CSS.element(baseClass, "empty-text")}>{data.emptyText}</li>;
541
+ }
542
+
543
+ return (
544
+ <ul
545
+ ref={(el) => {
546
+ this.el = el as HTMLUListElement;
547
+ }}
548
+ className={CSS.expand(data.classNames, CSS.state({ focused: this.state.focused }))}
549
+ style={data.style}
550
+ tabIndex={widget.focusable && selectable && items.length > 0 ? data.tabIndex || 0 : undefined}
551
+ onMouseDown={preventFocusOnTouch}
552
+ onKeyDown={this.handleKeyDown.bind(this)}
553
+ onMouseLeave={this.handleMouseLeave.bind(this)}
554
+ onFocus={this.onFocus.bind(this)}
555
+ onBlur={this.onBlur.bind(this)}
556
+ >
557
+ {children}
558
+ </ul>
559
+ );
560
+ }
561
+
562
+ componentDidUpdate(): void {
563
+ let { widget } = this.props.instance as unknown as { widget: List };
564
+ if (widget.scrollSelectionIntoView) {
565
+ //The timeout is reqired for use-cases when parent needs to do some measuring that affect scrollbars, i.e. LookupField.
566
+ setTimeout(() => this.scrollElementIntoView(), 0);
567
+ }
568
+ }
569
+
570
+ scrollElementIntoView(): void {
571
+ if (!this.el) return; //unmount
572
+ let { widget } = this.props.instance as unknown as { widget: List };
573
+ let { CSS, baseClass } = widget;
574
+ let selectedRowSelector = `.${CSS.element(baseClass, "item")}.${CSS.state("selected")}`;
575
+ let firstSelectedRow = this.el.querySelector(selectedRowSelector);
576
+ if (firstSelectedRow != this.selectedEl) {
577
+ if (firstSelectedRow) scrollElementIntoView(firstSelectedRow, true, false, 0, this.el);
578
+ this.selectedEl = firstSelectedRow;
579
+ }
580
+ }
581
+
582
+ moveCursor(
583
+ index: number,
584
+ {
585
+ focused,
586
+ hover,
587
+ scrollIntoView,
588
+ select,
589
+ selectRange,
590
+ selectOptions,
591
+ }: {
592
+ focused?: boolean;
593
+ hover?: boolean;
594
+ scrollIntoView?: boolean;
595
+ select?: boolean;
596
+ selectRange?: boolean;
597
+ selectOptions?: { toggle?: boolean; add?: boolean };
598
+ } = {},
599
+ ): void {
600
+ let { instance, selectable } = this.props;
601
+ if (!selectable) return;
602
+
603
+ let { widget } = instance as unknown as { widget: List };
604
+ let newState: Partial<ListComponentState> = {};
605
+ if (widget.focused) focused = true;
606
+
607
+ if (focused != null && this.state.focused != focused) newState.focused = focused;
608
+
609
+ //ignore mouse enter/leave events (support with a flag if a feature request comes)
610
+ if (!hover) newState.cursor = index;
611
+
612
+ //batch updates to avoid flickering between selection and cursor changes
613
+ batchUpdates(() => {
614
+ if (select || widget.selectMode) {
615
+ let start: number | undefined =
616
+ selectRange && this.state.selectionStart !== undefined && this.state.selectionStart >= 0
617
+ ? this.state.selectionStart
618
+ : index;
619
+ if (start < 0) start = index;
620
+ this.selectRange(start, index, selectOptions);
621
+ if (!selectRange) newState.selectionStart = index;
622
+ }
623
+ if (Object.keys(newState).length > 0) {
624
+ this.setState(newState as ListComponentState, () => {
625
+ if (scrollIntoView && this.el) {
626
+ let item = this.el.children[this.cursorChildIndex[index]];
627
+ if (item) scrollElementIntoView(item);
628
+ }
629
+ });
630
+ }
631
+ });
632
+ }
633
+
634
+ selectRange(from: number, to: number, options?: { toggle?: boolean; add?: boolean }): void {
635
+ let { instance, items } = this.props;
636
+ let { widget } = instance as unknown as { widget: List };
637
+
638
+ if (from > to) {
639
+ let tmp = from;
640
+ from = to;
641
+ to = tmp;
642
+ }
643
+
644
+ let selection: any[] = [],
645
+ indexes: number[] = [];
646
+
647
+ for (let cursor = from; cursor <= to; cursor++) {
648
+ let item = items[this.cursorChildIndex[cursor]];
649
+ if (item) {
650
+ let { record, data } = item.instance as { record: any; data: any };
651
+ if (data.disabled) continue;
652
+ selection.push(record.data);
653
+ indexes.push(record.index);
654
+ }
655
+ }
656
+
657
+ widget.selection.selectMultiple(instance.store, selection, indexes, options);
658
+ }
659
+
660
+ showCursor(force?: boolean, newItems?: ListItemData[]): void {
661
+ if (!force && this.state.cursor >= 0) return;
662
+
663
+ let items = newItems || this.props.items;
664
+ let index = -1,
665
+ firstSelected = -1,
666
+ firstValid = -1;
667
+ for (let i = 0; i < items.length; i++) {
668
+ let item = items[i];
669
+ if (isDataItem(item)) {
670
+ index++;
671
+
672
+ if (!isItemDisabled(item) && firstValid == -1) firstValid = index;
673
+ if ((item.instance as any).selected) {
674
+ firstSelected = index;
675
+ break;
676
+ }
677
+ }
678
+ }
679
+ this.moveCursor(firstSelected != -1 ? firstSelected : firstValid, {
680
+ focused: true,
681
+ });
682
+ }
683
+
684
+ onFocus(): void {
685
+ let { widget } = this.props.instance as unknown as { widget: List };
686
+
687
+ FocusManager.nudge();
688
+ this.showCursor(widget.selectMode);
689
+
690
+ if (!widget.focused && this.el)
691
+ oneFocusOut(this, this.el, () => {
692
+ this.moveCursor(-1, { focused: false });
693
+ });
694
+
695
+ this.setState({
696
+ focused: true,
697
+ });
698
+ }
699
+
700
+ onBlur(): void {
701
+ FocusManager.nudge();
702
+ }
703
+
704
+ handleMouseLeave(): void {
705
+ let { widget } = this.props.instance as unknown as { widget: List };
706
+ if (!widget.focused) this.moveCursor(-1, { hover: true });
707
+ }
708
+
709
+ handleKeyDown(e: React.KeyboardEvent): void {
710
+ let { instance, items } = this.props;
711
+ let { widget } = instance as unknown as { widget: List };
712
+
713
+ if (this.onKeyDown && instance.invoke("onKeyDown", e, instance) === false) return;
714
+
715
+ switch (e.keyCode) {
716
+ case KeyCode.tab:
717
+ case KeyCode.enter:
718
+ if (!widget.selectOnTab && e.keyCode == KeyCode.tab) break;
719
+ let item = items[this.cursorChildIndex[this.state.cursor]];
720
+ if (item && widget.onItemClick && instance.invoke("onItemClick", e, item.instance) === false) return;
721
+ this.moveCursor(this.state.cursor, {
722
+ select: true,
723
+ selectOptions: {
724
+ toggle: e.ctrlKey && !e.shiftKey,
725
+ add: e.ctrlKey && e.shiftKey,
726
+ },
727
+ selectRange: e.shiftKey,
728
+ });
729
+ break;
730
+
731
+ case KeyCode.down:
732
+ for (let index = this.state.cursor + 1; index < this.cursorChildIndex.length; index++) {
733
+ let item = items[this.cursorChildIndex[index]];
734
+ if (!isItemSelectable(item)) continue;
735
+ this.moveCursor(index, {
736
+ focused: true,
737
+ scrollIntoView: true,
738
+ select: e.shiftKey,
739
+ selectRange: e.shiftKey,
740
+ });
741
+ e.stopPropagation();
742
+ e.preventDefault();
743
+ break;
744
+ }
745
+ break;
746
+
747
+ case KeyCode.up:
748
+ for (let index = this.state.cursor - 1; index >= 0; index--) {
749
+ let item = items[this.cursorChildIndex[index]];
750
+ if (!isItemSelectable(item)) continue;
751
+ this.moveCursor(index, {
752
+ focused: true,
753
+ scrollIntoView: true,
754
+ select: e.shiftKey,
755
+ selectRange: e.shiftKey,
756
+ });
757
+ e.stopPropagation();
758
+ e.preventDefault();
759
+ break;
760
+ }
761
+ break;
762
+
763
+ case KeyCode.a:
764
+ if (!e.ctrlKey || !widget.selection.multiple) return;
765
+
766
+ this.selectRange(0, this.cursorChildIndex.length);
767
+
768
+ e.stopPropagation();
769
+ e.preventDefault();
770
+ break;
771
+ }
772
+ }
773
+ }
774
+
775
+ class ListItem extends Container {
776
+ declareData(...args: Record<string, unknown>[]) {
777
+ super.declareData(...args, {
778
+ disabled: undefined,
779
+ });
780
+ }
781
+ }
782
+
783
+ function isItemSelectable(item: any) {
784
+ return isDataItem(item) && !isItemDisabled(item);
785
+ }
786
+
787
+ function isDataItem(item: any) {
788
+ return item?.type == "data";
789
+ }
790
+
791
+ function isItemDisabled(item: any) {
792
+ return item?.instance.data.disabled;
793
+ }