@ui5/webcomponents-base 0.0.0-db2be6526 → 0.0.0-db622d8a8

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