@ui5/webcomponents-base 0.0.0-35e2c9666 → 0.0.0-38861c872

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