@ui5/webcomponents-base 0.0.0-8db0ce01a → 0.0.0-918b4fbe7

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