@ui5/webcomponents-base 0.0.0-8b66a95c7 → 0.0.0-8c62d34c3

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