@ui5/webcomponents-base 0.0.0-4180fe799 → 0.0.0-4738ea0dc

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