@ui5/webcomponents-base 0.0.0-fb61e9889 → 0.0.0-fca1107e7

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