@ui5/webcomponents-base 0.0.0-deac3098a → 0.0.0-e0658a650

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 (627) hide show
  1. package/CHANGELOG.md +158 -0
  2. package/README.md +28 -6
  3. package/bundle.esm.js +12 -10
  4. package/dist/AssetRegistry.d.ts +5 -0
  5. package/dist/AssetRegistry.js +2 -7
  6. package/dist/AssetRegistry.js.map +1 -0
  7. package/dist/Boot.d.ts +8 -0
  8. package/dist/Boot.js +29 -44
  9. package/dist/Boot.js.map +1 -0
  10. package/dist/CSP.d.ts +30 -0
  11. package/dist/CSP.js +16 -24
  12. package/dist/CSP.js.map +1 -0
  13. package/dist/CustomElementsRegistry.d.ts +5 -0
  14. package/dist/CustomElementsRegistry.js +66 -83
  15. package/dist/CustomElementsRegistry.js.map +1 -0
  16. package/dist/CustomElementsScope.d.ts +7 -0
  17. package/dist/CustomElementsScope.js +10 -29
  18. package/dist/CustomElementsScope.js.map +1 -0
  19. package/dist/CustomElementsScopeUtils.d.ts +55 -0
  20. package/dist/CustomElementsScopeUtils.js +34 -52
  21. package/dist/CustomElementsScopeUtils.js.map +1 -0
  22. package/dist/DOMObserver.d.ts +11 -0
  23. package/dist/DOMObserver.js +12 -54
  24. package/dist/DOMObserver.js.map +1 -0
  25. package/dist/Device.d.ts +11 -0
  26. package/dist/Device.js +51 -78
  27. package/dist/Device.js.map +1 -0
  28. package/dist/EventProvider.d.ts +25 -0
  29. package/dist/EventProvider.js +67 -82
  30. package/dist/EventProvider.js.map +1 -0
  31. package/dist/FeaturesRegistry.d.ts +3 -0
  32. package/dist/FeaturesRegistry.js +5 -10
  33. package/dist/FeaturesRegistry.js.map +1 -0
  34. package/dist/FontFace.d.ts +2 -0
  35. package/dist/FontFace.js +14 -19
  36. package/dist/FontFace.js.map +1 -0
  37. package/dist/InitialConfiguration.d.ts +22 -0
  38. package/dist/InitialConfiguration.js +112 -131
  39. package/dist/InitialConfiguration.js.map +1 -0
  40. package/dist/Keys.d.ts +57 -0
  41. package/dist/Keys.js +174 -291
  42. package/dist/Keys.js.map +1 -0
  43. package/dist/ManagedStyles.d.ts +8 -0
  44. package/dist/ManagedStyles.js +62 -68
  45. package/dist/ManagedStyles.js.map +1 -0
  46. package/dist/MediaRange.d.ts +36 -0
  47. package/dist/MediaRange.js +38 -51
  48. package/dist/MediaRange.js.map +1 -0
  49. package/dist/PropertiesFileFormat.d.ts +8 -0
  50. package/dist/PropertiesFileFormat.js +72 -82
  51. package/dist/PropertiesFileFormat.js.map +1 -0
  52. package/dist/Render.d.ts +47 -0
  53. package/dist/Render.js +81 -113
  54. package/dist/Render.js.map +1 -0
  55. package/dist/RenderQueue.d.ts +19 -0
  56. package/dist/RenderQueue.js +52 -62
  57. package/dist/RenderQueue.js.map +1 -0
  58. package/dist/Runtimes.d.ts +27 -0
  59. package/dist/Runtimes.js +49 -70
  60. package/dist/Runtimes.js.map +1 -0
  61. package/dist/StaticArea.d.ts +0 -0
  62. package/dist/StaticArea.js +4 -1
  63. package/dist/StaticArea.js.map +1 -0
  64. package/dist/StaticAreaItem.d.ts +36 -0
  65. package/dist/StaticAreaItem.js +84 -86
  66. package/dist/StaticAreaItem.js.map +1 -0
  67. package/dist/SystemCSSVars.d.ts +2 -0
  68. package/dist/SystemCSSVars.js +4 -5
  69. package/dist/SystemCSSVars.js.map +1 -0
  70. package/dist/Theming.d.ts +3 -0
  71. package/dist/Theming.js +1 -1
  72. package/dist/Theming.js.map +1 -0
  73. package/dist/UI5Element.d.ts +371 -0
  74. package/dist/UI5Element.js +905 -993
  75. package/dist/UI5Element.js.map +1 -0
  76. package/dist/UI5ElementMetadata.d.ts +147 -0
  77. package/dist/UI5ElementMetadata.js +260 -313
  78. package/dist/UI5ElementMetadata.js.map +1 -0
  79. package/dist/animations/AnimationQueue.d.ts +8 -0
  80. package/dist/animations/AnimationQueue.js +31 -38
  81. package/dist/animations/AnimationQueue.js.map +1 -0
  82. package/dist/animations/animate.d.ts +14 -0
  83. package/dist/animations/animate.js +46 -51
  84. package/dist/animations/animate.js.map +1 -0
  85. package/dist/animations/scroll.d.ts +5 -0
  86. package/dist/animations/scroll.js +18 -27
  87. package/dist/animations/scroll.js.map +1 -0
  88. package/dist/animations/slideDown.d.ts +5 -0
  89. package/dist/animations/slideDown.js +53 -78
  90. package/dist/animations/slideDown.js.map +1 -0
  91. package/dist/animations/slideUp.d.ts +5 -0
  92. package/dist/animations/slideUp.js +49 -70
  93. package/dist/animations/slideUp.js.map +1 -0
  94. package/dist/api.json +1 -0
  95. package/dist/asset-registries/Icons.d.ts +30 -0
  96. package/dist/asset-registries/Icons.js +85 -116
  97. package/dist/asset-registries/Icons.js.map +1 -0
  98. package/dist/asset-registries/Illustrations.d.ts +16 -0
  99. package/dist/asset-registries/Illustrations.js +40 -24
  100. package/dist/asset-registries/Illustrations.js.map +1 -0
  101. package/dist/asset-registries/LocaleData.d.ts +7 -0
  102. package/dist/asset-registries/LocaleData.js +104 -132
  103. package/dist/asset-registries/LocaleData.js.map +1 -0
  104. package/dist/asset-registries/Themes.d.ts +10 -0
  105. package/dist/asset-registries/Themes.js +38 -66
  106. package/dist/asset-registries/Themes.js.map +1 -0
  107. package/dist/asset-registries/i18n.d.ts +23 -0
  108. package/dist/asset-registries/i18n.js +55 -81
  109. package/dist/asset-registries/i18n.js.map +1 -0
  110. package/dist/assets/bundle.esm.72c1d211.js +56 -0
  111. package/dist/assets-meta/IconCollectionsAlias.d.ts +17 -0
  112. package/dist/assets-meta/IconCollectionsAlias.js +4 -4
  113. package/dist/assets-meta/IconCollectionsAlias.js.map +1 -0
  114. package/dist/config/AnimationMode.d.ts +14 -0
  115. package/dist/config/AnimationMode.js +21 -18
  116. package/dist/config/AnimationMode.js.map +1 -0
  117. package/dist/config/CalendarType.d.ts +8 -0
  118. package/dist/config/CalendarType.js +13 -12
  119. package/dist/config/CalendarType.js.map +1 -0
  120. package/dist/config/FormatSettings.d.ts +11 -0
  121. package/dist/config/FormatSettings.js +10 -8
  122. package/dist/config/FormatSettings.js.map +1 -0
  123. package/dist/config/Icons.d.ts +30 -0
  124. package/dist/config/Icons.js +28 -32
  125. package/dist/config/Icons.js.map +1 -0
  126. package/dist/config/Language.d.ts +31 -0
  127. package/dist/config/Language.js +31 -43
  128. package/dist/config/Language.js.map +1 -0
  129. package/dist/config/NoConflict.d.ts +20 -0
  130. package/dist/config/NoConflict.js +40 -41
  131. package/dist/config/NoConflict.js.map +1 -0
  132. package/dist/config/RTL.d.ts +7 -0
  133. package/dist/config/RTL.js +23 -20
  134. package/dist/config/RTL.js.map +1 -0
  135. package/dist/config/Theme.d.ts +28 -0
  136. package/dist/config/Theme.js +34 -36
  137. package/dist/config/Theme.js.map +1 -0
  138. package/dist/config/ThemeRoots.d.ts +4 -0
  139. package/dist/config/ThemeRoots.js +28 -0
  140. package/dist/config/ThemeRoots.js.map +1 -0
  141. package/dist/css/BusyIndicator.css +4 -0
  142. package/dist/css/FontFace.css +9 -18
  143. package/dist/delegate/ItemNavigation.d.ts +113 -0
  144. package/dist/delegate/ItemNavigation.js +277 -312
  145. package/dist/delegate/ItemNavigation.js.map +1 -0
  146. package/dist/delegate/ResizeHandler.d.ts +24 -0
  147. package/dist/delegate/ResizeHandler.js +68 -91
  148. package/dist/delegate/ResizeHandler.js.map +1 -0
  149. package/dist/delegate/ScrollEnablement.d.ts +43 -0
  150. package/dist/delegate/ScrollEnablement.js +157 -180
  151. package/dist/delegate/ScrollEnablement.js.map +1 -0
  152. package/dist/features/F6Navigation.d.ts +16 -0
  153. package/dist/features/F6Navigation.js +106 -102
  154. package/dist/features/F6Navigation.js.map +1 -0
  155. package/dist/features/OpenUI5Element.d.ts +9 -0
  156. package/dist/features/OpenUI5Element.js +5 -0
  157. package/dist/features/OpenUI5Element.js.map +1 -0
  158. package/dist/features/OpenUI5Enablement.d.ts +11 -0
  159. package/dist/features/OpenUI5Enablement.js +89 -112
  160. package/dist/features/OpenUI5Enablement.js.map +1 -0
  161. package/dist/features/OpenUI5Support.d.ts +23 -0
  162. package/dist/features/OpenUI5Support.js +91 -119
  163. package/dist/features/OpenUI5Support.js.map +1 -0
  164. package/dist/generated/VersionInfo.js +3 -3
  165. package/dist/generated/css/BusyIndicator.css.js +1 -1
  166. package/dist/generated/css/FontFace.css.js +1 -1
  167. package/dist/generated/templates/elements/WithComplexTemplateTemplate.lit.js +11 -0
  168. package/dist/getSharedResource.d.ts +11 -0
  169. package/dist/getSharedResource.js +12 -16
  170. package/dist/getSharedResource.js.map +1 -0
  171. package/dist/i18nBundle.d.ts +43 -0
  172. package/dist/i18nBundle.js +56 -64
  173. package/dist/i18nBundle.js.map +1 -0
  174. package/dist/locale/Locale.d.ts +22 -0
  175. package/dist/locale/Locale.js +75 -87
  176. package/dist/locale/Locale.js.map +1 -0
  177. package/dist/locale/RTLAwareRegistry.d.ts +4 -0
  178. package/dist/locale/RTLAwareRegistry.js +6 -11
  179. package/dist/locale/RTLAwareRegistry.js.map +1 -0
  180. package/dist/locale/applyDirection.d.ts +10 -0
  181. package/dist/locale/applyDirection.js +7 -7
  182. package/dist/locale/applyDirection.js.map +1 -0
  183. package/dist/locale/directionChange.d.ts +15 -0
  184. package/dist/locale/directionChange.js +7 -15
  185. package/dist/locale/directionChange.js.map +1 -0
  186. package/dist/locale/getEffectiveDir.d.ts +2 -0
  187. package/dist/locale/getEffectiveDir.js +20 -24
  188. package/dist/locale/getEffectiveDir.js.map +1 -0
  189. package/dist/locale/getLocale.d.ts +7 -0
  190. package/dist/locale/getLocale.js +26 -29
  191. package/dist/locale/getLocale.js.map +1 -0
  192. package/dist/locale/languageChange.d.ts +5 -0
  193. package/dist/locale/languageChange.js +8 -16
  194. package/dist/locale/languageChange.js.map +1 -0
  195. package/dist/locale/nextFallbackLocale.d.ts +8 -0
  196. package/dist/locale/nextFallbackLocale.js +15 -19
  197. package/dist/locale/nextFallbackLocale.js.map +1 -0
  198. package/dist/locale/normalizeLocale.d.ts +7 -0
  199. package/dist/locale/normalizeLocale.js +34 -41
  200. package/dist/locale/normalizeLocale.js.map +1 -0
  201. package/dist/renderer/LitRenderer.d.ts +14 -0
  202. package/dist/renderer/LitRenderer.js +28 -39
  203. package/dist/renderer/LitRenderer.js.map +1 -0
  204. package/dist/renderer/executeTemplate.d.ts +13 -0
  205. package/dist/renderer/executeTemplate.js +12 -16
  206. package/dist/renderer/executeTemplate.js.map +1 -0
  207. package/dist/sap/ui/thirdparty/caja-html-sanitizer.js +1 -1
  208. package/dist/theming/CustomStyle.d.ts +6 -0
  209. package/dist/theming/CustomStyle.js +29 -43
  210. package/dist/theming/CustomStyle.js.map +1 -0
  211. package/dist/theming/ThemeLoaded.d.ts +5 -0
  212. package/dist/theming/ThemeLoaded.js +8 -16
  213. package/dist/theming/ThemeLoaded.js.map +1 -0
  214. package/dist/theming/applyTheme.d.ts +2 -0
  215. package/dist/theming/applyTheme.js +60 -64
  216. package/dist/theming/applyTheme.js.map +1 -0
  217. package/dist/theming/getConstructableStyle.d.ts +9 -0
  218. package/dist/theming/getConstructableStyle.js +12 -17
  219. package/dist/theming/getConstructableStyle.js.map +1 -0
  220. package/dist/theming/getEffectiveLinksHrefs.d.ts +3 -0
  221. package/dist/theming/getEffectiveLinksHrefs.js +11 -22
  222. package/dist/theming/getEffectiveLinksHrefs.js.map +1 -0
  223. package/dist/theming/getEffectiveStyle.d.ts +3 -0
  224. package/dist/theming/getEffectiveStyle.js +24 -31
  225. package/dist/theming/getEffectiveStyle.js.map +1 -0
  226. package/dist/theming/getStylesString.d.ts +3 -0
  227. package/dist/theming/getStylesString.js +8 -13
  228. package/dist/theming/getStylesString.js.map +1 -0
  229. package/dist/theming/getThemeDesignerTheme.d.ts +7 -0
  230. package/dist/theming/getThemeDesignerTheme.js +72 -79
  231. package/dist/theming/getThemeDesignerTheme.js.map +1 -0
  232. package/dist/theming/preloadLinks.d.ts +3 -0
  233. package/dist/theming/preloadLinks.js +13 -17
  234. package/dist/theming/preloadLinks.js.map +1 -0
  235. package/dist/thirdparty/_merge.d.ts +2 -0
  236. package/dist/thirdparty/_merge.js +7 -4
  237. package/dist/thirdparty/_merge.js.map +1 -0
  238. package/dist/thirdparty/isPlainObject.d.ts +2 -0
  239. package/dist/thirdparty/isPlainObject.js +11 -10
  240. package/dist/thirdparty/isPlainObject.js.map +1 -0
  241. package/dist/thirdparty/merge.d.ts +2 -0
  242. package/dist/thirdparty/merge.js +4 -8
  243. package/dist/thirdparty/merge.js.map +1 -0
  244. package/dist/types/AnimationMode.d.ts +32 -0
  245. package/dist/types/AnimationMode.js +33 -6
  246. package/dist/types/AnimationMode.js.map +1 -0
  247. package/dist/types/CSSColor.d.ts +16 -0
  248. package/dist/types/CSSColor.js +15 -5
  249. package/dist/types/CSSColor.js.map +1 -0
  250. package/dist/types/CalendarType.d.ts +37 -0
  251. package/dist/types/CalendarType.js +35 -18
  252. package/dist/types/CalendarType.js.map +1 -0
  253. package/dist/types/DOMReference.d.ts +17 -0
  254. package/dist/types/DOMReference.js +25 -0
  255. package/dist/types/DOMReference.js.map +1 -0
  256. package/dist/types/DataType.d.ts +25 -0
  257. package/dist/types/DataType.js +32 -25
  258. package/dist/types/DataType.js.map +1 -0
  259. package/dist/types/Float.d.ts +18 -0
  260. package/dist/types/Float.js +18 -10
  261. package/dist/types/Float.js.map +1 -0
  262. package/dist/types/Integer.d.ts +18 -0
  263. package/dist/types/Integer.js +18 -9
  264. package/dist/types/Integer.js.map +1 -0
  265. package/dist/types/InvisibleMessageMode.d.ts +25 -0
  266. package/dist/types/InvisibleMessageMode.js +20 -23
  267. package/dist/types/InvisibleMessageMode.js.map +1 -0
  268. package/dist/types/ItemNavigationBehavior.d.ts +24 -0
  269. package/dist/types/ItemNavigationBehavior.js +22 -12
  270. package/dist/types/ItemNavigationBehavior.js.map +1 -0
  271. package/dist/types/NavigationMode.d.ts +32 -0
  272. package/dist/types/NavigationMode.js +33 -6
  273. package/dist/types/NavigationMode.js.map +1 -0
  274. package/dist/types/ValueState.d.ts +42 -0
  275. package/dist/types/ValueState.js +41 -19
  276. package/dist/types/ValueState.js.map +1 -0
  277. package/dist/types.d.ts +13 -0
  278. package/dist/types.js +2 -0
  279. package/dist/types.js.map +1 -0
  280. package/dist/updateShadowRoot.d.ts +8 -0
  281. package/dist/updateShadowRoot.js +21 -17
  282. package/dist/updateShadowRoot.js.map +1 -0
  283. package/dist/util/AriaLabelHelper.d.ts +6 -0
  284. package/dist/util/AriaLabelHelper.js +37 -34
  285. package/dist/util/AriaLabelHelper.js.map +1 -0
  286. package/dist/util/Caret.d.ts +7 -0
  287. package/dist/util/Caret.js +16 -38
  288. package/dist/util/Caret.js.map +1 -0
  289. package/dist/util/ColorConversion.d.ts +33 -0
  290. package/dist/util/ColorConversion.js +315 -348
  291. package/dist/util/ColorConversion.js.map +1 -0
  292. package/dist/util/FetchHelper.d.ts +3 -0
  293. package/dist/util/FetchHelper.js +19 -25
  294. package/dist/util/FetchHelper.js.map +1 -0
  295. package/dist/util/FocusableElements.d.ts +3 -0
  296. package/dist/util/FocusableElements.js +54 -71
  297. package/dist/util/FocusableElements.js.map +1 -0
  298. package/dist/util/HTMLSanitizer.d.ts +3 -0
  299. package/dist/util/HTMLSanitizer.js +4 -5
  300. package/dist/util/HTMLSanitizer.js.map +1 -0
  301. package/dist/util/InvisibleMessage.d.ts +10 -0
  302. package/dist/util/InvisibleMessage.js +41 -45
  303. package/dist/util/InvisibleMessage.js.map +1 -0
  304. package/dist/util/PopupUtils.d.ts +7 -0
  305. package/dist/util/PopupUtils.js +57 -76
  306. package/dist/util/PopupUtils.js.map +1 -0
  307. package/dist/util/SlotsHelper.d.ts +9 -0
  308. package/dist/util/SlotsHelper.js +22 -35
  309. package/dist/util/SlotsHelper.js.map +1 -0
  310. package/dist/util/StringHelper.d.ts +3 -0
  311. package/dist/util/StringHelper.js +17 -20
  312. package/dist/util/StringHelper.js.map +1 -0
  313. package/dist/util/TabbableElements.d.ts +3 -0
  314. package/dist/util/TabbableElements.js +39 -47
  315. package/dist/util/TabbableElements.js.map +1 -0
  316. package/dist/util/arraysAreEqual.d.ts +2 -0
  317. package/dist/util/arraysAreEqual.js +10 -12
  318. package/dist/util/arraysAreEqual.js.map +1 -0
  319. package/dist/util/clamp.d.ts +9 -0
  320. package/dist/util/clamp.js +2 -2
  321. package/dist/util/clamp.js.map +1 -0
  322. package/dist/util/createLinkInHead.d.ts +7 -0
  323. package/dist/util/createLinkInHead.js +14 -12
  324. package/dist/util/createLinkInHead.js.map +1 -0
  325. package/dist/util/createStyleInHead.d.ts +8 -0
  326. package/dist/util/createStyleInHead.js +10 -10
  327. package/dist/util/createStyleInHead.js.map +1 -0
  328. package/dist/util/debounce.d.ts +2 -0
  329. package/dist/util/debounce.js +6 -8
  330. package/dist/util/debounce.js.map +1 -0
  331. package/dist/util/detectNavigatorLanguage.d.ts +2 -0
  332. package/dist/util/detectNavigatorLanguage.js +7 -10
  333. package/dist/util/detectNavigatorLanguage.js.map +1 -0
  334. package/dist/util/escapeRegex.d.ts +8 -0
  335. package/dist/util/escapeRegex.js +8 -7
  336. package/dist/util/escapeRegex.js.map +1 -0
  337. package/dist/util/formatMessage.d.ts +2 -0
  338. package/dist/util/formatMessage.js +15 -19
  339. package/dist/util/formatMessage.js.map +1 -0
  340. package/dist/util/generateHighlightedMarkup.d.ts +9 -0
  341. package/dist/util/generateHighlightedMarkup.js +26 -27
  342. package/dist/util/generateHighlightedMarkup.js.map +1 -0
  343. package/dist/util/getActiveElement.d.ts +2 -0
  344. package/dist/util/getActiveElement.js +6 -8
  345. package/dist/util/getActiveElement.js.map +1 -0
  346. package/dist/util/getClassCopy.d.ts +398 -0
  347. package/dist/util/getClassCopy.js +7 -7
  348. package/dist/util/getClassCopy.js.map +1 -0
  349. package/dist/util/getDesigntimePropertyAsArray.d.ts +2 -0
  350. package/dist/util/getDesigntimePropertyAsArray.js +4 -3
  351. package/dist/util/getDesigntimePropertyAsArray.js.map +1 -0
  352. package/dist/util/getEffectiveContentDensity.d.ts +2 -0
  353. package/dist/util/getEffectiveContentDensity.js +2 -3
  354. package/dist/util/getEffectiveContentDensity.js.map +1 -0
  355. package/dist/util/getEffectiveScrollbarStyle.d.ts +2 -0
  356. package/dist/util/getEffectiveScrollbarStyle.js +4 -0
  357. package/dist/util/getEffectiveScrollbarStyle.js.map +1 -0
  358. package/dist/util/getFastNavigationGroups.d.ts +2 -0
  359. package/dist/util/getFastNavigationGroups.js +51 -0
  360. package/dist/util/getFastNavigationGroups.js.map +1 -0
  361. package/dist/util/getFileExtension.d.ts +12 -0
  362. package/dist/util/getFileExtension.js +9 -11
  363. package/dist/util/getFileExtension.js.map +1 -0
  364. package/dist/util/getNormalizedTarget.d.ts +7 -0
  365. package/dist/util/getNormalizedTarget.js +7 -9
  366. package/dist/util/getNormalizedTarget.js.map +1 -0
  367. package/dist/util/getSingletonElementInstance.d.ts +2 -0
  368. package/dist/util/getSingletonElementInstance.js +7 -10
  369. package/dist/util/getSingletonElementInstance.js.map +1 -0
  370. package/dist/util/isDefaultSlotProvided.d.ts +2 -0
  371. package/dist/util/isDefaultSlotProvided.js +10 -0
  372. package/dist/util/isDefaultSlotProvided.js.map +1 -0
  373. package/dist/util/isElementClickable.d.ts +2 -0
  374. package/dist/util/isElementClickable.js +16 -0
  375. package/dist/util/isElementClickable.js.map +1 -0
  376. package/dist/util/isElementHidden.d.ts +2 -0
  377. package/dist/util/isElementHidden.js +8 -0
  378. package/dist/util/isElementHidden.js.map +1 -0
  379. package/dist/util/isElementInView.d.ts +6 -0
  380. package/dist/util/isElementInView.js +6 -9
  381. package/dist/util/isElementInView.js.map +1 -0
  382. package/dist/util/isElementTabbable.d.ts +2 -0
  383. package/dist/util/isElementTabbable.js +22 -0
  384. package/dist/util/isElementTabbable.js.map +1 -0
  385. package/dist/util/isValidPropertyName.d.ts +8 -0
  386. package/dist/util/isValidPropertyName.js +16 -17
  387. package/dist/util/isValidPropertyName.js.map +1 -0
  388. package/dist/util/whenDOMReady.d.ts +2 -0
  389. package/dist/util/whenDOMReady.js +11 -10
  390. package/dist/util/whenDOMReady.js.map +1 -0
  391. package/dist/validateThemeRoot.d.ts +2 -0
  392. package/dist/validateThemeRoot.js +47 -0
  393. package/dist/validateThemeRoot.js.map +1 -0
  394. package/global.d.ts +44 -0
  395. package/lib/generate-asset-parameters/index.js +8 -4
  396. package/lib/generate-styles/index.js +17 -9
  397. package/lib/generate-version-info/index.js +18 -13
  398. package/package-scripts.js +27 -22
  399. package/package.json +9 -7
  400. package/src/{AssetRegistry.js → AssetRegistry.ts} +0 -0
  401. package/src/Boot.ts +61 -0
  402. package/src/{CSP.js → CSP.ts} +14 -7
  403. package/src/{CustomElementsRegistry.js → CustomElementsRegistry.ts} +20 -17
  404. package/src/{CustomElementsScope.js → CustomElementsScope.ts} +8 -5
  405. package/src/{CustomElementsScopeUtils.js → CustomElementsScopeUtils.ts} +14 -7
  406. package/src/DOMObserver.ts +28 -0
  407. package/src/{Device.js → Device.ts} +8 -3
  408. package/src/{EventProvider.js → EventProvider.ts} +9 -7
  409. package/src/FeaturesRegistry.ts +14 -0
  410. package/src/{FontFace.js → FontFace.ts} +3 -2
  411. package/src/{InitialConfiguration.js → InitialConfiguration.ts} +53 -12
  412. package/src/Keys.ts +295 -0
  413. package/src/ManagedStyles.ts +92 -0
  414. package/src/{MediaRange.js → MediaRange.ts} +14 -14
  415. package/src/{PropertiesFileFormat.js → PropertiesFileFormat.ts} +8 -8
  416. package/src/{Render.js → Render.ts} +25 -20
  417. package/src/{RenderQueue.js → RenderQueue.ts} +10 -5
  418. package/src/{Runtimes.js → Runtimes.ts} +15 -8
  419. package/src/{StaticArea.js → StaticArea.ts} +0 -0
  420. package/src/{StaticAreaItem.js → StaticAreaItem.ts} +30 -18
  421. package/src/{SystemCSSVars.js → SystemCSSVars.ts} +0 -0
  422. package/src/{Theming.js → Theming.ts} +0 -0
  423. package/src/{UI5Element.js → UI5Element.ts} +231 -139
  424. package/src/{UI5ElementMetadata.js → UI5ElementMetadata.ts} +80 -43
  425. package/src/animations/{AnimationQueue.js → AnimationQueue.ts} +8 -7
  426. package/src/animations/animate.ts +64 -0
  427. package/src/animations/scroll.ts +21 -0
  428. package/src/animations/{slideDown.js → slideDown.ts} +27 -34
  429. package/src/animations/{slideUp.js → slideUp.ts} +28 -32
  430. package/src/asset-registries/{Icons.js → Icons.ts} +63 -37
  431. package/src/asset-registries/Illustrations.ts +73 -0
  432. package/src/asset-registries/{LocaleData.js → LocaleData.ts} +36 -28
  433. package/src/asset-registries/Themes.ts +67 -0
  434. package/src/asset-registries/{i18n.js → i18n.ts} +21 -24
  435. package/src/assets-meta/{IconCollectionsAlias.js → IconCollectionsAlias.ts} +0 -0
  436. package/src/config/AnimationMode.ts +33 -0
  437. package/src/config/{CalendarType.js → CalendarType.ts} +8 -3
  438. package/src/config/FormatSettings.ts +21 -0
  439. package/src/config/{Icons.js → Icons.ts} +19 -12
  440. package/src/config/{Language.js → Language.ts} +22 -18
  441. package/src/config/NoConflict.ts +67 -0
  442. package/src/config/{RTL.js → RTL.ts} +14 -4
  443. package/src/config/Theme.ts +64 -0
  444. package/src/config/ThemeRoots.ts +41 -0
  445. package/src/css/BusyIndicator.css +4 -0
  446. package/src/css/FontFace.css +9 -18
  447. package/src/delegate/{ItemNavigation.js → ItemNavigation.ts} +63 -21
  448. package/src/delegate/{ResizeHandler.js → ResizeHandler.ts} +25 -36
  449. package/src/delegate/ScrollEnablement.ts +215 -0
  450. package/src/features/F6Navigation.ts +141 -0
  451. package/src/features/OpenUI5Element.ts +11 -0
  452. package/src/features/OpenUI5Enablement.ts +117 -0
  453. package/src/features/OpenUI5Support.ts +148 -0
  454. package/src/{getSharedResource.js → getSharedResource.ts} +3 -3
  455. package/src/{i18nBundle.js → i18nBundle.ts} +44 -22
  456. package/src/locale/{Locale.js → Locale.ts} +15 -5
  457. package/src/locale/RTLAwareRegistry.ts +16 -0
  458. package/src/locale/{applyDirection.js → applyDirection.ts} +4 -3
  459. package/src/locale/{directionChange.js → directionChange.ts} +6 -4
  460. package/src/locale/{getEffectiveDir.js → getEffectiveDir.ts} +1 -1
  461. package/src/locale/{getLocale.js → getLocale.ts} +12 -7
  462. package/src/locale/languageChange.ts +24 -0
  463. package/src/locale/{nextFallbackLocale.js → nextFallbackLocale.ts} +1 -1
  464. package/src/locale/{normalizeLocale.js → normalizeLocale.ts} +4 -2
  465. package/src/renderer/LitRenderer.ts +60 -0
  466. package/src/renderer/{executeTemplate.js → executeTemplate.ts} +11 -5
  467. package/src/theming/{CustomStyle.js → CustomStyle.ts} +11 -9
  468. package/src/theming/{ThemeLoaded.js → ThemeLoaded.ts} +6 -4
  469. package/src/theming/{applyTheme.js → applyTheme.ts} +22 -11
  470. package/src/theming/{getConstructableStyle.js → getConstructableStyle.ts} +5 -4
  471. package/src/theming/getEffectiveLinksHrefs.ts +24 -0
  472. package/src/theming/{getEffectiveStyle.js → getEffectiveStyle.ts} +9 -7
  473. package/src/theming/getStylesString.ts +13 -0
  474. package/src/theming/{getThemeDesignerTheme.js → getThemeDesignerTheme.ts} +22 -8
  475. package/src/theming/{preloadLinks.js → preloadLinks.ts} +3 -2
  476. package/src/thirdparty/{_merge.js → _merge.ts} +2 -2
  477. package/src/thirdparty/{isPlainObject.js → isPlainObject.ts} +1 -1
  478. package/src/thirdparty/merge.ts +5 -0
  479. package/src/types/AnimationMode.ts +33 -0
  480. package/src/types/{CSSColor.js → CSSColor.ts} +12 -1
  481. package/src/types/CalendarType.ts +38 -0
  482. package/src/types/DOMReference.ts +28 -0
  483. package/src/types/DataType.ts +51 -0
  484. package/src/types/Float.ts +25 -0
  485. package/src/types/Integer.ts +25 -0
  486. package/src/types/InvisibleMessageMode.ts +27 -0
  487. package/src/types/ItemNavigationBehavior.ts +26 -0
  488. package/src/types/NavigationMode.ts +33 -0
  489. package/src/types/ValueState.ts +47 -0
  490. package/src/types.ts +22 -0
  491. package/src/updateShadowRoot.ts +37 -0
  492. package/src/util/AriaLabelHelper.ts +63 -0
  493. package/src/util/Caret.ts +28 -0
  494. package/src/util/ColorConversion.ts +394 -0
  495. package/src/util/{FetchHelper.js → FetchHelper.ts} +7 -7
  496. package/src/util/FocusableElements.ts +80 -0
  497. package/src/util/{HTMLSanitizer.js → HTMLSanitizer.ts} +2 -0
  498. package/src/util/{InvisibleMessage.js → InvisibleMessage.ts} +15 -6
  499. package/src/util/PopupUtils.ts +114 -0
  500. package/src/util/{SlotsHelper.js → SlotsHelper.ts} +9 -13
  501. package/src/util/{StringHelper.js → StringHelper.ts} +7 -7
  502. package/src/util/TabbableElements.ts +56 -0
  503. package/src/util/{arraysAreEqual.js → arraysAreEqual.ts} +1 -1
  504. package/src/util/{clamp.js → clamp.ts} +1 -1
  505. package/src/util/{createLinkInHead.js → createLinkInHead.ts} +10 -4
  506. package/src/util/{createStyleInHead.js → createStyleInHead.ts} +4 -2
  507. package/src/util/{debounce.js → debounce.ts} +5 -4
  508. package/src/util/{detectNavigatorLanguage.js → detectNavigatorLanguage.ts} +1 -1
  509. package/src/util/escapeRegex.ts +11 -0
  510. package/src/util/{formatMessage.js → formatMessage.ts} +4 -3
  511. package/src/util/{generateHighlightedMarkup.js → generateHighlightedMarkup.ts} +7 -6
  512. package/src/util/{getActiveElement.js → getActiveElement.ts} +0 -0
  513. package/src/util/{getClassCopy.js → getClassCopy.ts} +3 -1
  514. package/src/util/{getDesigntimePropertyAsArray.js → getDesigntimePropertyAsArray.ts} +1 -1
  515. package/src/util/getEffectiveContentDensity.ts +5 -0
  516. package/src/util/getEffectiveScrollbarStyle.ts +5 -0
  517. package/src/util/getFastNavigationGroups.ts +63 -0
  518. package/src/util/{getFileExtension.js → getFileExtension.ts} +3 -3
  519. package/src/util/{getNormalizedTarget.js → getNormalizedTarget.ts} +2 -2
  520. package/src/util/{getSingletonElementInstance.js → getSingletonElementInstance.ts} +1 -1
  521. package/src/util/isDefaultSlotProvided.ts +11 -0
  522. package/src/util/isElementClickable.ts +19 -0
  523. package/src/util/isElementHidden.ts +9 -0
  524. package/src/util/{isElementInView.js → isElementInView.ts} +1 -1
  525. package/src/util/isElementTabbable.ts +28 -0
  526. package/src/util/{isValidPropertyName.js → isValidPropertyName.ts} +1 -1
  527. package/src/util/{whenDOMReady.js → whenDOMReady.ts} +1 -1
  528. package/src/validateThemeRoot.ts +58 -0
  529. package/tsconfig.json +13 -0
  530. package/config/.eslintrc.js +0 -3
  531. package/config/rollup.config.js +0 -1
  532. package/dist/RenderScheduler.js +0 -44
  533. package/dist/animations/config.js +0 -5
  534. package/dist/isLegacyBrowser.js +0 -3
  535. package/dist/resources/bundle.esm.js +0 -32
  536. package/dist/resources/bundle.esm.js.map +0 -1
  537. package/dist/test-resources/assets/Themes.js +0 -17
  538. package/dist/test-resources/elements/Child.js +0 -35
  539. package/dist/test-resources/elements/Generic.js +0 -84
  540. package/dist/test-resources/elements/GenericExt.js +0 -26
  541. package/dist/test-resources/elements/NoShadowDOM.js +0 -13
  542. package/dist/test-resources/elements/Parent.js +0 -41
  543. package/dist/test-resources/elements/WithStaticArea.js +0 -77
  544. package/dist/test-resources/pages/AllTestElements.html +0 -42
  545. package/dist/test-resources/pages/Configuration.html +0 -18
  546. package/dist/test-resources/pages/ConfigurationScript.html +0 -34
  547. package/dist/test-resources/pages/assets/messagebundle_de.properties +0 -1
  548. package/dist/test-resources/pages/assets/messagebundle_en.properties +0 -1
  549. package/dist/test-resources/pages/assets/messagebundle_es.properties +0 -1
  550. package/dist/test-resources/pages/assets/messagebundle_fr.properties +0 -1
  551. package/dist/test-resources/pages/i18n.html +0 -33
  552. package/dist/test-resources/specs/ConfigurationChange.spec.js +0 -27
  553. package/dist/test-resources/specs/ConfigurationScript.spec.js +0 -63
  554. package/dist/test-resources/specs/ConfigurationURL.spec.js +0 -93
  555. package/dist/test-resources/specs/CustomTheme.spec.js +0 -27
  556. package/dist/test-resources/specs/EventProvider.spec.js +0 -63
  557. package/dist/test-resources/specs/StaticArea.spec.js +0 -78
  558. package/dist/test-resources/specs/Theming.spec.js +0 -33
  559. package/dist/test-resources/specs/UI5ElementInvalidation.js +0 -242
  560. package/dist/test-resources/specs/UI5ElementLifecycle.js +0 -98
  561. package/dist/test-resources/specs/UI5ElementListenForChildPropChanges.spec.js +0 -75
  562. package/dist/test-resources/specs/UI5ElementMetadataExt.js +0 -42
  563. package/dist/test-resources/specs/UI5ElementPropertyValidation.js +0 -14
  564. package/dist/test-resources/specs/UI5ElementPropsAndAttrs.spec.js +0 -67
  565. package/dist/test-resources/specs/UI5ElementShadowDOM.js +0 -24
  566. package/dist/test-resources/specs/UI5ElementSlots.js +0 -36
  567. package/dist/types/CSSSize.js +0 -9
  568. package/dist/types/PopupState.js +0 -37
  569. package/dist/util/findNodeOwner.js +0 -35
  570. package/dist/util/isDescendantOf.js +0 -15
  571. package/dist/util/isNodeClickable.js +0 -19
  572. package/dist/util/isNodeHidden.js +0 -9
  573. package/dist/util/isNodeTabbable.js +0 -28
  574. package/dist/util/setToArray.js +0 -10
  575. package/hash.txt +0 -1
  576. package/src/Boot.js +0 -59
  577. package/src/DOMObserver.js +0 -65
  578. package/src/FeaturesRegistry.js +0 -14
  579. package/src/Keys.js +0 -295
  580. package/src/ManagedStyles.js +0 -83
  581. package/src/RenderScheduler.js +0 -44
  582. package/src/animations/animate.js +0 -53
  583. package/src/animations/config.js +0 -5
  584. package/src/animations/scroll.js +0 -28
  585. package/src/asset-registries/Illustrations.js +0 -30
  586. package/src/asset-registries/Themes.js +0 -78
  587. package/src/config/AnimationMode.js +0 -23
  588. package/src/config/FormatSettings.js +0 -13
  589. package/src/config/NoConflict.js +0 -51
  590. package/src/config/Theme.js +0 -53
  591. package/src/delegate/ScrollEnablement.js +0 -188
  592. package/src/features/F6Navigation.js +0 -108
  593. package/src/features/OpenUI5Enablement.js +0 -119
  594. package/src/features/OpenUI5Support.js +0 -125
  595. package/src/isLegacyBrowser.js +0 -3
  596. package/src/locale/RTLAwareRegistry.js +0 -14
  597. package/src/locale/languageChange.js +0 -22
  598. package/src/renderer/LitRenderer.js +0 -52
  599. package/src/theming/getEffectiveLinksHrefs.js +0 -27
  600. package/src/theming/getStylesString.js +0 -15
  601. package/src/thirdparty/merge.js +0 -10
  602. package/src/types/AnimationMode.js +0 -7
  603. package/src/types/CSSSize.js +0 -9
  604. package/src/types/CalendarType.js +0 -22
  605. package/src/types/DataType.js +0 -37
  606. package/src/types/Float.js +0 -14
  607. package/src/types/Integer.js +0 -13
  608. package/src/types/InvisibleMessageMode.js +0 -30
  609. package/src/types/ItemNavigationBehavior.js +0 -16
  610. package/src/types/NavigationMode.js +0 -7
  611. package/src/types/PopupState.js +0 -37
  612. package/src/types/ValueState.js +0 -22
  613. package/src/updateShadowRoot.js +0 -30
  614. package/src/util/AriaLabelHelper.js +0 -41
  615. package/src/util/Caret.js +0 -45
  616. package/src/util/ColorConversion.js +0 -370
  617. package/src/util/FocusableElements.js +0 -79
  618. package/src/util/PopupUtils.js +0 -93
  619. package/src/util/TabbableElements.js +0 -51
  620. package/src/util/escapeRegex.js +0 -10
  621. package/src/util/findNodeOwner.js +0 -35
  622. package/src/util/getEffectiveContentDensity.js +0 -5
  623. package/src/util/isDescendantOf.js +0 -15
  624. package/src/util/isNodeClickable.js +0 -19
  625. package/src/util/isNodeHidden.js +0 -9
  626. package/src/util/isNodeTabbable.js +0 -28
  627. package/src/util/setToArray.js +0 -10
@@ -10,44 +10,33 @@ import { registerTag, isTagRegistered, recordTagRegistrationFailure } from "./Cu
10
10
  import { observeDOMNode, unobserveDOMNode } from "./DOMObserver.js";
11
11
  import { skipOriginalEvent } from "./config/NoConflict.js";
12
12
  import getEffectiveDir from "./locale/getEffectiveDir.js";
13
- import DataType from "./types/DataType.js";
14
13
  import { kebabToCamelCase, camelToKebabCase } from "./util/StringHelper.js";
15
14
  import isValidPropertyName from "./util/isValidPropertyName.js";
16
- import isDescendantOf from "./util/isDescendantOf.js";
17
- import { isSlot, getSlotName, getSlottedElementsList } from "./util/SlotsHelper.js";
15
+ import { getSlotName, getSlottedNodesList } from "./util/SlotsHelper.js";
18
16
  import arraysAreEqual from "./util/arraysAreEqual.js";
19
- import getClassCopy from "./util/getClassCopy.js";
20
17
  import { markAsRtlAware } from "./locale/RTLAwareRegistry.js";
21
18
  import preloadLinks from "./theming/preloadLinks.js";
22
-
23
19
  let autoId = 0;
24
-
25
20
  const elementTimeouts = new Map();
26
21
  const uniqueDependenciesCache = new Map();
27
-
28
22
  /**
29
23
  * Triggers re-rendering of a UI5Element instance due to state change.
30
- *
31
- * @param changeInfo An object with information about the change that caused invalidation.
24
+ * @param {ChangeInfo} changeInfo An object with information about the change that caused invalidation.
32
25
  * @private
33
26
  */
34
27
  function _invalidate(changeInfo) {
35
- // Invalidation should be suppressed: 1) before the component is rendered for the first time 2) and during the execution of onBeforeRendering
36
- // This is necessary not only as an optimization, but also to avoid infinite loops on invalidation between children and parents (when invalidateOnChildChange is used)
37
- if (this._suppressInvalidation) {
38
- return;
39
- }
40
-
41
- // Call the onInvalidation hook
42
- this.onInvalidation(changeInfo);
43
-
44
- this._changedState.push(changeInfo);
45
- renderDeferred(this);
46
- this._eventProvider.fireEvent("invalidate", { ...changeInfo, target: this });
28
+ // Invalidation should be suppressed: 1) before the component is rendered for the first time 2) and during the execution of onBeforeRendering
29
+ // This is necessary not only as an optimization, but also to avoid infinite loops on invalidation between children and parents (when invalidateOnChildChange is used)
30
+ if (this._suppressInvalidation) {
31
+ return;
32
+ }
33
+ // Call the onInvalidation hook
34
+ this.onInvalidation(changeInfo);
35
+ this._changedState.push(changeInfo);
36
+ renderDeferred(this);
37
+ this._eventProvider.fireEvent("invalidate", { ...changeInfo, target: this });
47
38
  }
48
-
49
39
  let metadata = {};
50
-
51
40
  /**
52
41
  * Base class for all UI5 Web Components
53
42
  *
@@ -59,975 +48,898 @@ let metadata = {};
59
48
  * @public
60
49
  */
61
50
  class UI5Element extends HTMLElement {
62
- constructor() {
63
- super();
64
-
65
- this._changedState = []; // Filled on each invalidation, cleared on re-render (used for debugging)
66
- this._suppressInvalidation = true; // A flag telling whether all invalidations should be ignored. Initialized with "true" because a UI5Element can not be invalidated until it is rendered for the first time
67
- this._inDOM = false; // A flag telling whether the UI5Element is currently in the DOM tree of the document or not
68
- this._fullyConnected = false; // A flag telling whether the UI5Element's onEnterDOM hook was called (since it's possible to have the element removed from DOM before that)
69
- this._childChangeListeners = new Map(); // used to store lazy listeners per slot for the child change event of every child inside that slot
70
- this._slotChangeListeners = new Map(); // used to store lazy listeners per slot for the slotchange event of all slot children inside that slot
71
- this._eventProvider = new EventProvider(); // used by parent components for listening to changes to child components
72
- let deferredResolve;
73
- this._domRefReadyPromise = new Promise(resolve => {
74
- deferredResolve = resolve;
75
- });
76
- this._domRefReadyPromise._deferredResolve = deferredResolve;
77
-
78
- this._initializeState();
79
- this._upgradeAllProperties();
80
-
81
- if (this.constructor._needsShadowDOM()) {
82
- this.attachShadow({ mode: "open" });
83
- }
84
- }
85
-
86
- /**
87
- * Returns a unique ID for this UI5 Element
88
- *
89
- * @deprecated - This property is not guaranteed in future releases
90
- * @protected
91
- */
92
- get _id() {
93
- if (!this.__id) {
94
- this.__id = `ui5wc_${++autoId}`;
95
- }
96
-
97
- return this.__id;
98
- }
99
-
100
- /**
101
- * Do not call this method from derivatives of UI5Element, use "onEnterDOM" only
102
- * @private
103
- */
104
- async connectedCallback() {
105
- this.setAttribute(this.constructor.getMetadata().getPureTag(), "");
106
- if (this.constructor.getMetadata().supportsF6FastNavigation()) {
107
- this.setAttribute("data-sap-ui-fastnavgroup", "true");
108
- }
109
-
110
- const slotsAreManaged = this.constructor.getMetadata().slotsAreManaged();
111
-
112
- this._inDOM = true;
113
-
114
- if (slotsAreManaged) {
115
- // always register the observer before yielding control to the main thread (await)
116
- this._startObservingDOMChildren();
117
- await this._processChildren();
118
- }
119
-
120
- if (!this._inDOM) { // Component removed from DOM while _processChildren was running
121
- return;
122
- }
123
-
124
- renderImmediately(this);
125
- this._domRefReadyPromise._deferredResolve();
126
- this._fullyConnected = true;
127
- if (typeof this.onEnterDOM === "function") {
128
- this.onEnterDOM();
129
- }
130
- }
131
-
132
- /**
133
- * Do not call this method from derivatives of UI5Element, use "onExitDOM" only
134
- * @private
135
- */
136
- disconnectedCallback() {
137
- const slotsAreManaged = this.constructor.getMetadata().slotsAreManaged();
138
-
139
- this._inDOM = false;
140
-
141
- if (slotsAreManaged) {
142
- this._stopObservingDOMChildren();
143
- }
144
-
145
- if (this._fullyConnected) {
146
- if (typeof this.onExitDOM === "function") {
147
- this.onExitDOM();
148
- }
149
- this._fullyConnected = false;
150
- }
151
-
152
- if (this.staticAreaItem && this.staticAreaItem.parentElement) {
153
- this.staticAreaItem.parentElement.removeChild(this.staticAreaItem);
154
- }
155
-
156
- cancelRender(this);
157
- }
158
-
159
- /**
160
- * @private
161
- */
162
- _startObservingDOMChildren() {
163
- const shouldObserveChildren = this.constructor.getMetadata().hasSlots();
164
- if (!shouldObserveChildren) {
165
- return;
166
- }
167
-
168
- const canSlotText = this.constructor.getMetadata().canSlotText();
169
- const mutationObserverOptions = {
170
- childList: true,
171
- subtree: canSlotText,
172
- characterData: canSlotText,
173
- };
174
- observeDOMNode(this, this._processChildren.bind(this), mutationObserverOptions);
175
- }
176
-
177
- /**
178
- * @private
179
- */
180
- _stopObservingDOMChildren() {
181
- unobserveDOMNode(this);
182
- }
183
-
184
- /**
185
- * Note: this method is also manually called by "compatibility/patchNodeValue.js"
186
- * @private
187
- */
188
- async _processChildren() {
189
- const hasSlots = this.constructor.getMetadata().hasSlots();
190
- if (hasSlots) {
191
- await this._updateSlots();
192
- }
193
- }
194
-
195
- /**
196
- * @private
197
- */
198
- async _updateSlots() {
199
- const slotsMap = this.constructor.getMetadata().getSlots();
200
- const canSlotText = this.constructor.getMetadata().canSlotText();
201
- const domChildren = Array.from(canSlotText ? this.childNodes : this.children);
202
-
203
- const slotsCachedContentMap = new Map(); // Store here the content of each slot before the mutation occurred
204
- const propertyNameToSlotMap = new Map(); // Used for reverse lookup to determine to which slot the property name corresponds
205
-
206
- // Init the _state object based on the supported slots and store the previous values
207
- for (const [slotName, slotData] of Object.entries(slotsMap)) { // eslint-disable-line
208
- const propertyName = slotData.propertyName || slotName;
209
- propertyNameToSlotMap.set(propertyName, slotName);
210
- slotsCachedContentMap.set(propertyName, [...this._state[propertyName]]);
211
- this._clearSlot(slotName, slotData);
212
- }
213
-
214
- const autoIncrementMap = new Map();
215
- const slottedChildrenMap = new Map();
216
-
217
- const allChildrenUpgraded = domChildren.map(async (child, idx) => {
218
- // Determine the type of the child (mainly by the slot attribute)
219
- const slotName = getSlotName(child);
220
- const slotData = slotsMap[slotName];
221
-
222
- // Check if the slotName is supported
223
- if (slotData === undefined) {
224
- const validValues = Object.keys(slotsMap).join(", ");
225
- console.warn(`Unknown slotName: ${slotName}, ignoring`, child, `Valid values are: ${validValues}`); // eslint-disable-line
226
- return;
227
- }
228
-
229
- // For children that need individual slots, calculate them
230
- if (slotData.individualSlots) {
231
- const nextIndex = (autoIncrementMap.get(slotName) || 0) + 1;
232
- autoIncrementMap.set(slotName, nextIndex);
233
- child._individualSlot = `${slotName}-${nextIndex}`;
234
- }
235
-
236
- // Await for not-yet-defined custom elements
237
- if (child instanceof HTMLElement) {
238
- const localName = child.localName;
239
- const isCustomElement = localName.includes("-");
240
- if (isCustomElement) {
241
- const isDefined = window.customElements.get(localName);
242
- if (!isDefined) {
243
- const whenDefinedPromise = window.customElements.whenDefined(localName); // Class registered, but instances not upgraded yet
244
- let timeoutPromise = elementTimeouts.get(localName);
245
- if (!timeoutPromise) {
246
- timeoutPromise = new Promise(resolve => setTimeout(resolve, 1000));
247
- elementTimeouts.set(localName, timeoutPromise);
248
- }
249
- await Promise.race([whenDefinedPromise, timeoutPromise]);
250
- }
251
- window.customElements.upgrade(child);
252
- }
253
- }
254
-
255
- child = this.constructor.getMetadata().constructor.validateSlotValue(child, slotData);
256
-
257
- // Listen for any invalidation on the child if invalidateOnChildChange is true or an object (ignore when false or not set)
258
- if (child.isUI5Element && slotData.invalidateOnChildChange) {
259
- const method = (child.attachInvalidate || child._attachChange).bind(child);
260
- method(this._getChildChangeListener(slotName));
261
- }
262
-
263
- // Listen for the slotchange event if the child is a slot itself
264
- if (isSlot(child)) {
265
- this._attachSlotChange(child, slotName);
266
- }
267
-
268
- const propertyName = slotData.propertyName || slotName;
269
-
270
- if (slottedChildrenMap.has(propertyName)) {
271
- slottedChildrenMap.get(propertyName).push({ child, idx });
272
- } else {
273
- slottedChildrenMap.set(propertyName, [{ child, idx }]);
274
- }
275
- });
276
-
277
- await Promise.all(allChildrenUpgraded);
278
-
279
- // Distribute the child in the _state object, keeping the Light DOM order,
280
- // not the order elements are defined.
281
- slottedChildrenMap.forEach((children, propertyName) => {
282
- this._state[propertyName] = children.sort((a, b) => a.idx - b.idx).map(_ => _.child);
283
- });
284
-
285
- // Compare the content of each slot with the cached values and invalidate for the ones that changed
286
- let invalidated = false;
287
- for (const [slotName, slotData] of Object.entries(slotsMap)) { // eslint-disable-line
288
- const propertyName = slotData.propertyName || slotName;
289
- if (!arraysAreEqual(slotsCachedContentMap.get(propertyName), this._state[propertyName])) {
290
- _invalidate.call(this, {
291
- type: "slot",
292
- name: propertyNameToSlotMap.get(propertyName),
293
- reason: "children",
294
- });
295
- invalidated = true;
296
- }
297
- }
298
-
299
- // If none of the slots had an invalidation due to changes to immediate children,
300
- // the change is considered to be text content of the default slot
301
- if (!invalidated) {
302
- _invalidate.call(this, {
303
- type: "slot",
304
- name: "default",
305
- reason: "textcontent",
306
- });
307
- }
308
- }
309
-
310
- /**
311
- * Removes all children from the slot and detaches listeners, if any
312
- * @private
313
- */
314
- _clearSlot(slotName, slotData) {
315
- const propertyName = slotData.propertyName || slotName;
316
- const children = this._state[propertyName];
317
-
318
- children.forEach(child => {
319
- if (child && child.isUI5Element) {
320
- const method = (child.detachInvalidate || child._detachChange).bind(child);
321
- method(this._getChildChangeListener(slotName));
322
- }
323
-
324
- if (isSlot(child)) {
325
- this._detachSlotChange(child, slotName);
326
- }
327
- });
328
-
329
- this._state[propertyName] = [];
330
- }
331
-
332
- /**
333
- * Attach a callback that will be executed whenever the component is invalidated
334
- *
335
- * @param callback
336
- * @public
337
- */
338
- attachInvalidate(callback) {
339
- this._eventProvider.attachEvent("invalidate", callback);
340
- }
341
-
342
- /**
343
- * Detach the callback that is executed whenever the component is invalidated
344
- *
345
- * @param callback
346
- * @public
347
- */
348
- detachInvalidate(callback) {
349
- this._eventProvider.detachEvent("invalidate", callback);
350
- }
351
-
352
- /**
353
- * Callback that is executed whenever a monitored child changes its state
354
- *
355
- * @param slotName the slot in which a child was invalidated
356
- * @param childChangeInfo the changeInfo object for the child in the given slot
357
- * @private
358
- */
359
- _onChildChange(slotName, childChangeInfo) {
360
- if (!this.constructor.getMetadata().shouldInvalidateOnChildChange(slotName, childChangeInfo.type, childChangeInfo.name)) {
361
- return;
362
- }
363
-
364
- // The component should be invalidated as this type of change on the child is listened for
365
- // However, no matter what changed on the child (property/slot), the invalidation is registered as "type=slot" for the component itself
366
- _invalidate.call(this, {
367
- type: "slot",
368
- name: slotName,
369
- reason: "childchange",
370
- child: childChangeInfo.target,
371
- });
372
- }
373
-
374
- /**
375
- * Do not override this method in derivatives of UI5Element
376
- * @private
377
- */
378
- attributeChangedCallback(name, oldValue, newValue) {
379
- const properties = this.constructor.getMetadata().getProperties();
380
- const realName = name.replace(/^ui5-/, "");
381
- const nameInCamelCase = kebabToCamelCase(realName);
382
- if (properties.hasOwnProperty(nameInCamelCase)) { // eslint-disable-line
383
- const propertyTypeClass = properties[nameInCamelCase].type;
384
- if (propertyTypeClass === Boolean) {
385
- newValue = newValue !== null;
386
- } else if (isDescendantOf(propertyTypeClass, DataType)) {
387
- newValue = propertyTypeClass.attributeToProperty(newValue);
388
- }
389
- this[nameInCamelCase] = newValue;
390
- }
391
- }
392
-
393
- /**
394
- * @private
395
- */
396
- _updateAttribute(name, newValue) {
397
- if (!this.constructor.getMetadata().hasAttribute(name)) {
398
- return;
399
- }
400
- const properties = this.constructor.getMetadata().getProperties();
401
- const propertyTypeClass = properties[name].type;
402
- const attrName = camelToKebabCase(name);
403
- const attrValue = this.getAttribute(attrName);
404
-
405
- if (propertyTypeClass === Boolean) {
406
- if (newValue === true && attrValue === null) {
407
- this.setAttribute(attrName, "");
408
- } else if (newValue === false && attrValue !== null) {
409
- this.removeAttribute(attrName);
410
- }
411
- } else if (isDescendantOf(propertyTypeClass, DataType)) {
412
- this.setAttribute(attrName, propertyTypeClass.propertyToAttribute(newValue));
413
- } else if (typeof newValue !== "object") {
414
- if (attrValue !== newValue) {
415
- this.setAttribute(attrName, newValue);
416
- }
417
- } // else { return; } // old object handling
418
- }
419
-
420
- /**
421
- * @private
422
- */
423
- _upgradeProperty(prop) {
424
- if (this.hasOwnProperty(prop)) { // eslint-disable-line
425
- const value = this[prop];
426
- delete this[prop];
427
- this[prop] = value;
428
- }
429
- }
430
-
431
- /**
432
- * @private
433
- */
434
- _upgradeAllProperties() {
435
- const allProps = this.constructor.getMetadata().getPropertiesList();
436
- allProps.forEach(this._upgradeProperty, this);
437
- }
438
-
439
- /**
440
- * @private
441
- */
442
- _initializeState() {
443
- this._state = { ...this.constructor.getMetadata().getInitialState() };
444
- }
445
-
446
- /**
447
- * Returns a singleton event listener for the "change" event of a child in a given slot
448
- *
449
- * @param slotName the name of the slot, where the child is
450
- * @returns {any}
451
- * @private
452
- */
453
- _getChildChangeListener(slotName) {
454
- if (!this._childChangeListeners.has(slotName)) {
455
- this._childChangeListeners.set(slotName, this._onChildChange.bind(this, slotName));
456
- }
457
- return this._childChangeListeners.get(slotName);
458
- }
459
-
460
- /**
461
- * Returns a singleton slotchange event listener that invalidates the component due to changes in the given slot
462
- *
463
- * @param slotName the name of the slot, where the slot element (whose slotchange event we're listening to) is
464
- * @returns {any}
465
- * @private
466
- */
467
- _getSlotChangeListener(slotName) {
468
- if (!this._slotChangeListeners.has(slotName)) {
469
- this._slotChangeListeners.set(slotName, this._onSlotChange.bind(this, slotName));
470
- }
471
- return this._slotChangeListeners.get(slotName);
472
- }
473
-
474
- /**
475
- * @private
476
- */
477
- _attachSlotChange(child, slotName) {
478
- child.addEventListener("slotchange", this._getSlotChangeListener(slotName));
479
- }
480
-
481
- /**
482
- * @private
483
- */
484
- _detachSlotChange(child, slotName) {
485
- child.removeEventListener("slotchange", this._getSlotChangeListener(slotName));
486
- }
487
-
488
- /**
489
- * Whenever a slot element is slotted inside a UI5 Web Component, its slotchange event invalidates the component
490
- *
491
- * @param slotName the name of the slot, where the slot element (whose slotchange event we're listening to) is
492
- * @private
493
- */
494
- _onSlotChange(slotName) {
495
- _invalidate.call(this, {
496
- type: "slot",
497
- name: slotName,
498
- reason: "slotchange",
499
- });
500
- }
501
-
502
- /**
503
- * A callback that is executed each time an already rendered component is invalidated (scheduled for re-rendering)
504
- *
505
- * @param changeInfo An object with information about the change that caused invalidation.
506
- * The object can have the following properties:
507
- * - type: (property|slot) tells what caused the invalidation
508
- * 1) property: a property value was changed either directly or as a result of changing the corresponding attribute
509
- * 2) slot: a slotted node(nodes) changed in one of several ways (see "reason")
510
- *
511
- * - name: the name of the property or slot that caused the invalidation
512
- *
513
- * - reason: (children|textcontent|childchange|slotchange) relevant only for type="slot" only and tells exactly what changed in the slot
514
- * 1) children: immediate children (HTML elements or text nodes) were added, removed or reordered in the slot
515
- * 2) textcontent: text nodes in the slot changed value (or nested text nodes were added or changed value). Can only trigger for slots of "type: Node"
516
- * 3) slotchange: a slot element, slotted inside that slot had its "slotchange" event listener called. This practically means that transitively slotted children changed.
517
- * Can only trigger if the child of a slot is a slot element itself.
518
- * 4) childchange: indicates that a UI5Element child in that slot was invalidated and in turn invalidated the component.
519
- * Can only trigger for slots with "invalidateOnChildChange" metadata descriptor
520
- *
521
- * - newValue: the new value of the property (for type="property" only)
522
- *
523
- * - oldValue: the old value of the property (for type="property" only)
524
- *
525
- * - child the child that was changed (for type="slot" and reason="childchange" only)
526
- *
527
- * @public
528
- */
529
- onInvalidation(changeInfo) {}
530
-
531
- /**
532
- * Do not call this method directly, only intended to be called by js
533
- * @protected
534
- */
535
- _render() {
536
- const hasIndividualSlots = this.constructor.getMetadata().hasIndividualSlots();
537
-
538
- // suppress invalidation to prevent state changes scheduling another rendering
539
- this._suppressInvalidation = true;
540
-
541
- if (typeof this.onBeforeRendering === "function") {
542
- this.onBeforeRendering();
543
- }
544
-
545
- // Intended for framework usage only. Currently ItemNavigation updates tab indexes after the component has updated its state but before the template is rendered
546
- if (this._onComponentStateFinalized) {
547
- this._onComponentStateFinalized();
548
- }
549
-
550
- // resume normal invalidation handling
551
- this._suppressInvalidation = false;
552
-
553
- // Update the shadow root with the render result
554
- /*
555
- if (this._changedState.length) {
556
- let element = this.localName;
557
- if (this.id) {
558
- element = `${element}#${this.id}`;
559
- }
560
- console.log("Re-rendering:", element, this._changedState.map(x => { // eslint-disable-line
561
- let res = `${x.type}`;
562
- if (x.reason) {
563
- res = `${res}(${x.reason})`;
564
- }
565
- res = `${res}: ${x.name}`;
566
- if (x.type === "property") {
567
- res = `${res} ${x.oldValue} => ${x.newValue}`;
568
- }
569
-
570
- return res;
571
- }));
572
- }
573
- */
574
- this._changedState = [];
575
-
576
- // Update shadow root and static area item
577
- if (this.constructor._needsShadowDOM()) {
578
- updateShadowRoot(this);
579
- }
580
- if (this.staticAreaItem) {
581
- this.staticAreaItem.update();
582
- }
583
-
584
- // Safari requires that children get the slot attribute only after the slot tags have been rendered in the shadow DOM
585
- if (hasIndividualSlots) {
586
- this._assignIndividualSlotsToChildren();
587
- }
588
-
589
- // Call the onAfterRendering hook
590
- if (typeof this.onAfterRendering === "function") {
591
- this.onAfterRendering();
592
- }
593
- }
594
-
595
- /**
596
- * @private
597
- */
598
- _assignIndividualSlotsToChildren() {
599
- const domChildren = Array.from(this.children);
600
-
601
- domChildren.forEach(child => {
602
- if (child._individualSlot) {
603
- child.setAttribute("slot", child._individualSlot);
604
- }
605
- });
606
- }
607
-
608
- /**
609
- * @private
610
- */
611
- _waitForDomRef() {
612
- return this._domRefReadyPromise;
613
- }
614
-
615
- /**
616
- * Returns the DOM Element inside the Shadow Root that corresponds to the opening tag in the UI5 Web Component's template
617
- * *Note:* For logical (abstract) elements (items, options, etc...), returns the part of the parent's DOM that represents this option
618
- * Use this method instead of "this.shadowRoot" to read the Shadow DOM, if ever necessary
619
- *
620
- * @public
621
- */
622
- getDomRef() {
623
- // If a component set _getRealDomRef to its children, use the return value of this function
624
- if (typeof this._getRealDomRef === "function") {
625
- return this._getRealDomRef();
626
- }
627
-
628
- if (!this.shadowRoot || this.shadowRoot.children.length === 0) {
629
- return;
630
- }
631
-
632
- const children = [...this.shadowRoot.children].filter(child => !["link", "style"].includes(child.localName));
633
- if (children.length !== 1) {
634
- console.warn(`The shadow DOM for ${this.constructor.getMetadata().getTag()} does not have a top level element, the getDomRef() method might not work as expected`); // eslint-disable-line
635
- }
636
-
637
- return children[0];
638
- }
639
-
640
- /**
641
- * Returns the DOM Element marked with "data-sap-focus-ref" inside the template.
642
- * This is the element that will receive the focus by default.
643
- * @public
644
- */
645
- getFocusDomRef() {
646
- const domRef = this.getDomRef();
647
- if (domRef) {
648
- const focusRef = domRef.querySelector("[data-sap-focus-ref]");
649
- return focusRef || domRef;
650
- }
651
- }
652
-
653
- /**
654
- * Waits for dom ref and then returns the DOM Element marked with "data-sap-focus-ref" inside the template.
655
- * This is the element that will receive the focus by default.
656
- * @public
657
- */
658
- async getFocusDomRefAsync() {
659
- await this._waitForDomRef();
660
- return this.getFocusDomRef();
661
- }
662
-
663
- /**
664
- * Set the focus to the element, returned by "getFocusDomRef()" (marked by "data-sap-focus-ref")
665
- * @public
666
- */
667
- async focus() {
668
- await this._waitForDomRef();
669
-
670
- const focusDomRef = this.getFocusDomRef();
671
-
672
- if (focusDomRef && typeof focusDomRef.focus === "function") {
673
- focusDomRef.focus();
674
- }
675
- }
676
-
677
- /**
678
- *
679
- * @public
680
- * @param name - name of the event
681
- * @param data - additional data for the event
682
- * @param cancelable - true, if the user can call preventDefault on the event object
683
- * @param bubbles - true, if the event bubbles
684
- * @returns {boolean} false, if the event was cancelled (preventDefault called), true otherwise
685
- */
686
- fireEvent(name, data, cancelable = false, bubbles = true) {
687
- const eventResult = this._fireEvent(name, data, cancelable, bubbles);
688
- const camelCaseEventName = kebabToCamelCase(name);
689
-
690
- if (camelCaseEventName !== name) {
691
- return eventResult && this._fireEvent(camelCaseEventName, data, cancelable);
692
- }
693
-
694
- return eventResult;
695
- }
696
-
697
- _fireEvent(name, data, cancelable = false, bubbles = true) {
698
- const noConflictEvent = new CustomEvent(`ui5-${name}`, {
699
- detail: data,
700
- composed: false,
701
- bubbles,
702
- cancelable,
703
- });
704
-
705
- // This will be false if the no-conflict event is prevented
706
- const noConflictEventResult = this.dispatchEvent(noConflictEvent);
707
-
708
- if (skipOriginalEvent(name)) {
709
- return noConflictEventResult;
710
- }
711
-
712
- const normalEvent = new CustomEvent(name, {
713
- detail: data,
714
- composed: false,
715
- bubbles,
716
- cancelable,
717
- });
718
-
719
- // This will be false if the normal event is prevented
720
- const normalEventResult = this.dispatchEvent(normalEvent);
721
-
722
- // Return false if any of the two events was prevented (its result was false).
723
- return normalEventResult && noConflictEventResult;
724
- }
725
-
726
- /**
727
- * Returns the actual children, associated with a slot.
728
- * Useful when there are transitive slots in nested component scenarios and you don't want to get a list of the slots, but rather of their content.
729
- * @public
730
- */
731
- getSlottedNodes(slotName) {
732
- return getSlottedElementsList(this[slotName]);
733
- }
734
-
735
- /**
736
- * Determines whether the component should be rendered in RTL mode or not.
737
- * Returns: "rtl", "ltr" or undefined
738
- *
739
- * @public
740
- * @returns {String|undefined}
741
- */
742
- get effectiveDir() {
743
- markAsRtlAware(this.constructor); // if a UI5 Element calls this method, it's considered to be rtl-aware
744
- return getEffectiveDir(this);
745
- }
746
-
747
- /**
748
- * Used to duck-type UI5 elements without using instanceof
749
- * @returns {boolean}
750
- * @public
751
- */
752
- get isUI5Element() {
753
- return true;
754
- }
755
-
756
- /**
757
- * Do not override this method in derivatives of UI5Element, use metadata properties instead
758
- * @private
759
- */
760
- static get observedAttributes() {
761
- return this.getMetadata().getAttributesList();
762
- }
763
-
764
- /**
765
- * @private
766
- */
767
- static _needsShadowDOM() {
768
- return !!this.template;
769
- }
770
-
771
- /**
772
- * @private
773
- */
774
- static _needsStaticArea() {
775
- return !!this.staticAreaTemplate;
776
- }
777
-
778
- /**
779
- * @public
780
- */
781
- getStaticAreaItemDomRef() {
782
- if (!this.constructor._needsStaticArea()) {
783
- throw new Error("This component does not use the static area");
784
- }
785
-
786
- if (!this.staticAreaItem) {
787
- this.staticAreaItem = StaticAreaItem.createInstance();
788
- this.staticAreaItem.setOwnerElement(this);
789
- }
790
- if (!this.staticAreaItem.parentElement) {
791
- getSingletonElementInstance("ui5-static-area").appendChild(this.staticAreaItem);
792
- }
793
-
794
- return this.staticAreaItem.getDomRef();
795
- }
796
-
797
- /**
798
- * @private
799
- */
800
- static _generateAccessors() {
801
- const proto = this.prototype;
802
- const slotsAreManaged = this.getMetadata().slotsAreManaged();
803
-
804
- // Properties
805
- const properties = this.getMetadata().getProperties();
806
- for (const [prop, propData] of Object.entries(properties)) { // eslint-disable-line
807
- if (!isValidPropertyName(prop)) {
808
- console.warn(`"${prop}" is not a valid property name. Use a name that does not collide with DOM APIs`); /* eslint-disable-line */
809
- }
810
-
811
- if (propData.type === Boolean && propData.defaultValue) {
812
- throw new Error(`Cannot set a default value for property "${prop}". All booleans are false by default.`);
813
- }
814
-
815
- if (propData.type === Array) {
816
- throw new Error(`Wrong type for property "${prop}". Properties cannot be of type Array - use "multiple: true" and set "type" to the single value type, such as "String", "Object", etc...`);
817
- }
818
-
819
- if (propData.type === Object && propData.defaultValue) {
820
- throw new Error(`Cannot set a default value for property "${prop}". All properties of type "Object" are empty objects by default.`);
821
- }
822
-
823
- if (propData.multiple && propData.defaultValue) {
824
- throw new Error(`Cannot set a default value for property "${prop}". All multiple properties are empty arrays by default.`);
825
- }
826
-
827
- Object.defineProperty(proto, prop, {
828
- get() {
829
- if (this._state[prop] !== undefined) {
830
- return this._state[prop];
831
- }
832
-
833
- const propDefaultValue = propData.defaultValue;
834
-
835
- if (propData.type === Boolean) {
836
- return false;
837
- } else if (propData.type === String) { // eslint-disable-line
838
- return propDefaultValue;
839
- } else if (propData.multiple) { // eslint-disable-line
840
- return [];
841
- } else {
842
- return propDefaultValue;
843
- }
844
- },
845
- set(value) {
846
- let isDifferent;
847
- value = this.constructor.getMetadata().constructor.validatePropertyValue(value, propData);
848
-
849
- const oldState = this._state[prop];
850
- if (propData.multiple && propData.compareValues) {
851
- isDifferent = !arraysAreEqual(oldState, value);
852
- } else if (isDescendantOf(propData.type, DataType)) {
853
- isDifferent = !propData.type.valuesAreEqual(oldState, value);
854
- } else {
855
- isDifferent = oldState !== value;
856
- }
857
-
858
- if (isDifferent) {
859
- this._state[prop] = value;
860
- _invalidate.call(this, {
861
- type: "property",
862
- name: prop,
863
- newValue: value,
864
- oldValue: oldState,
865
- });
866
- this._updateAttribute(prop, value);
867
- }
868
- },
869
- });
870
- }
871
-
872
- // Slots
873
- if (slotsAreManaged) {
874
- const slots = this.getMetadata().getSlots();
875
- for (const [slotName, slotData] of Object.entries(slots)) { // eslint-disable-line
876
- if (!isValidPropertyName(slotName)) {
877
- console.warn(`"${slotName}" is not a valid property name. Use a name that does not collide with DOM APIs`); /* eslint-disable-line */
878
- }
879
-
880
- const propertyName = slotData.propertyName || slotName;
881
- Object.defineProperty(proto, propertyName, {
882
- get() {
883
- if (this._state[propertyName] !== undefined) {
884
- return this._state[propertyName];
885
- }
886
- return [];
887
- },
888
- set() {
889
- throw new Error("Cannot set slot content directly, use the DOM APIs (appendChild, removeChild, etc...)");
890
- },
891
- });
892
- }
893
- }
894
- }
895
-
896
- /**
897
- * Returns the metadata object for this UI5 Web Component Class
898
- * @protected
899
- */
900
- static get metadata() {
901
- return metadata;
902
- }
903
-
904
- /**
905
- * Sets a new metadata object for this UI5 Web Component Class
906
- * @protected
907
- */
908
- static set metadata(newMetadata) {
909
- metadata = newMetadata;
910
- }
911
-
912
- /**
913
- * Returns the CSS for this UI5 Web Component Class
914
- * @protected
915
- */
916
- static get styles() {
917
- return "";
918
- }
919
-
920
- /**
921
- * Returns the Static Area CSS for this UI5 Web Component Class
922
- * @protected
923
- */
924
- static get staticAreaStyles() {
925
- return "";
926
- }
927
-
928
- /**
929
- * Returns an array with the dependencies for this UI5 Web Component, which could be:
930
- * - composed components (used in its shadow root or static area item)
931
- * - slotted components that the component may need to communicate with
932
- *
933
- * @protected
934
- */
935
- static get dependencies() {
936
- return [];
937
- }
938
-
939
- /**
940
- * Returns a list of the unique dependencies for this UI5 Web Component
941
- *
942
- * @public
943
- */
944
- static getUniqueDependencies() {
945
- if (!uniqueDependenciesCache.has(this)) {
946
- const filtered = this.dependencies.filter((dep, index, deps) => deps.indexOf(dep) === index);
947
- uniqueDependenciesCache.set(this, filtered);
948
- }
949
-
950
- return uniqueDependenciesCache.get(this);
951
- }
952
-
953
- /**
954
- * Returns a promise that resolves whenever all dependencies for this UI5 Web Component have resolved
955
- *
956
- * @returns {Promise<any[]>}
957
- */
958
- static whenDependenciesDefined() {
959
- return Promise.all(this.getUniqueDependencies().map(dep => dep.define()));
960
- }
961
-
962
- /**
963
- * Hook that will be called upon custom element definition
964
- *
965
- * @protected
966
- * @returns {Promise<void>}
967
- */
968
- static async onDefine() {
969
- return Promise.resolve();
970
- }
971
-
972
- /**
973
- * Registers a UI5 Web Component in the browser window object
974
- * @public
975
- * @returns {Promise<UI5Element>}
976
- */
977
- static async define() {
978
- await boot();
979
-
980
- await Promise.all([
981
- this.whenDependenciesDefined(),
982
- this.onDefine(),
983
- ]);
984
-
985
- const tag = this.getMetadata().getTag();
986
- const altTag = this.getMetadata().getAltTag();
987
-
988
- const definedLocally = isTagRegistered(tag);
989
- const definedGlobally = customElements.get(tag);
990
-
991
- if (definedGlobally && !definedLocally) {
992
- recordTagRegistrationFailure(tag);
993
- } else if (!definedGlobally) {
994
- this._generateAccessors();
995
- registerTag(tag);
996
- window.customElements.define(tag, this);
997
- preloadLinks(this);
998
-
999
- if (altTag && !customElements.get(altTag)) {
1000
- registerTag(altTag);
1001
- window.customElements.define(altTag, getClassCopy(this, () => {
1002
- console.log(`The ${altTag} tag is deprecated and will be removed in the next release, please use ${tag} instead.`); // eslint-disable-line
1003
- }));
1004
- }
1005
- }
1006
- return this;
1007
- }
1008
-
1009
- /**
1010
- * Returns an instance of UI5ElementMetadata.js representing this UI5 Web Component's full metadata (its and its parents')
1011
- * Note: not to be confused with the "get metadata()" method, which returns an object for this class's metadata only
1012
- * @public
1013
- * @returns {UI5ElementMetadata}
1014
- */
1015
- static getMetadata() {
1016
- if (this.hasOwnProperty("_metadata")) { // eslint-disable-line
1017
- return this._metadata;
1018
- }
1019
-
1020
- const metadataObjects = [this.metadata];
1021
- let klass = this; // eslint-disable-line
1022
- while (klass !== UI5Element) {
1023
- klass = Object.getPrototypeOf(klass);
1024
- metadataObjects.unshift(klass.metadata);
1025
- }
1026
- const mergedMetadata = merge({}, ...metadataObjects);
1027
-
1028
- this._metadata = new UI5ElementMetadata(mergedMetadata);
1029
- return this._metadata;
1030
- }
51
+ constructor() {
52
+ super();
53
+ const ctor = this.constructor;
54
+ this._changedState = []; // Filled on each invalidation, cleared on re-render (used for debugging)
55
+ this._suppressInvalidation = true; // A flag telling whether all invalidations should be ignored. Initialized with "true" because a UI5Element can not be invalidated until it is rendered for the first time
56
+ this._inDOM = false; // A flag telling whether the UI5Element is currently in the DOM tree of the document or not
57
+ this._fullyConnected = false; // A flag telling whether the UI5Element's onEnterDOM hook was called (since it's possible to have the element removed from DOM before that)
58
+ this._childChangeListeners = new Map(); // used to store lazy listeners per slot for the child change event of every child inside that slot
59
+ this._slotChangeListeners = new Map(); // used to store lazy listeners per slot for the slotchange event of all slot children inside that slot
60
+ this._eventProvider = new EventProvider(); // used by parent components for listening to changes to child components
61
+ let deferredResolve;
62
+ this._domRefReadyPromise = new Promise(resolve => {
63
+ deferredResolve = resolve;
64
+ });
65
+ this._domRefReadyPromise._deferredResolve = deferredResolve;
66
+ this._doNotSyncAttributes = new Set(); // attributes that are excluded from attributeChangedCallback synchronization
67
+ this._state = { ...ctor.getMetadata().getInitialState() };
68
+ this._upgradeAllProperties();
69
+ if (ctor._needsShadowDOM()) {
70
+ this.attachShadow({ mode: "open" });
71
+ }
72
+ }
73
+ /**
74
+ * Returns a unique ID for this UI5 Element
75
+ *
76
+ * @deprecated - This property is not guaranteed in future releases
77
+ * @protected
78
+ */
79
+ get _id() {
80
+ if (!this.__id) {
81
+ this.__id = `ui5wc_${++autoId}`;
82
+ }
83
+ return this.__id;
84
+ }
85
+ /**
86
+ * Do not call this method from derivatives of UI5Element, use "onEnterDOM" only
87
+ * @private
88
+ */
89
+ async connectedCallback() {
90
+ const ctor = this.constructor;
91
+ this.setAttribute(ctor.getMetadata().getPureTag(), "");
92
+ if (ctor.getMetadata().supportsF6FastNavigation()) {
93
+ this.setAttribute("data-sap-ui-fastnavgroup", "true");
94
+ }
95
+ const slotsAreManaged = ctor.getMetadata().slotsAreManaged();
96
+ this._inDOM = true;
97
+ if (slotsAreManaged) {
98
+ // always register the observer before yielding control to the main thread (await)
99
+ this._startObservingDOMChildren();
100
+ await this._processChildren();
101
+ }
102
+ if (!this._inDOM) { // Component removed from DOM while _processChildren was running
103
+ return;
104
+ }
105
+ renderImmediately(this);
106
+ this._domRefReadyPromise._deferredResolve();
107
+ this._fullyConnected = true;
108
+ this.onEnterDOM();
109
+ }
110
+ /**
111
+ * Do not call this method from derivatives of UI5Element, use "onExitDOM" only
112
+ * @private
113
+ */
114
+ disconnectedCallback() {
115
+ const ctor = this.constructor;
116
+ const slotsAreManaged = ctor.getMetadata().slotsAreManaged();
117
+ this._inDOM = false;
118
+ if (slotsAreManaged) {
119
+ this._stopObservingDOMChildren();
120
+ }
121
+ if (this._fullyConnected) {
122
+ this.onExitDOM();
123
+ this._fullyConnected = false;
124
+ }
125
+ if (this.staticAreaItem && this.staticAreaItem.parentElement) {
126
+ this.staticAreaItem.parentElement.removeChild(this.staticAreaItem);
127
+ }
128
+ cancelRender(this);
129
+ }
130
+ /**
131
+ * Called every time before the component renders.
132
+ * @public
133
+ */
134
+ onBeforeRendering() { }
135
+ /**
136
+ * Called every time after the component renders.
137
+ * @public
138
+ */
139
+ onAfterRendering() { }
140
+ /**
141
+ * Called on connectedCallback - added to the DOM.
142
+ * @public
143
+ */
144
+ onEnterDOM() { }
145
+ /**
146
+ * Called on disconnectedCallback - removed from the DOM.
147
+ * @public
148
+ */
149
+ onExitDOM() { }
150
+ /**
151
+ * @private
152
+ */
153
+ _startObservingDOMChildren() {
154
+ const ctor = this.constructor;
155
+ const shouldObserveChildren = ctor.getMetadata().hasSlots();
156
+ if (!shouldObserveChildren) {
157
+ return;
158
+ }
159
+ const canSlotText = ctor.getMetadata().canSlotText();
160
+ const mutationObserverOptions = {
161
+ childList: true,
162
+ subtree: canSlotText,
163
+ characterData: canSlotText,
164
+ };
165
+ observeDOMNode(this, this._processChildren.bind(this), mutationObserverOptions);
166
+ }
167
+ /**
168
+ * @private
169
+ */
170
+ _stopObservingDOMChildren() {
171
+ unobserveDOMNode(this);
172
+ }
173
+ /**
174
+ * Note: this method is also manually called by "compatibility/patchNodeValue.js"
175
+ * @private
176
+ */
177
+ async _processChildren() {
178
+ const hasSlots = this.constructor.getMetadata().hasSlots();
179
+ if (hasSlots) {
180
+ await this._updateSlots();
181
+ }
182
+ }
183
+ /**
184
+ * @private
185
+ */
186
+ async _updateSlots() {
187
+ const ctor = this.constructor;
188
+ const slotsMap = ctor.getMetadata().getSlots();
189
+ const canSlotText = ctor.getMetadata().canSlotText();
190
+ const domChildren = Array.from(canSlotText ? this.childNodes : this.children);
191
+ const slotsCachedContentMap = new Map(); // Store here the content of each slot before the mutation occurred
192
+ const propertyNameToSlotMap = new Map(); // Used for reverse lookup to determine to which slot the property name corresponds
193
+ // Init the _state object based on the supported slots and store the previous values
194
+ for (const [slotName, slotData] of Object.entries(slotsMap)) { // eslint-disable-line
195
+ const propertyName = slotData.propertyName || slotName;
196
+ propertyNameToSlotMap.set(propertyName, slotName);
197
+ slotsCachedContentMap.set(propertyName, [...this._state[propertyName]]);
198
+ this._clearSlot(slotName, slotData);
199
+ }
200
+ const autoIncrementMap = new Map();
201
+ const slottedChildrenMap = new Map();
202
+ const allChildrenUpgraded = domChildren.map(async (child, idx) => {
203
+ // Determine the type of the child (mainly by the slot attribute)
204
+ const slotName = getSlotName(child);
205
+ const slotData = slotsMap[slotName];
206
+ // Check if the slotName is supported
207
+ if (slotData === undefined) {
208
+ const validValues = Object.keys(slotsMap).join(", ");
209
+ console.warn(`Unknown slotName: ${slotName}, ignoring`, child, `Valid values are: ${validValues}`); // eslint-disable-line
210
+ return;
211
+ }
212
+ // For children that need individual slots, calculate them
213
+ if (slotData.individualSlots) {
214
+ const nextIndex = (autoIncrementMap.get(slotName) || 0) + 1;
215
+ autoIncrementMap.set(slotName, nextIndex);
216
+ child._individualSlot = `${slotName}-${nextIndex}`;
217
+ }
218
+ // Await for not-yet-defined custom elements
219
+ if (child instanceof HTMLElement) {
220
+ const localName = child.localName;
221
+ const isCustomElement = localName.includes("-");
222
+ if (isCustomElement) {
223
+ const isDefined = window.customElements.get(localName);
224
+ if (!isDefined) {
225
+ const whenDefinedPromise = window.customElements.whenDefined(localName); // Class registered, but instances not upgraded yet
226
+ let timeoutPromise = elementTimeouts.get(localName);
227
+ if (!timeoutPromise) {
228
+ timeoutPromise = new Promise(resolve => setTimeout(resolve, 1000));
229
+ elementTimeouts.set(localName, timeoutPromise);
230
+ }
231
+ await Promise.race([whenDefinedPromise, timeoutPromise]);
232
+ }
233
+ window.customElements.upgrade(child);
234
+ }
235
+ }
236
+ child = ctor.getMetadata().constructor.validateSlotValue(child, slotData);
237
+ // Listen for any invalidation on the child if invalidateOnChildChange is true or an object (ignore when false or not set)
238
+ if (instanceOfUI5Element(child) && slotData.invalidateOnChildChange) {
239
+ const childChangeListener = this._getChildChangeListener(slotName);
240
+ if (childChangeListener) {
241
+ child.attachInvalidate.call(child, childChangeListener);
242
+ }
243
+ }
244
+ // Listen for the slotchange event if the child is a slot itself
245
+ if (child instanceof HTMLSlotElement) {
246
+ this._attachSlotChange(child, slotName);
247
+ }
248
+ const propertyName = slotData.propertyName || slotName;
249
+ if (slottedChildrenMap.has(propertyName)) {
250
+ slottedChildrenMap.get(propertyName).push({ child, idx });
251
+ }
252
+ else {
253
+ slottedChildrenMap.set(propertyName, [{ child, idx }]);
254
+ }
255
+ });
256
+ await Promise.all(allChildrenUpgraded);
257
+ // Distribute the child in the _state object, keeping the Light DOM order,
258
+ // not the order elements are defined.
259
+ slottedChildrenMap.forEach((children, propertyName) => {
260
+ this._state[propertyName] = children.sort((a, b) => a.idx - b.idx).map(_ => _.child);
261
+ });
262
+ // Compare the content of each slot with the cached values and invalidate for the ones that changed
263
+ let invalidated = false;
264
+ for (const [slotName, slotData] of Object.entries(slotsMap)) { // eslint-disable-line
265
+ const propertyName = slotData.propertyName || slotName;
266
+ if (!arraysAreEqual(slotsCachedContentMap.get(propertyName), this._state[propertyName])) {
267
+ _invalidate.call(this, {
268
+ type: "slot",
269
+ name: propertyNameToSlotMap.get(propertyName),
270
+ reason: "children",
271
+ });
272
+ invalidated = true;
273
+ }
274
+ }
275
+ // If none of the slots had an invalidation due to changes to immediate children,
276
+ // the change is considered to be text content of the default slot
277
+ if (!invalidated) {
278
+ _invalidate.call(this, {
279
+ type: "slot",
280
+ name: "default",
281
+ reason: "textcontent",
282
+ });
283
+ }
284
+ }
285
+ /**
286
+ * Removes all children from the slot and detaches listeners, if any
287
+ * @private
288
+ */
289
+ _clearSlot(slotName, slotData) {
290
+ const propertyName = slotData.propertyName || slotName;
291
+ const children = this._state[propertyName];
292
+ children.forEach(child => {
293
+ if (instanceOfUI5Element(child)) {
294
+ const childChangeListener = this._getChildChangeListener(slotName);
295
+ if (childChangeListener) {
296
+ child.detachInvalidate.call(child, childChangeListener);
297
+ }
298
+ }
299
+ if (child instanceof HTMLSlotElement) {
300
+ this._detachSlotChange(child, slotName);
301
+ }
302
+ });
303
+ this._state[propertyName] = [];
304
+ }
305
+ /**
306
+ * Attach a callback that will be executed whenever the component is invalidated
307
+ *
308
+ * @param {InvalidationInfo} callback
309
+ * @public
310
+ */
311
+ attachInvalidate(callback) {
312
+ this._eventProvider.attachEvent("invalidate", callback);
313
+ }
314
+ /**
315
+ * Detach the callback that is executed whenever the component is invalidated
316
+ *
317
+ * @param {InvalidationInfo} callback
318
+ * @public
319
+ */
320
+ detachInvalidate(callback) {
321
+ this._eventProvider.detachEvent("invalidate", callback);
322
+ }
323
+ /**
324
+ * Callback that is executed whenever a monitored child changes its state
325
+ *
326
+ * @param {sting} slotName the slot in which a child was invalidated
327
+ * @param { ChangeInfo } childChangeInfo the changeInfo object for the child in the given slot
328
+ * @private
329
+ */
330
+ _onChildChange(slotName, childChangeInfo) {
331
+ if (!this.constructor.getMetadata().shouldInvalidateOnChildChange(slotName, childChangeInfo.type, childChangeInfo.name)) {
332
+ return;
333
+ }
334
+ // The component should be invalidated as this type of change on the child is listened for
335
+ // However, no matter what changed on the child (property/slot), the invalidation is registered as "type=slot" for the component itself
336
+ _invalidate.call(this, {
337
+ type: "slot",
338
+ name: slotName,
339
+ reason: "childchange",
340
+ child: childChangeInfo.target,
341
+ });
342
+ }
343
+ /**
344
+ * Do not override this method in derivatives of UI5Element
345
+ * @private
346
+ */
347
+ attributeChangedCallback(name, oldValue, newValue) {
348
+ let newPropertyValue;
349
+ if (this._doNotSyncAttributes.has(name)) { // This attribute is mutated internally, not by the user
350
+ return;
351
+ }
352
+ const properties = this.constructor.getMetadata().getProperties();
353
+ const realName = name.replace(/^ui5-/, "");
354
+ const nameInCamelCase = kebabToCamelCase(realName);
355
+ if (properties.hasOwnProperty(nameInCamelCase)) { // eslint-disable-line
356
+ const propertyTypeClass = properties[nameInCamelCase].type;
357
+ if (propertyTypeClass === Boolean) {
358
+ newPropertyValue = newValue !== null;
359
+ }
360
+ else if (propertyTypeClass.isDataTypeClass) {
361
+ newPropertyValue = propertyTypeClass.attributeToProperty(newValue);
362
+ }
363
+ else {
364
+ newPropertyValue = newValue;
365
+ }
366
+ this[nameInCamelCase] = newPropertyValue;
367
+ }
368
+ }
369
+ /**
370
+ * @private
371
+ */
372
+ _updateAttribute(name, newValue) {
373
+ const ctor = this.constructor;
374
+ if (!ctor.getMetadata().hasAttribute(name)) {
375
+ return;
376
+ }
377
+ const properties = ctor.getMetadata().getProperties();
378
+ const propertyTypeClass = properties[name].type;
379
+ const attrName = camelToKebabCase(name);
380
+ const attrValue = this.getAttribute(attrName);
381
+ if (propertyTypeClass === Boolean) {
382
+ if (newValue === true && attrValue === null) {
383
+ this.setAttribute(attrName, "");
384
+ }
385
+ else if (newValue === false && attrValue !== null) {
386
+ this.removeAttribute(attrName);
387
+ }
388
+ }
389
+ else if (propertyTypeClass.isDataTypeClass) {
390
+ const newAttrValue = propertyTypeClass.propertyToAttribute(newValue);
391
+ if (newAttrValue === null) { // null means there must be no attribute for the current value of the property
392
+ this._doNotSyncAttributes.add(attrName); // skip the attributeChangedCallback call for this attribute
393
+ this.removeAttribute(attrName); // remove the attribute safely (will not trigger synchronization to the property value due to the above line)
394
+ this._doNotSyncAttributes.delete(attrName); // enable synchronization again for this attribute
395
+ }
396
+ else {
397
+ this.setAttribute(attrName, newAttrValue);
398
+ }
399
+ }
400
+ else if (typeof newValue !== "object") {
401
+ if (attrValue !== newValue) {
402
+ this.setAttribute(attrName, newValue);
403
+ }
404
+ } // else { return; } // old object handling
405
+ }
406
+ /**
407
+ * @private
408
+ */
409
+ _upgradeProperty(propertyName) {
410
+ if (this.hasOwnProperty(propertyName)) { // eslint-disable-line
411
+ const value = this[propertyName];
412
+ delete this[propertyName];
413
+ this[propertyName] = value;
414
+ }
415
+ }
416
+ /**
417
+ * @private
418
+ */
419
+ _upgradeAllProperties() {
420
+ const allProps = this.constructor.getMetadata().getPropertiesList();
421
+ allProps.forEach(this._upgradeProperty.bind(this));
422
+ }
423
+ /**
424
+ * Returns a singleton event listener for the "change" event of a child in a given slot
425
+ *
426
+ * @param slotName the name of the slot, where the child is
427
+ * @returns {ChildChangeListener}
428
+ * @private
429
+ */
430
+ _getChildChangeListener(slotName) {
431
+ if (!this._childChangeListeners.has(slotName)) {
432
+ this._childChangeListeners.set(slotName, this._onChildChange.bind(this, slotName));
433
+ }
434
+ return this._childChangeListeners.get(slotName);
435
+ }
436
+ /**
437
+ * Returns a singleton slotchange event listener that invalidates the component due to changes in the given slot
438
+ *
439
+ * @param slotName the name of the slot, where the slot element (whose slotchange event we're listening to) is
440
+ * @returns {SlotChangeListener}
441
+ * @private
442
+ */
443
+ _getSlotChangeListener(slotName) {
444
+ if (!this._slotChangeListeners.has(slotName)) {
445
+ this._slotChangeListeners.set(slotName, this._onSlotChange.bind(this, slotName));
446
+ }
447
+ return this._slotChangeListeners.get(slotName);
448
+ }
449
+ /**
450
+ * @private
451
+ */
452
+ _attachSlotChange(child, slotName) {
453
+ const slotChangeListener = this._getSlotChangeListener(slotName);
454
+ if (slotChangeListener) {
455
+ child.addEventListener("slotchange", slotChangeListener);
456
+ }
457
+ }
458
+ /**
459
+ * @private
460
+ */
461
+ _detachSlotChange(child, slotName) {
462
+ child.removeEventListener("slotchange", this._getSlotChangeListener(slotName));
463
+ }
464
+ /**
465
+ * Whenever a slot element is slotted inside a UI5 Web Component, its slotchange event invalidates the component
466
+ *
467
+ * @param slotName the name of the slot, where the slot element (whose slotchange event we're listening to) is
468
+ * @private
469
+ */
470
+ _onSlotChange(slotName) {
471
+ _invalidate.call(this, {
472
+ type: "slot",
473
+ name: slotName,
474
+ reason: "slotchange",
475
+ });
476
+ }
477
+ /**
478
+ * A callback that is executed each time an already rendered component is invalidated (scheduled for re-rendering)
479
+ *
480
+ * @param changeInfo An object with information about the change that caused invalidation.
481
+ * The object can have the following properties:
482
+ * - type: (property|slot) tells what caused the invalidation
483
+ * 1) property: a property value was changed either directly or as a result of changing the corresponding attribute
484
+ * 2) slot: a slotted node(nodes) changed in one of several ways (see "reason")
485
+ *
486
+ * - name: the name of the property or slot that caused the invalidation
487
+ *
488
+ * - reason: (children|textcontent|childchange|slotchange) relevant only for type="slot" only and tells exactly what changed in the slot
489
+ * 1) children: immediate children (HTML elements or text nodes) were added, removed or reordered in the slot
490
+ * 2) textcontent: text nodes in the slot changed value (or nested text nodes were added or changed value). Can only trigger for slots of "type: Node"
491
+ * 3) slotchange: a slot element, slotted inside that slot had its "slotchange" event listener called. This practically means that transitively slotted children changed.
492
+ * Can only trigger if the child of a slot is a slot element itself.
493
+ * 4) childchange: indicates that a UI5Element child in that slot was invalidated and in turn invalidated the component.
494
+ * Can only trigger for slots with "invalidateOnChildChange" metadata descriptor
495
+ *
496
+ * - newValue: the new value of the property (for type="property" only)
497
+ *
498
+ * - oldValue: the old value of the property (for type="property" only)
499
+ *
500
+ * - child the child that was changed (for type="slot" and reason="childchange" only)
501
+ *
502
+ * @public
503
+ */
504
+ onInvalidation(changeInfo) { } // eslint-disable-line
505
+ /**
506
+ * Do not call this method directly, only intended to be called by js
507
+ * @protected
508
+ */
509
+ _render() {
510
+ const ctor = this.constructor;
511
+ const hasIndividualSlots = ctor.getMetadata().hasIndividualSlots();
512
+ // suppress invalidation to prevent state changes scheduling another rendering
513
+ this._suppressInvalidation = true;
514
+ this.onBeforeRendering();
515
+ // Intended for framework usage only. Currently ItemNavigation updates tab indexes after the component has updated its state but before the template is rendered
516
+ if (this._onComponentStateFinalized) {
517
+ this._onComponentStateFinalized();
518
+ }
519
+ // resume normal invalidation handling
520
+ this._suppressInvalidation = false;
521
+ // Update the shadow root with the render result
522
+ /*
523
+ if (this._changedState.length) {
524
+ let element = this.localName;
525
+ if (this.id) {
526
+ element = `${element}#${this.id}`;
527
+ }
528
+ console.log("Re-rendering:", element, this._changedState.map(x => { // eslint-disable-line
529
+ let res = `${x.type}`;
530
+ if (x.reason) {
531
+ res = `${res}(${x.reason})`;
532
+ }
533
+ res = `${res}: ${x.name}`;
534
+ if (x.type === "property") {
535
+ res = `${res} ${x.oldValue} => ${x.newValue}`;
536
+ }
537
+
538
+ return res;
539
+ }));
540
+ }
541
+ */
542
+ this._changedState = [];
543
+ // Update shadow root and static area item
544
+ if (ctor._needsShadowDOM()) {
545
+ updateShadowRoot(this);
546
+ }
547
+ if (this.staticAreaItem) {
548
+ this.staticAreaItem.update();
549
+ }
550
+ // Safari requires that children get the slot attribute only after the slot tags have been rendered in the shadow DOM
551
+ if (hasIndividualSlots) {
552
+ this._assignIndividualSlotsToChildren();
553
+ }
554
+ // Call the onAfterRendering hook
555
+ this.onAfterRendering();
556
+ }
557
+ /**
558
+ * @private
559
+ */
560
+ _assignIndividualSlotsToChildren() {
561
+ const domChildren = Array.from(this.children);
562
+ domChildren.forEach((child) => {
563
+ if (child._individualSlot) {
564
+ child.setAttribute("slot", child._individualSlot);
565
+ }
566
+ });
567
+ }
568
+ /**
569
+ * @private
570
+ */
571
+ _waitForDomRef() {
572
+ return this._domRefReadyPromise;
573
+ }
574
+ /**
575
+ * Returns the DOM Element inside the Shadow Root that corresponds to the opening tag in the UI5 Web Component's template
576
+ * *Note:* For logical (abstract) elements (items, options, etc...), returns the part of the parent's DOM that represents this option
577
+ * Use this method instead of "this.shadowRoot" to read the Shadow DOM, if ever necessary
578
+ *
579
+ * @public
580
+ */
581
+ getDomRef() {
582
+ // If a component set _getRealDomRef to its children, use the return value of this function
583
+ if (typeof this._getRealDomRef === "function") {
584
+ return this._getRealDomRef();
585
+ }
586
+ if (!this.shadowRoot || this.shadowRoot.children.length === 0) {
587
+ return;
588
+ }
589
+ const children = [...this.shadowRoot.children].filter(child => !["link", "style"].includes(child.localName));
590
+ if (children.length !== 1) {
591
+ console.warn(`The shadow DOM for ${this.constructor.getMetadata().getTag()} does not have a top level element, the getDomRef() method might not work as expected`); // eslint-disable-line
592
+ }
593
+ return children[0];
594
+ }
595
+ /**
596
+ * Returns the DOM Element marked with "data-sap-focus-ref" inside the template.
597
+ * This is the element that will receive the focus by default.
598
+ * @public
599
+ */
600
+ getFocusDomRef() {
601
+ const domRef = this.getDomRef();
602
+ if (domRef) {
603
+ const focusRef = domRef.querySelector("[data-sap-focus-ref]");
604
+ return focusRef || domRef;
605
+ }
606
+ }
607
+ /**
608
+ * Waits for dom ref and then returns the DOM Element marked with "data-sap-focus-ref" inside the template.
609
+ * This is the element that will receive the focus by default.
610
+ * @public
611
+ */
612
+ async getFocusDomRefAsync() {
613
+ await this._waitForDomRef();
614
+ return this.getFocusDomRef();
615
+ }
616
+ /**
617
+ * Set the focus to the element, returned by "getFocusDomRef()" (marked by "data-sap-focus-ref")
618
+ * @public
619
+ */
620
+ async focus() {
621
+ await this._waitForDomRef();
622
+ const focusDomRef = this.getFocusDomRef();
623
+ if (focusDomRef && typeof focusDomRef.focus === "function") {
624
+ focusDomRef.focus();
625
+ }
626
+ }
627
+ /**
628
+ *
629
+ * @public
630
+ * @param name - name of the event
631
+ * @param data - additional data for the event
632
+ * @param cancelable - true, if the user can call preventDefault on the event object
633
+ * @param bubbles - true, if the event bubbles
634
+ * @returns {boolean} false, if the event was cancelled (preventDefault called), true otherwise
635
+ */
636
+ fireEvent(name, data, cancelable = false, bubbles = true) {
637
+ const eventResult = this._fireEvent(name, data, cancelable, bubbles);
638
+ const camelCaseEventName = kebabToCamelCase(name);
639
+ if (camelCaseEventName !== name) {
640
+ return eventResult && this._fireEvent(camelCaseEventName, data, cancelable);
641
+ }
642
+ return eventResult;
643
+ }
644
+ _fireEvent(name, data, cancelable = false, bubbles = true) {
645
+ const noConflictEvent = new CustomEvent(`ui5-${name}`, {
646
+ detail: data,
647
+ composed: false,
648
+ bubbles,
649
+ cancelable,
650
+ });
651
+ // This will be false if the no-conflict event is prevented
652
+ const noConflictEventResult = this.dispatchEvent(noConflictEvent);
653
+ if (skipOriginalEvent(name)) {
654
+ return noConflictEventResult;
655
+ }
656
+ const normalEvent = new CustomEvent(name, {
657
+ detail: data,
658
+ composed: false,
659
+ bubbles,
660
+ cancelable,
661
+ });
662
+ // This will be false if the normal event is prevented
663
+ const normalEventResult = this.dispatchEvent(normalEvent);
664
+ // Return false if any of the two events was prevented (its result was false).
665
+ return normalEventResult && noConflictEventResult;
666
+ }
667
+ /**
668
+ * Returns the actual children, associated with a slot.
669
+ * Useful when there are transitive slots in nested component scenarios and you don't want to get a list of the slots, but rather of their content.
670
+ * @public
671
+ */
672
+ getSlottedNodes(slotName) {
673
+ return getSlottedNodesList(this[slotName]);
674
+ }
675
+ /**
676
+ * Determines whether the component should be rendered in RTL mode or not.
677
+ * Returns: "rtl", "ltr" or undefined
678
+ *
679
+ * @public
680
+ * @returns {String|undefined}
681
+ */
682
+ get effectiveDir() {
683
+ markAsRtlAware(this.constructor); // if a UI5 Element calls this method, it's considered to be rtl-aware
684
+ return getEffectiveDir(this);
685
+ }
686
+ /**
687
+ * Used to duck-type UI5 elements without using instanceof
688
+ * @returns {boolean}
689
+ * @public
690
+ */
691
+ get isUI5Element() {
692
+ return true;
693
+ }
694
+ /**
695
+ * Do not override this method in derivatives of UI5Element, use metadata properties instead
696
+ * @private
697
+ */
698
+ static get observedAttributes() {
699
+ return this.getMetadata().getAttributesList();
700
+ }
701
+ /**
702
+ * @private
703
+ */
704
+ static _needsShadowDOM() {
705
+ return !!this.template;
706
+ }
707
+ /**
708
+ * @private
709
+ */
710
+ static _needsStaticArea() {
711
+ return !!this.staticAreaTemplate;
712
+ }
713
+ /**
714
+ * @public
715
+ */
716
+ getStaticAreaItemDomRef() {
717
+ if (!this.constructor._needsStaticArea()) {
718
+ throw new Error("This component does not use the static area");
719
+ }
720
+ if (!this.staticAreaItem) {
721
+ this.staticAreaItem = StaticAreaItem.createInstance();
722
+ this.staticAreaItem.setOwnerElement(this);
723
+ }
724
+ if (!this.staticAreaItem.parentElement) {
725
+ getSingletonElementInstance("ui5-static-area").appendChild(this.staticAreaItem);
726
+ }
727
+ return this.staticAreaItem.getDomRef();
728
+ }
729
+ /**
730
+ * @private
731
+ */
732
+ static _generateAccessors() {
733
+ const proto = this.prototype;
734
+ const slotsAreManaged = this.getMetadata().slotsAreManaged();
735
+ // Properties
736
+ const properties = this.getMetadata().getProperties();
737
+ for (const [prop, propData] of Object.entries(properties)) { // eslint-disable-line
738
+ if (!isValidPropertyName(prop)) {
739
+ console.warn(`"${prop}" is not a valid property name. Use a name that does not collide with DOM APIs`); /* eslint-disable-line */
740
+ }
741
+ if (propData.type === Boolean && propData.defaultValue) {
742
+ throw new Error(`Cannot set a default value for property "${prop}". All booleans are false by default.`);
743
+ }
744
+ if (propData.type === Array) {
745
+ throw new Error(`Wrong type for property "${prop}". Properties cannot be of type Array - use "multiple: true" and set "type" to the single value type, such as "String", "Object", etc...`);
746
+ }
747
+ if (propData.type === Object && propData.defaultValue) {
748
+ throw new Error(`Cannot set a default value for property "${prop}". All properties of type "Object" are empty objects by default.`);
749
+ }
750
+ if (propData.multiple && propData.defaultValue) {
751
+ throw new Error(`Cannot set a default value for property "${prop}". All multiple properties are empty arrays by default.`);
752
+ }
753
+ Object.defineProperty(proto, prop, {
754
+ get() {
755
+ if (this._state[prop] !== undefined) {
756
+ return this._state[prop];
757
+ }
758
+ const propDefaultValue = propData.defaultValue;
759
+ if (propData.type === Boolean) {
760
+ return false;
761
+ }
762
+ else if (propData.type === String) { // eslint-disable-line
763
+ return propDefaultValue;
764
+ }
765
+ else if (propData.multiple) { // eslint-disable-line
766
+ return [];
767
+ }
768
+ else {
769
+ return propDefaultValue;
770
+ }
771
+ },
772
+ set(value) {
773
+ let isDifferent;
774
+ const ctor = this.constructor;
775
+ const metadataCtor = ctor.getMetadata().constructor;
776
+ value = metadataCtor.validatePropertyValue(value, propData);
777
+ const propertyTypeClass = propData.type;
778
+ const oldState = this._state[prop];
779
+ if (Array.isArray(oldState) && Array.isArray(value) && propData.multiple && propData.compareValues) { // compareValues is added for IE, test if needed now
780
+ isDifferent = !arraysAreEqual(oldState, value);
781
+ }
782
+ else if (propertyTypeClass.isDataTypeClass) {
783
+ isDifferent = !propertyTypeClass.valuesAreEqual(oldState, value);
784
+ }
785
+ else {
786
+ isDifferent = oldState !== value;
787
+ }
788
+ if (isDifferent) {
789
+ this._state[prop] = value;
790
+ _invalidate.call(this, {
791
+ type: "property",
792
+ name: prop,
793
+ newValue: value,
794
+ oldValue: oldState,
795
+ });
796
+ this._updateAttribute(prop, value);
797
+ }
798
+ },
799
+ });
800
+ }
801
+ // Slots
802
+ if (slotsAreManaged) {
803
+ const slots = this.getMetadata().getSlots();
804
+ for (const [slotName, slotData] of Object.entries(slots)) { // eslint-disable-line
805
+ if (!isValidPropertyName(slotName)) {
806
+ console.warn(`"${slotName}" is not a valid property name. Use a name that does not collide with DOM APIs`); /* eslint-disable-line */
807
+ }
808
+ const propertyName = slotData.propertyName || slotName;
809
+ Object.defineProperty(proto, propertyName, {
810
+ get() {
811
+ if (this._state[propertyName] !== undefined) {
812
+ return this._state[propertyName];
813
+ }
814
+ return [];
815
+ },
816
+ set() {
817
+ throw new Error("Cannot set slot content directly, use the DOM APIs (appendChild, removeChild, etc...)");
818
+ },
819
+ });
820
+ }
821
+ }
822
+ }
823
+ /**
824
+ * Returns the metadata object for this UI5 Web Component Class
825
+ * @protected
826
+ */
827
+ static get metadata() {
828
+ return metadata;
829
+ }
830
+ /**
831
+ * Sets a new metadata object for this UI5 Web Component Class
832
+ * @protected
833
+ */
834
+ static set metadata(newMetadata) {
835
+ metadata = newMetadata;
836
+ }
837
+ /**
838
+ * Returns the CSS for this UI5 Web Component Class
839
+ * @protected
840
+ */
841
+ static get styles() {
842
+ return "";
843
+ }
844
+ /**
845
+ * Returns the Static Area CSS for this UI5 Web Component Class
846
+ * @protected
847
+ */
848
+ static get staticAreaStyles() {
849
+ return "";
850
+ }
851
+ /**
852
+ * Returns an array with the dependencies for this UI5 Web Component, which could be:
853
+ * - composed components (used in its shadow root or static area item)
854
+ * - slotted components that the component may need to communicate with
855
+ *
856
+ * @protected
857
+ */
858
+ static get dependencies() {
859
+ return [];
860
+ }
861
+ /**
862
+ * Returns a list of the unique dependencies for this UI5 Web Component
863
+ *
864
+ * @public
865
+ */
866
+ static getUniqueDependencies() {
867
+ if (!uniqueDependenciesCache.has(this)) {
868
+ const filtered = this.dependencies.filter((dep, index, deps) => deps.indexOf(dep) === index);
869
+ uniqueDependenciesCache.set(this, filtered);
870
+ }
871
+ return uniqueDependenciesCache.get(this) || [];
872
+ }
873
+ /**
874
+ * Returns a promise that resolves whenever all dependencies for this UI5 Web Component have resolved
875
+ *
876
+ * @returns {Promise}
877
+ */
878
+ static whenDependenciesDefined() {
879
+ return Promise.all(this.getUniqueDependencies().map(dep => dep.define()));
880
+ }
881
+ /**
882
+ * Hook that will be called upon custom element definition
883
+ *
884
+ * @protected
885
+ * @returns {Promise<void>}
886
+ */
887
+ static async onDefine() {
888
+ return Promise.resolve();
889
+ }
890
+ /**
891
+ * Registers a UI5 Web Component in the browser window object
892
+ * @public
893
+ * @returns {Promise<UI5Element>}
894
+ */
895
+ static async define() {
896
+ await boot();
897
+ await Promise.all([
898
+ this.whenDependenciesDefined(),
899
+ this.onDefine(),
900
+ ]);
901
+ const tag = this.getMetadata().getTag();
902
+ const definedLocally = isTagRegistered(tag);
903
+ const definedGlobally = customElements.get(tag);
904
+ if (definedGlobally && !definedLocally) {
905
+ recordTagRegistrationFailure(tag);
906
+ }
907
+ else if (!definedGlobally) {
908
+ this._generateAccessors();
909
+ registerTag(tag);
910
+ window.customElements.define(tag, this);
911
+ preloadLinks(this);
912
+ }
913
+ return this;
914
+ }
915
+ /**
916
+ * Returns an instance of UI5ElementMetadata.js representing this UI5 Web Component's full metadata (its and its parents')
917
+ * Note: not to be confused with the "get metadata()" method, which returns an object for this class's metadata only
918
+ * @public
919
+ * @returns {UI5ElementMetadata}
920
+ */
921
+ static getMetadata() {
922
+ if (this.hasOwnProperty("_metadata")) { // eslint-disable-line
923
+ return this._metadata;
924
+ }
925
+ const metadataObjects = [this.metadata];
926
+ let klass = this; // eslint-disable-line
927
+ while (klass !== UI5Element) {
928
+ klass = Object.getPrototypeOf(klass);
929
+ metadataObjects.unshift(klass.metadata);
930
+ }
931
+ const mergedMetadata = merge({}, ...metadataObjects);
932
+ this._metadata = new UI5ElementMetadata(mergedMetadata);
933
+ return this._metadata;
934
+ }
1031
935
  }
1032
-
936
+ /**
937
+ * Always use duck-typing to cover all runtimes on the page.
938
+ * @returns {boolean}
939
+ */
940
+ const instanceOfUI5Element = (object) => {
941
+ return "isUI5Element" in object;
942
+ };
1033
943
  export default UI5Element;
944
+ export { instanceOfUI5Element };
945
+ //# sourceMappingURL=UI5Element.js.map