@ui5/webcomponents-base 1.9.3 → 1.10.0

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