@ui5/webcomponents-base 0.0.0-e7dd012d7 → 0.0.0-ec448881d
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.
- package/.eslintignore +3 -0
- package/CHANGELOG.md +272 -0
- package/README.md +26 -2
- package/bundle.esm.js +13 -11
- package/dist/AssetRegistry.js +8 -9
- package/dist/Boot.js +59 -0
- package/dist/CSP.js +59 -0
- package/dist/CustomElementsRegistry.js +60 -4
- package/dist/CustomElementsScope.js +20 -98
- package/dist/CustomElementsScopeUtils.js +108 -0
- package/dist/DOMObserver.js +65 -0
- package/dist/Device.js +71 -773
- package/dist/EventProvider.js +30 -26
- package/dist/FeaturesRegistry.js +4 -1
- package/dist/FontFace.js +7 -95
- package/dist/InitialConfiguration.js +37 -21
- package/dist/Keys.js +98 -0
- package/dist/ManagedStyles.js +83 -0
- package/dist/MediaRange.js +109 -0
- package/{src/util/parseProperties.js → dist/PropertiesFileFormat.js} +6 -0
- package/dist/Render.js +175 -0
- package/dist/RenderScheduler.js +16 -138
- package/dist/Runtimes.js +107 -0
- package/dist/StaticArea.js +1 -29
- package/dist/StaticAreaItem.js +58 -65
- package/dist/SystemCSSVars.js +4 -25
- package/dist/UI5Element.js +315 -382
- package/dist/UI5ElementMetadata.js +132 -17
- package/dist/asset-registries/Icons.js +117 -14
- package/dist/asset-registries/Illustrations.js +30 -0
- package/dist/asset-registries/LocaleData.js +97 -68
- package/dist/asset-registries/Themes.js +29 -35
- package/dist/asset-registries/i18n.js +61 -50
- package/dist/assets-meta/IconCollectionsAlias.js +18 -0
- package/dist/config/Icons.js +52 -0
- package/dist/config/Language.js +18 -20
- package/dist/config/Theme.js +25 -0
- package/dist/css/BusyIndicator.css +80 -0
- package/dist/css/FontFace.css +75 -0
- package/dist/css/OverrideFontFace.css +32 -0
- package/dist/css/SystemCSSVars.css +17 -0
- package/dist/delegate/ItemNavigation.js +233 -201
- package/dist/delegate/ResizeHandler.js +78 -37
- package/dist/delegate/ScrollEnablement.js +49 -20
- package/dist/features/F6Navigation.js +106 -0
- package/dist/features/OpenUI5Enablement.js +119 -0
- package/dist/features/OpenUI5Support.js +41 -6
- package/dist/generated/AssetParameters.js +1 -1
- package/dist/generated/VersionInfo.js +10 -0
- package/dist/generated/css/BusyIndicator.css.js +5 -0
- package/dist/generated/css/FontFace.css.js +5 -0
- package/dist/generated/css/OverrideFontFace.css.js +5 -0
- package/dist/generated/css/SystemCSSVars.css.js +5 -0
- package/dist/i18nBundle.js +38 -4
- package/dist/isLegacyBrowser.js +3 -0
- package/dist/locale/applyDirection.js +6 -4
- package/dist/locale/directionChange.js +32 -0
- package/dist/locale/getEffectiveDir.js +28 -0
- package/dist/locale/languageChange.js +1 -1
- package/dist/renderer/LitRenderer.js +39 -18
- package/dist/renderer/directives/style-map.js +72 -0
- package/dist/renderer/executeTemplate.js +19 -2
- package/dist/resources/bundle.esm.js +15 -112
- package/dist/resources/bundle.esm.js.map +1 -1
- package/dist/sap/base/Log.js +241 -0
- package/dist/sap/base/assert.js +8 -0
- package/dist/sap/base/security/URLListValidator.js +148 -0
- package/dist/sap/base/security/encodeCSS.js +14 -0
- package/dist/sap/base/security/encodeXML.js +23 -0
- package/dist/sap/base/security/sanitizeHTML.js +16 -0
- package/dist/sap/base/strings/toHex.js +8 -0
- package/dist/sap/base/util/now.js +7 -0
- package/dist/sap/ui/thirdparty/caja-html-sanitizer.js +3585 -0
- package/dist/test-resources/assets/Themes.js +8 -8
- package/dist/test-resources/elements/Parent.js +6 -2
- package/dist/test-resources/elements/WithStaticArea.js +2 -1
- package/dist/test-resources/pages/AllTestElements.html +3 -3
- package/dist/test-resources/pages/Configuration.html +0 -2
- package/dist/test-resources/pages/ConfigurationScript.html +0 -2
- package/dist/test-resources/pages/i18n.html +2 -9
- package/dist/test-resources/specs/ConfigurationChange.spec.js +10 -8
- package/dist/test-resources/specs/ConfigurationScript.spec.js +25 -23
- package/dist/test-resources/specs/ConfigurationURL.spec.js +65 -17
- package/dist/test-resources/specs/CustomTheme.spec.js +9 -7
- package/dist/test-resources/specs/EventProvider.spec.js +63 -0
- package/dist/test-resources/specs/StaticArea.spec.js +56 -12
- package/dist/test-resources/specs/Theming.spec.js +23 -10
- package/dist/test-resources/specs/UI5ElementInvalidation.js +54 -70
- package/dist/test-resources/specs/UI5ElementLifecycle.js +17 -15
- package/dist/test-resources/specs/UI5ElementListenForChildPropChanges.spec.js +25 -51
- package/dist/test-resources/specs/UI5ElementMetadataExt.js +9 -7
- package/dist/test-resources/specs/UI5ElementPropertyValidation.js +7 -5
- package/dist/test-resources/specs/UI5ElementPropsAndAttrs.spec.js +37 -35
- package/dist/test-resources/specs/UI5ElementShadowDOM.js +10 -8
- package/dist/test-resources/specs/UI5ElementSlots.js +10 -8
- package/dist/theming/CustomStyle.js +25 -5
- package/dist/theming/applyTheme.js +11 -16
- package/dist/theming/getConstructableStyle.js +7 -6
- package/dist/theming/getEffectiveLinksHrefs.js +27 -0
- package/dist/theming/getEffectiveStyle.js +24 -8
- package/dist/theming/getStylesString.js +4 -2
- package/dist/theming/getThemeDesignerTheme.js +25 -5
- package/dist/theming/preloadLinks.js +23 -0
- package/dist/types/CSSColor.js +9 -0
- package/dist/types/CalendarType.js +1 -1
- package/dist/types/DataType.js +13 -1
- package/dist/types/Float.js +4 -0
- package/dist/types/Integer.js +4 -0
- package/dist/types/InvisibleMessageMode.js +30 -0
- package/dist/types/ItemNavigationBehavior.js +2 -7
- package/dist/types/PopupState.js +1 -1
- package/dist/types/ValueState.js +1 -1
- package/dist/updateShadowRoot.js +30 -0
- package/dist/util/AriaLabelHelper.js +4 -4
- package/dist/util/Caret.js +45 -0
- package/dist/util/ColorConversion.js +370 -0
- package/dist/util/FocusableElements.js +22 -9
- package/dist/util/HTMLSanitizer.js +7 -0
- package/dist/util/InvisibleMessage.js +60 -0
- package/dist/util/PopupUtils.js +93 -0
- package/dist/util/SlotsHelper.js +43 -0
- package/dist/util/TabbableElements.js +5 -1
- package/dist/util/arraysAreEqual.js +15 -0
- package/dist/util/clamp.js +12 -0
- package/dist/util/createLinkInHead.js +19 -0
- package/dist/util/debounce.js +17 -0
- package/dist/util/escapeRegex.js +10 -0
- package/dist/util/generateHighlightedMarkup.js +42 -0
- package/dist/util/getActiveElement.js +11 -0
- package/dist/util/getClassCopy.js +10 -0
- package/dist/util/getEffectiveContentDensity.js +5 -0
- package/dist/util/getNormalizedTarget.js +16 -0
- package/dist/util/isElementInView.js +15 -0
- package/dist/util/isNodeHidden.js +1 -1
- package/dist/util/isNodeTabbable.js +4 -4
- package/hash.txt +1 -0
- package/index.js +1 -1
- package/lib/generate-asset-parameters/index.js +8 -5
- package/lib/generate-styles/index.js +26 -0
- package/lib/generate-version-info/index.js +32 -0
- package/package-scripts.js +30 -19
- package/package.json +19 -13
- package/src/AssetRegistry.js +8 -9
- package/src/Boot.js +59 -0
- package/src/CSP.js +59 -0
- package/src/CustomElementsRegistry.js +60 -4
- package/src/CustomElementsScope.js +20 -98
- package/src/CustomElementsScopeUtils.js +108 -0
- package/src/DOMObserver.js +65 -0
- package/src/Device.js +71 -773
- package/src/EventProvider.js +30 -26
- package/src/FeaturesRegistry.js +4 -1
- package/src/FontFace.js +7 -95
- package/src/InitialConfiguration.js +37 -21
- package/src/Keys.js +98 -0
- package/src/ManagedStyles.js +83 -0
- package/src/MediaRange.js +109 -0
- package/{dist/util/parseProperties.js → src/PropertiesFileFormat.js} +6 -0
- package/src/Render.js +175 -0
- package/src/RenderScheduler.js +16 -138
- package/src/Runtimes.js +107 -0
- package/src/StaticArea.js +1 -29
- package/src/StaticAreaItem.js +58 -65
- package/src/SystemCSSVars.js +4 -25
- package/src/UI5Element.js +315 -382
- package/src/UI5ElementMetadata.js +132 -17
- package/src/asset-registries/Icons.js +117 -14
- package/src/asset-registries/Illustrations.js +30 -0
- package/src/asset-registries/LocaleData.js +97 -68
- package/src/asset-registries/Themes.js +29 -35
- package/src/asset-registries/i18n.js +61 -50
- package/src/assets-meta/IconCollectionsAlias.js +18 -0
- package/src/config/Icons.js +52 -0
- package/src/config/Language.js +18 -20
- package/src/config/Theme.js +25 -0
- package/src/css/BusyIndicator.css +80 -0
- package/src/css/FontFace.css +75 -0
- package/src/css/OverrideFontFace.css +32 -0
- package/src/css/SystemCSSVars.css +17 -0
- package/src/delegate/ItemNavigation.js +233 -201
- package/src/delegate/ResizeHandler.js +78 -37
- package/src/delegate/ScrollEnablement.js +49 -20
- package/src/features/F6Navigation.js +106 -0
- package/src/features/OpenUI5Enablement.js +119 -0
- package/src/features/OpenUI5Support.js +41 -6
- package/src/i18nBundle.js +38 -4
- package/src/isLegacyBrowser.js +3 -0
- package/src/locale/applyDirection.js +6 -4
- package/src/locale/directionChange.js +32 -0
- package/src/locale/getEffectiveDir.js +28 -0
- package/src/locale/languageChange.js +1 -1
- package/src/renderer/LitRenderer.js +39 -18
- package/src/renderer/directives/style-map.js +72 -0
- package/src/renderer/executeTemplate.js +19 -2
- package/src/theming/CustomStyle.js +25 -5
- package/src/theming/applyTheme.js +11 -16
- package/src/theming/getConstructableStyle.js +7 -6
- package/src/theming/getEffectiveLinksHrefs.js +27 -0
- package/src/theming/getEffectiveStyle.js +24 -8
- package/src/theming/getStylesString.js +4 -2
- package/src/theming/getThemeDesignerTheme.js +25 -5
- package/src/theming/preloadLinks.js +23 -0
- package/src/types/CSSColor.js +9 -0
- package/src/types/CalendarType.js +1 -1
- package/src/types/DataType.js +13 -1
- package/src/types/Float.js +4 -0
- package/src/types/Integer.js +4 -0
- package/src/types/InvisibleMessageMode.js +30 -0
- package/src/types/ItemNavigationBehavior.js +2 -7
- package/src/types/PopupState.js +1 -1
- package/src/types/ValueState.js +1 -1
- package/src/updateShadowRoot.js +30 -0
- package/src/util/AriaLabelHelper.js +4 -4
- package/src/util/Caret.js +45 -0
- package/src/util/ColorConversion.js +370 -0
- package/src/util/FocusableElements.js +22 -9
- package/src/util/HTMLSanitizer.js +7 -0
- package/src/util/InvisibleMessage.js +60 -0
- package/src/util/PopupUtils.js +93 -0
- package/src/util/SlotsHelper.js +43 -0
- package/src/util/TabbableElements.js +5 -1
- package/src/util/arraysAreEqual.js +15 -0
- package/src/util/clamp.js +12 -0
- package/src/util/createLinkInHead.js +19 -0
- package/src/util/debounce.js +17 -0
- package/src/util/escapeRegex.js +10 -0
- package/src/util/generateHighlightedMarkup.js +42 -0
- package/src/util/getActiveElement.js +11 -0
- package/src/util/getClassCopy.js +10 -0
- package/src/util/getEffectiveContentDensity.js +5 -0
- package/src/util/getNormalizedTarget.js +16 -0
- package/src/util/isElementInView.js +15 -0
- package/src/util/isNodeHidden.js +1 -1
- package/src/util/isNodeTabbable.js +4 -4
- package/used-modules.txt +10 -0
- package/bundle.es5.js +0 -28
- package/dist/SVGIconRegistry.js +0 -73
- package/dist/boot.js +0 -34
- package/dist/compatibility/DOMObserver.js +0 -62
- package/dist/compatibility/patchNodeValue.js +0 -24
- package/dist/compatibility/whenPolyfillLoaded.js +0 -26
- package/dist/config/AssetsPath.js +0 -17
- package/dist/delegate/CustomResize.js +0 -78
- package/dist/delegate/NativeResize.js +0 -45
- package/dist/features/PropertiesFormatSupport.js +0 -8
- package/dist/features/browsersupport/Edge.js +0 -6
- package/dist/features/browsersupport/IE11.js +0 -42
- package/dist/features/browsersupport/IE11WithWebComponentsPolyfill.js +0 -5
- package/dist/renderer/ifDefined.js +0 -21
- package/dist/renderer/scopeHTML.js +0 -32
- package/dist/resources/bundle.es5.js +0 -212
- package/dist/resources/bundle.es5.js.map +0 -1
- package/dist/theming/CSSVarsPonyfill.js +0 -68
- package/dist/theming/adaptCSSForIE.js +0 -95
- package/dist/theming/createComponentStyleTag.js +0 -54
- package/dist/theming/createThemePropertiesStyleTag.js +0 -20
- package/dist/thirdparty/Array.from.js +0 -16
- package/dist/thirdparty/Array.prototype.fill.js +0 -44
- package/dist/thirdparty/Array.prototype.find.js +0 -46
- package/dist/thirdparty/Array.prototype.includes.js +0 -51
- package/dist/thirdparty/Element.prototype.closest.js +0 -11
- package/dist/thirdparty/Element.prototype.matches.js +0 -6
- package/dist/thirdparty/Map.prototype.keys.js +0 -9
- package/dist/thirdparty/Number.isInteger.js +0 -5
- package/dist/thirdparty/Number.isNaN.js +0 -1
- package/dist/thirdparty/Number.parseFloat.js +0 -1
- package/dist/thirdparty/Number.parseInt.js +0 -1
- package/dist/thirdparty/Object.assign.js +0 -31
- package/dist/thirdparty/Object.entries.js +0 -11
- package/dist/thirdparty/Symbol.js +0 -2
- package/dist/thirdparty/WeakSet.js +0 -27
- package/dist/thirdparty/es6-string-methods.js +0 -182
- package/dist/thirdparty/events-polyfills.js +0 -89
- package/dist/thirdparty/fetch.js +0 -1
- package/dist/thirdparty/template.js +0 -600
- package/dist/thirdparty/webcomponents-sd-ce-pf.js +0 -318
- package/dist/util/EffectiveAssetPath.js +0 -27
- package/dist/util/encodeCSS.js +0 -24
- package/dist/util/isSlot.js +0 -3
- package/dist/webcomponentsjs/LICENSE.md +0 -19
- package/dist/webcomponentsjs/README.md +0 -229
- package/dist/webcomponentsjs/bundles/webcomponents-ce.js +0 -63
- package/dist/webcomponentsjs/bundles/webcomponents-ce.js.map +0 -1
- package/dist/webcomponentsjs/bundles/webcomponents-sd-ce-pf.js +0 -297
- package/dist/webcomponentsjs/bundles/webcomponents-sd-ce-pf.js.map +0 -1
- package/dist/webcomponentsjs/bundles/webcomponents-sd-ce.js +0 -208
- package/dist/webcomponentsjs/bundles/webcomponents-sd-ce.js.map +0 -1
- package/dist/webcomponentsjs/bundles/webcomponents-sd.js +0 -166
- package/dist/webcomponentsjs/bundles/webcomponents-sd.js.map +0 -1
- package/dist/webcomponentsjs/custom-elements-es5-adapter.js +0 -15
- package/dist/webcomponentsjs/package.json +0 -46
- package/dist/webcomponentsjs/src/entrypoints/custom-elements-es5-adapter-index.js +0 -16
- package/dist/webcomponentsjs/src/entrypoints/webcomponents-bundle-index.js +0 -53
- package/dist/webcomponentsjs/src/entrypoints/webcomponents-ce-index.js +0 -17
- package/dist/webcomponentsjs/src/entrypoints/webcomponents-sd-ce-index.js +0 -19
- package/dist/webcomponentsjs/src/entrypoints/webcomponents-sd-ce-pf-index.js +0 -28
- package/dist/webcomponentsjs/src/entrypoints/webcomponents-sd-index.js +0 -18
- package/dist/webcomponentsjs/webcomponents-bundle.js +0 -298
- package/dist/webcomponentsjs/webcomponents-bundle.js.map +0 -1
- package/dist/webcomponentsjs/webcomponents-loader.js +0 -185
- package/src/SVGIconRegistry.js +0 -73
- package/src/boot.js +0 -34
- package/src/compatibility/DOMObserver.js +0 -62
- package/src/compatibility/patchNodeValue.js +0 -24
- package/src/compatibility/whenPolyfillLoaded.js +0 -26
- package/src/config/AssetsPath.js +0 -17
- package/src/delegate/CustomResize.js +0 -78
- package/src/delegate/NativeResize.js +0 -45
- package/src/features/PropertiesFormatSupport.js +0 -8
- package/src/features/browsersupport/Edge.js +0 -6
- package/src/features/browsersupport/IE11.js +0 -42
- package/src/features/browsersupport/IE11WithWebComponentsPolyfill.js +0 -5
- package/src/renderer/ifDefined.js +0 -21
- package/src/renderer/scopeHTML.js +0 -32
- package/src/theming/CSSVarsPonyfill.js +0 -68
- package/src/theming/adaptCSSForIE.js +0 -95
- package/src/theming/createComponentStyleTag.js +0 -54
- package/src/theming/createThemePropertiesStyleTag.js +0 -20
- package/src/thirdparty/Array.from.js +0 -16
- package/src/thirdparty/Array.prototype.fill.js +0 -44
- package/src/thirdparty/Array.prototype.find.js +0 -46
- package/src/thirdparty/Array.prototype.includes.js +0 -51
- package/src/thirdparty/Element.prototype.closest.js +0 -11
- package/src/thirdparty/Element.prototype.matches.js +0 -6
- package/src/thirdparty/Map.prototype.keys.js +0 -9
- package/src/thirdparty/Number.isInteger.js +0 -5
- package/src/thirdparty/Number.isNaN.js +0 -1
- package/src/thirdparty/Number.parseFloat.js +0 -1
- package/src/thirdparty/Number.parseInt.js +0 -1
- package/src/thirdparty/Object.assign.js +0 -31
- package/src/thirdparty/Object.entries.js +0 -11
- package/src/thirdparty/Symbol.js +0 -2
- package/src/thirdparty/WeakSet.js +0 -27
- package/src/thirdparty/es6-string-methods.js +0 -182
- package/src/thirdparty/events-polyfills.js +0 -89
- package/src/thirdparty/fetch.js +0 -1
- package/src/thirdparty/template.js +0 -600
- package/src/thirdparty/webcomponents-sd-ce-pf.js +0 -318
- package/src/util/EffectiveAssetPath.js +0 -27
- package/src/util/encodeCSS.js +0 -24
- package/src/util/isSlot.js +0 -3
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
import RenderScheduler from "../RenderScheduler.js";
|
|
2
1
|
import {
|
|
3
2
|
isDown,
|
|
4
3
|
isUp,
|
|
@@ -6,183 +5,302 @@ import {
|
|
|
6
5
|
isRight,
|
|
7
6
|
isHome,
|
|
8
7
|
isEnd,
|
|
9
|
-
isPageUp,
|
|
10
8
|
isPageDown,
|
|
9
|
+
isPageUp,
|
|
11
10
|
} from "../Keys.js";
|
|
11
|
+
import getActiveElement from "../util/getActiveElement.js";
|
|
12
12
|
|
|
13
|
-
import EventProvider from "../EventProvider.js";
|
|
14
13
|
import NavigationMode from "../types/NavigationMode.js";
|
|
15
14
|
import ItemNavigationBehavior from "../types/ItemNavigationBehavior.js";
|
|
16
15
|
|
|
17
|
-
|
|
18
|
-
|
|
16
|
+
/**
|
|
17
|
+
* The ItemNavigation class manages the calculations to determine the correct "tabindex" for a group of related items inside a root component.
|
|
18
|
+
* Important: ItemNavigation only does the calculations and does not change "tabindex" directly, this is a responsibility of the developer.
|
|
19
|
+
*
|
|
20
|
+
* The keys that trigger ItemNavigation are:
|
|
21
|
+
* - Up/down
|
|
22
|
+
* - Left/right
|
|
23
|
+
* - Home/End
|
|
24
|
+
*
|
|
25
|
+
* Usage:
|
|
26
|
+
* 1) Use the "getItemsCallback" constructor property to pass a callback to ItemNavigation, which, whenever called, will return the list of items to navigate among.
|
|
27
|
+
*
|
|
28
|
+
* Each item passed to ItemNavigation via "getItemsCallback" must be:
|
|
29
|
+
* - A) either a UI5Element with a "_tabIndex" property
|
|
30
|
+
* - B) or an Object with "id" and "_tabIndex" properties which represents a part of the root component's shadow DOM.
|
|
31
|
+
* The "id" must be a valid ID within the shadow root of the component ItemNavigation operates on.
|
|
32
|
+
* This object must not be a DOM object because, as said, ItemNavigation will not set "tabindex" on it. It must be a representation of a DOM object only
|
|
33
|
+
* and the developer has the responsibility to update the "tabindex" in the component's DOM.
|
|
34
|
+
* - C) a combination of the above
|
|
35
|
+
*
|
|
36
|
+
* Whenever the user navigates with the keyboard, ItemNavigation will modify the "_tabIndex" properties of the items.
|
|
37
|
+
* It is the items' responsibilities to re-render themselves and apply the correct value of "tabindex" (i.e. to map the "_tabIndex" ItemNavigation set to them to the "tabindex" property).
|
|
38
|
+
* If the items of the ItemNavigation are UI5Elements themselves, this can happen naturally since they will be invalidated by their "_tabIndex" property.
|
|
39
|
+
* If the items are Objects with "id" and "_tabIndex" however, it is the developer's responsibility to apply these and the easiest way is to have the root component invalidated by ItemNavigation.
|
|
40
|
+
* To do so, set the "affectedPropertiesNames" constructor property to point to one or more of the root component's properties that need refreshing when "_tabIndex" is changed deeply.
|
|
41
|
+
*
|
|
42
|
+
* 2) Call the "setCurrentItem" method of ItemNavigation whenever you want to change the current item.
|
|
43
|
+
* This is most commonly required if the user for example clicks on an item and thus selects it directly.
|
|
44
|
+
* Pass as the only argument to "setCurrentItem" the item that becomes current (must be one of the items, returned by "getItemsCallback").
|
|
45
|
+
*
|
|
46
|
+
* @class
|
|
47
|
+
* @public
|
|
48
|
+
*/
|
|
49
|
+
class ItemNavigation {
|
|
50
|
+
/**
|
|
51
|
+
*
|
|
52
|
+
* @param rootWebComponent the component to operate on (component that slots or contains within its shadow root the items the user navigates among)
|
|
53
|
+
* @param options Object with configuration options:
|
|
54
|
+
* - currentIndex: the index of the item that will be initially selected (from which navigation will begin)
|
|
55
|
+
* - navigationMode (Auto|Horizontal|Vertical): whether the items are displayed horizontally (Horizontal), vertically (Vertical) or as a matrix (Auto) meaning the user can navigate in both directions (up/down and left/right)
|
|
56
|
+
* - rowSize: tells how many items per row there are when the items are not rendered as a flat list but rather as a matrix. Relevant for navigationMode=Auto
|
|
57
|
+
* - skipItemsSize: tells how many items upon PAGE_UP and PAGE_DOWN should be skipped to applying the focus on the next item
|
|
58
|
+
* - behavior (Static|Cycling): tells what to do when trying to navigate beyond the first and last items
|
|
59
|
+
* Static means that nothing happens if the user tries to navigate beyond the first/last item.
|
|
60
|
+
* Cycling means that when the user navigates beyond the last item they go to the first and vice versa.
|
|
61
|
+
* - getItemsCallback: function that, when called, returns an array with all items the user can navigate among
|
|
62
|
+
* - affectedPropertiesNames: a list of metadata properties on the root component which, upon user navigation, will be reassigned by address thus causing the root component to invalidate
|
|
63
|
+
*/
|
|
19
64
|
constructor(rootWebComponent, options = {}) {
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
this.rowSize = options.rowSize || 1;
|
|
24
|
-
this.behavior = options.behavior || ItemNavigationBehavior.Static;
|
|
25
|
-
this.hasNextPage = true; // used in Paging mode and controlled from the rootWebComponent
|
|
26
|
-
this.hasPrevPage = true; // used in Paging mode and controlled from the rootWebComponent
|
|
27
|
-
const navigationMode = options.navigationMode;
|
|
28
|
-
const autoNavigation = !navigationMode || navigationMode === NavigationMode.Auto;
|
|
29
|
-
this.horizontalNavigationOn = autoNavigation || navigationMode === NavigationMode.Horizontal;
|
|
30
|
-
this.verticalNavigationOn = autoNavigation || navigationMode === NavigationMode.Vertical;
|
|
31
|
-
|
|
32
|
-
this.pageSize = options.pageSize;
|
|
65
|
+
this._setRootComponent(rootWebComponent);
|
|
66
|
+
this._initOptions(options);
|
|
67
|
+
}
|
|
33
68
|
|
|
69
|
+
_setRootComponent(rootWebComponent) {
|
|
70
|
+
if (!rootWebComponent.isUI5Element) {
|
|
71
|
+
throw new Error("The root web component must be a UI5 Element instance");
|
|
72
|
+
}
|
|
34
73
|
this.rootWebComponent = rootWebComponent;
|
|
35
|
-
this.rootWebComponent.addEventListener("keydown", this.
|
|
74
|
+
this.rootWebComponent.addEventListener("keydown", this._onkeydown.bind(this));
|
|
36
75
|
this.rootWebComponent._onComponentStateFinalized = () => {
|
|
37
76
|
this._init();
|
|
38
77
|
};
|
|
39
78
|
}
|
|
40
79
|
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
}
|
|
45
|
-
}
|
|
46
|
-
|
|
47
|
-
_horizontalNavigationOn() {
|
|
48
|
-
return this.horizontalNavigationOn;
|
|
49
|
-
}
|
|
80
|
+
_initOptions(options) {
|
|
81
|
+
if (typeof options.getItemsCallback !== "function") {
|
|
82
|
+
throw new Error("getItemsCallback is required");
|
|
83
|
+
}
|
|
50
84
|
|
|
51
|
-
|
|
52
|
-
|
|
85
|
+
this._getItems = options.getItemsCallback;
|
|
86
|
+
this._currentIndex = options.currentIndex || 0;
|
|
87
|
+
this._rowSize = options.rowSize || 1;
|
|
88
|
+
this._behavior = options.behavior || ItemNavigationBehavior.Static;
|
|
89
|
+
this._navigationMode = options.navigationMode || NavigationMode.Auto;
|
|
90
|
+
this._affectedPropertiesNames = options.affectedPropertiesNames || [];
|
|
91
|
+
this._skipItemsSize = options.skipItemsSize || null;
|
|
53
92
|
}
|
|
54
93
|
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
94
|
+
/**
|
|
95
|
+
* Call this method to set a new "current" (selected) item in the item navigation
|
|
96
|
+
* Note: the item passed to this function must be one of the items, returned by the getItemsCallback function
|
|
97
|
+
*
|
|
98
|
+
* @public
|
|
99
|
+
* @param current the new selected item
|
|
100
|
+
*/
|
|
101
|
+
setCurrentItem(current) {
|
|
102
|
+
const currentItemIndex = this._getItems().indexOf(current);
|
|
103
|
+
|
|
104
|
+
if (currentItemIndex === -1) {
|
|
105
|
+
console.warn(`The provided item is not managed by ItemNavigation`, current); // eslint-disable-line
|
|
106
|
+
return;
|
|
60
107
|
}
|
|
61
108
|
|
|
62
|
-
|
|
109
|
+
this._currentIndex = currentItemIndex;
|
|
110
|
+
this._applyTabIndex();
|
|
111
|
+
}
|
|
63
112
|
|
|
64
|
-
|
|
113
|
+
/**
|
|
114
|
+
* Call this method to dynamically change the row size
|
|
115
|
+
*
|
|
116
|
+
* @public
|
|
117
|
+
* @param newRowSize
|
|
118
|
+
*/
|
|
119
|
+
setRowSize(newRowSize) {
|
|
120
|
+
this._rowSize = newRowSize;
|
|
121
|
+
}
|
|
65
122
|
|
|
66
|
-
|
|
67
|
-
this.
|
|
68
|
-
|
|
123
|
+
_init() {
|
|
124
|
+
this._getItems().forEach((item, idx) => {
|
|
125
|
+
item._tabIndex = (idx === this._currentIndex) ? "0" : "-1";
|
|
126
|
+
});
|
|
69
127
|
}
|
|
70
128
|
|
|
71
|
-
|
|
72
|
-
if (
|
|
73
|
-
return
|
|
129
|
+
_onkeydown(event) {
|
|
130
|
+
if (!this._canNavigate()) {
|
|
131
|
+
return;
|
|
74
132
|
}
|
|
75
133
|
|
|
76
|
-
|
|
77
|
-
|
|
134
|
+
const horizontalNavigationOn = this._navigationMode === NavigationMode.Horizontal || this._navigationMode === NavigationMode.Auto;
|
|
135
|
+
const verticalNavigationOn = this._navigationMode === NavigationMode.Vertical || this._navigationMode === NavigationMode.Auto;
|
|
136
|
+
|
|
137
|
+
if (isUp(event) && verticalNavigationOn) {
|
|
138
|
+
this._handleUp();
|
|
139
|
+
} else if (isDown(event) && verticalNavigationOn) {
|
|
140
|
+
this._handleDown();
|
|
141
|
+
} else if (isLeft(event) && horizontalNavigationOn) {
|
|
142
|
+
this._handleLeft();
|
|
143
|
+
} else if (isRight(event) && horizontalNavigationOn) {
|
|
144
|
+
this._handleRight();
|
|
145
|
+
} else if (isHome(event)) {
|
|
146
|
+
this._handleHome();
|
|
147
|
+
} else if (isEnd(event)) {
|
|
148
|
+
this._handleEnd();
|
|
149
|
+
} else if (isPageUp(event)) {
|
|
150
|
+
this._handlePageUp();
|
|
151
|
+
} else if (isPageDown(event)) {
|
|
152
|
+
this._handlePageDown();
|
|
153
|
+
} else {
|
|
154
|
+
return; // if none of the supported keys is pressed, we don't want to prevent the event or update the item navigation
|
|
78
155
|
}
|
|
79
156
|
|
|
80
|
-
|
|
81
|
-
|
|
157
|
+
event.preventDefault();
|
|
158
|
+
this._applyTabIndex();
|
|
159
|
+
this._focusCurrentItem();
|
|
160
|
+
}
|
|
161
|
+
|
|
162
|
+
_handleUp() {
|
|
163
|
+
const itemsLength = this._getItems().length;
|
|
164
|
+
if (this._currentIndex - this._rowSize >= 0) { // no border reached, just decrease the index by a row
|
|
165
|
+
this._currentIndex -= this._rowSize;
|
|
166
|
+
return;
|
|
82
167
|
}
|
|
83
168
|
|
|
84
|
-
if (
|
|
85
|
-
|
|
169
|
+
if (this._behavior === ItemNavigationBehavior.Cyclic) { // if cyclic, go to the **last** item in the **previous** column
|
|
170
|
+
const firstItemInThisColumnIndex = this._currentIndex % this._rowSize;
|
|
171
|
+
const firstItemInPreviousColumnIndex = firstItemInThisColumnIndex === 0 ? this._rowSize - 1 : firstItemInThisColumnIndex - 1; // find the first item in the previous column (if the current column is the first column -> move to the last column)
|
|
172
|
+
const rows = Math.ceil(itemsLength / this._rowSize); // how many rows there are (even if incomplete, f.e. for 14 items and _rowSize=4 -> 4 rows total, although only 2 items on the last row)
|
|
173
|
+
let lastItemInPreviousColumnIndex = firstItemInPreviousColumnIndex + (rows - 1) * this._rowSize; // multiply rows by columns, and add the column's first item's index
|
|
174
|
+
if (lastItemInPreviousColumnIndex > itemsLength - 1) { // for incomplete rows, use the previous row's last item, as for them the last item is missing
|
|
175
|
+
lastItemInPreviousColumnIndex -= this._rowSize;
|
|
176
|
+
}
|
|
177
|
+
this._currentIndex = lastItemInPreviousColumnIndex;
|
|
178
|
+
} else { // not cyclic, so just go to the first item
|
|
179
|
+
this._currentIndex = 0;
|
|
86
180
|
}
|
|
181
|
+
}
|
|
87
182
|
|
|
88
|
-
|
|
89
|
-
|
|
183
|
+
_handleDown() {
|
|
184
|
+
const itemsLength = this._getItems().length;
|
|
185
|
+
if (this._currentIndex + this._rowSize < itemsLength) { // no border reached, just increase the index by a row
|
|
186
|
+
this._currentIndex += this._rowSize;
|
|
187
|
+
return;
|
|
90
188
|
}
|
|
91
189
|
|
|
92
|
-
if (
|
|
93
|
-
|
|
190
|
+
if (this._behavior === ItemNavigationBehavior.Cyclic) { // if cyclic, go to the **first** item in the **next** column
|
|
191
|
+
const firstItemInThisColumnIndex = this._currentIndex % this._rowSize; // find the first item in the current column first
|
|
192
|
+
const firstItemInNextColumnIndex = (firstItemInThisColumnIndex + 1) % this._rowSize; // to get the first item in the next column, just increase the index by 1. The modulo by rows is for the case when we are at the last column
|
|
193
|
+
this._currentIndex = firstItemInNextColumnIndex;
|
|
194
|
+
} else { // not cyclic, so just go to the last item
|
|
195
|
+
this._currentIndex = itemsLength - 1;
|
|
94
196
|
}
|
|
197
|
+
}
|
|
95
198
|
|
|
96
|
-
|
|
97
|
-
|
|
199
|
+
_handleLeft() {
|
|
200
|
+
const itemsLength = this._getItems().length;
|
|
201
|
+
if (this._currentIndex > 0) {
|
|
202
|
+
this._currentIndex -= 1;
|
|
203
|
+
return;
|
|
98
204
|
}
|
|
99
205
|
|
|
100
|
-
if (
|
|
101
|
-
|
|
206
|
+
if (this._behavior === ItemNavigationBehavior.Cyclic) { // go to the first item in the next column
|
|
207
|
+
this._currentIndex = itemsLength - 1;
|
|
102
208
|
}
|
|
103
209
|
}
|
|
104
210
|
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
this.
|
|
211
|
+
_handleRight() {
|
|
212
|
+
const itemsLength = this._getItems().length;
|
|
213
|
+
if (this._currentIndex < itemsLength - 1) {
|
|
214
|
+
this._currentIndex += 1;
|
|
215
|
+
return;
|
|
109
216
|
}
|
|
110
|
-
}
|
|
111
217
|
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
this.currentIndex += this.rowSize;
|
|
115
|
-
this._onKeyPress(event);
|
|
218
|
+
if (this._behavior === ItemNavigationBehavior.Cyclic) { // go to the first item in the next column
|
|
219
|
+
this._currentIndex = 0;
|
|
116
220
|
}
|
|
117
221
|
}
|
|
118
222
|
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
this._onKeyPress(event);
|
|
123
|
-
}
|
|
223
|
+
_handleHome() {
|
|
224
|
+
const homeEndRange = this._rowSize > 1 ? this._rowSize : this._getItems().length;
|
|
225
|
+
this._currentIndex -= this._currentIndex % homeEndRange;
|
|
124
226
|
}
|
|
125
227
|
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
this._onKeyPress(event);
|
|
130
|
-
}
|
|
228
|
+
_handleEnd() {
|
|
229
|
+
const homeEndRange = this._rowSize > 1 ? this._rowSize : this._getItems().length;
|
|
230
|
+
this._currentIndex += (homeEndRange - 1 - this._currentIndex % homeEndRange); // eslint-disable-line
|
|
131
231
|
}
|
|
132
232
|
|
|
133
|
-
|
|
134
|
-
if (this.
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
233
|
+
_handlePageUp() {
|
|
234
|
+
if (this._rowSize > 1) {
|
|
235
|
+
// eslint-disable-next-line
|
|
236
|
+
// TODO: handle page up on matrix (grid) layout - ColorPalette, ProductSwitch.
|
|
237
|
+
return;
|
|
138
238
|
}
|
|
239
|
+
this._handlePageUpFlat();
|
|
139
240
|
}
|
|
140
241
|
|
|
141
|
-
|
|
142
|
-
if (this.
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
242
|
+
_handlePageDown() {
|
|
243
|
+
if (this._rowSize > 1) {
|
|
244
|
+
// eslint-disable-next-line
|
|
245
|
+
// TODO: handle page up on matrix (grid) layout - ColorPalette, ProductSwitch.
|
|
246
|
+
return;
|
|
146
247
|
}
|
|
248
|
+
this._handlePageDownFlat();
|
|
147
249
|
}
|
|
148
250
|
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
251
|
+
/**
|
|
252
|
+
* Handles PAGE_UP in a flat list-like structure, both vertically and horizontally.
|
|
253
|
+
*/
|
|
254
|
+
_handlePageUpFlat() {
|
|
255
|
+
if (this._skipItemsSize === null) {
|
|
256
|
+
// Move the focus to the very top (as Home).
|
|
257
|
+
this._currentIndex -= this._currentIndex;
|
|
153
258
|
}
|
|
154
|
-
}
|
|
155
259
|
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
this.
|
|
260
|
+
if (this._currentIndex + 1 > this._skipItemsSize) {
|
|
261
|
+
// When there are more than "skipItemsSize" number of items to the top,
|
|
262
|
+
// move the focus up/left with the predefined number.
|
|
263
|
+
this._currentIndex -= this._skipItemsSize;
|
|
264
|
+
} else {
|
|
265
|
+
// Otherwise, move the focus to the very top (as Home).
|
|
266
|
+
this._currentIndex -= this._currentIndex;
|
|
160
267
|
}
|
|
161
268
|
}
|
|
162
269
|
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
270
|
+
/**
|
|
271
|
+
* Handles PAGE_DOWN in a flat list-like structure, both vertically and horizontally.
|
|
272
|
+
*/
|
|
273
|
+
_handlePageDownFlat() {
|
|
274
|
+
if (this._skipItemsSize === null) {
|
|
275
|
+
// Move the focus to the very bottom (as End).
|
|
276
|
+
this._currentIndex = this._getItems().length - 1;
|
|
168
277
|
}
|
|
169
278
|
|
|
170
|
-
|
|
171
|
-
|| (origItems[this.currentIndex]._tabIndex && origItems[this.currentIndex]._tabIndex === "0")) {
|
|
172
|
-
return;
|
|
173
|
-
}
|
|
279
|
+
const currentToEndRange = this._getItems().length - this._currentIndex - 1;
|
|
174
280
|
|
|
175
|
-
|
|
281
|
+
if (currentToEndRange > this._skipItemsSize) {
|
|
282
|
+
// When there are more than "skipItemsSize" number of items until the bottom,
|
|
283
|
+
// move the focus down/right with the predefined number.
|
|
284
|
+
this._currentIndex += this._skipItemsSize;
|
|
285
|
+
} else {
|
|
286
|
+
// Otherwise, move the focus to the very bottom (as End).
|
|
287
|
+
this._currentIndex = this._getItems().length - 1;
|
|
288
|
+
}
|
|
289
|
+
}
|
|
176
290
|
|
|
291
|
+
_applyTabIndex() {
|
|
292
|
+
const items = this._getItems();
|
|
177
293
|
for (let i = 0; i < items.length; i++) {
|
|
178
|
-
items[i]._tabIndex =
|
|
294
|
+
items[i]._tabIndex = i === this._currentIndex ? "0" : "-1";
|
|
179
295
|
}
|
|
180
296
|
|
|
181
|
-
|
|
182
|
-
|
|
297
|
+
this._affectedPropertiesNames.forEach(propName => {
|
|
298
|
+
const prop = this.rootWebComponent[propName];
|
|
299
|
+
this.rootWebComponent[propName] = Array.isArray(prop) ? [...prop] : { ...prop };
|
|
300
|
+
});
|
|
183
301
|
}
|
|
184
302
|
|
|
185
|
-
|
|
303
|
+
_focusCurrentItem() {
|
|
186
304
|
const currentItem = this._getCurrentItem();
|
|
187
305
|
if (currentItem) {
|
|
188
306
|
currentItem.focus();
|
|
@@ -191,12 +309,7 @@ class ItemNavigation extends EventProvider {
|
|
|
191
309
|
|
|
192
310
|
_canNavigate() {
|
|
193
311
|
const currentItem = this._getCurrentItem();
|
|
194
|
-
|
|
195
|
-
let activeElement = document.activeElement;
|
|
196
|
-
|
|
197
|
-
while (activeElement.shadowRoot && activeElement.shadowRoot.activeElement) {
|
|
198
|
-
activeElement = activeElement.shadowRoot.activeElement;
|
|
199
|
-
}
|
|
312
|
+
const activeElement = getActiveElement();
|
|
200
313
|
|
|
201
314
|
return currentItem && currentItem === activeElement;
|
|
202
315
|
}
|
|
@@ -209,15 +322,15 @@ class ItemNavigation extends EventProvider {
|
|
|
209
322
|
}
|
|
210
323
|
|
|
211
324
|
// normalize the index
|
|
212
|
-
while (this.
|
|
213
|
-
this.
|
|
325
|
+
while (this._currentIndex >= items.length) {
|
|
326
|
+
this._currentIndex -= this._rowSize;
|
|
214
327
|
}
|
|
215
328
|
|
|
216
|
-
if (this.
|
|
217
|
-
this.
|
|
329
|
+
if (this._currentIndex < 0) {
|
|
330
|
+
this._currentIndex = 0;
|
|
218
331
|
}
|
|
219
332
|
|
|
220
|
-
const currentItem = items[this.
|
|
333
|
+
const currentItem = items[this._currentIndex];
|
|
221
334
|
|
|
222
335
|
if (!currentItem) {
|
|
223
336
|
return;
|
|
@@ -233,87 +346,6 @@ class ItemNavigation extends EventProvider {
|
|
|
233
346
|
|
|
234
347
|
return this.rootWebComponent.getDomRef().querySelector(`#${currentItem.id}`);
|
|
235
348
|
}
|
|
236
|
-
|
|
237
|
-
set getItemsCallback(fn) {
|
|
238
|
-
this._getItems = fn;
|
|
239
|
-
}
|
|
240
|
-
|
|
241
|
-
set current(val) {
|
|
242
|
-
this.currentIndex = val;
|
|
243
|
-
}
|
|
244
|
-
|
|
245
|
-
onOverflowBottomEdge(event) {
|
|
246
|
-
const items = this._getItems();
|
|
247
|
-
const offset = (this.currentIndex - items.length) % this.rowSize;
|
|
248
|
-
|
|
249
|
-
if (this.behavior === ItemNavigationBehavior.Cyclic) {
|
|
250
|
-
this.currentIndex = 0;
|
|
251
|
-
return;
|
|
252
|
-
}
|
|
253
|
-
|
|
254
|
-
if (this.behavior === ItemNavigationBehavior.Paging) {
|
|
255
|
-
this._handleNextPage();
|
|
256
|
-
} else {
|
|
257
|
-
this.currentIndex = items.length - 1;
|
|
258
|
-
}
|
|
259
|
-
|
|
260
|
-
this.fireEvent(ItemNavigation.BORDER_REACH, {
|
|
261
|
-
start: false,
|
|
262
|
-
end: true,
|
|
263
|
-
originalEvent: event,
|
|
264
|
-
offset,
|
|
265
|
-
});
|
|
266
|
-
}
|
|
267
|
-
|
|
268
|
-
onOverflowTopEdge(event) {
|
|
269
|
-
const items = this._getItems();
|
|
270
|
-
const offsetRight = (this.currentIndex + this.rowSize) % this.rowSize;
|
|
271
|
-
const offset = offsetRight < 0 ? (this.rowSize + offsetRight) : offsetRight;
|
|
272
|
-
|
|
273
|
-
if (this.behavior === ItemNavigationBehavior.Cyclic) {
|
|
274
|
-
this.currentIndex = items.length - 1;
|
|
275
|
-
return;
|
|
276
|
-
}
|
|
277
|
-
|
|
278
|
-
if (this.behavior === ItemNavigationBehavior.Paging) {
|
|
279
|
-
this._handlePrevPage();
|
|
280
|
-
} else {
|
|
281
|
-
this.currentIndex = 0;
|
|
282
|
-
}
|
|
283
|
-
|
|
284
|
-
this.fireEvent(ItemNavigation.BORDER_REACH, {
|
|
285
|
-
start: true,
|
|
286
|
-
end: false,
|
|
287
|
-
originalEvent: event,
|
|
288
|
-
offset,
|
|
289
|
-
});
|
|
290
|
-
}
|
|
291
|
-
|
|
292
|
-
_handleNextPage() {
|
|
293
|
-
this.fireEvent(ItemNavigation.PAGE_BOTTOM);
|
|
294
|
-
const items = this._getItems();
|
|
295
|
-
|
|
296
|
-
if (!this.hasNextPage) {
|
|
297
|
-
this.currentIndex = items.length - 1;
|
|
298
|
-
} else {
|
|
299
|
-
this.currentIndex -= this.pageSize;
|
|
300
|
-
}
|
|
301
|
-
}
|
|
302
|
-
|
|
303
|
-
_handlePrevPage() {
|
|
304
|
-
this.fireEvent(ItemNavigation.PAGE_TOP);
|
|
305
|
-
|
|
306
|
-
if (!this.hasPrevPage) {
|
|
307
|
-
this.currentIndex = 0;
|
|
308
|
-
} else {
|
|
309
|
-
this.currentIndex = this.pageSize + this.currentIndex;
|
|
310
|
-
}
|
|
311
|
-
}
|
|
312
349
|
}
|
|
313
350
|
|
|
314
|
-
ItemNavigation.PAGE_TOP = "PageTop";
|
|
315
|
-
ItemNavigation.PAGE_BOTTOM = "PageBottom";
|
|
316
|
-
ItemNavigation.BORDER_REACH = "_borderReach";
|
|
317
|
-
ItemNavigation.AFTER_FOCUS = "_afterFocus";
|
|
318
|
-
|
|
319
351
|
export default ItemNavigation;
|
|
@@ -1,65 +1,106 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
1
|
+
let resizeObserver;
|
|
2
|
+
const observedElements = new Map();
|
|
3
3
|
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
4
|
+
const getResizeObserver = () => {
|
|
5
|
+
if (!resizeObserver) {
|
|
6
|
+
resizeObserver = new window.ResizeObserver(entries => {
|
|
7
|
+
entries.forEach(entry => {
|
|
8
|
+
const callbacks = observedElements.get(entry.target);
|
|
9
|
+
callbacks.forEach(callback => callback());
|
|
10
|
+
});
|
|
11
|
+
});
|
|
8
12
|
}
|
|
13
|
+
return resizeObserver;
|
|
14
|
+
};
|
|
9
15
|
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
*/
|
|
17
|
-
static attachListener(ref, callback) {
|
|
18
|
-
ResizeHandler.Implementation.attachListener.call(ResizeHandler.Implementation, ref, callback);
|
|
16
|
+
let observe = (element, callback) => {
|
|
17
|
+
const callbacks = observedElements.get(element) || [];
|
|
18
|
+
|
|
19
|
+
// if no callbacks have been added for this element - start observing it
|
|
20
|
+
if (!callbacks.length) {
|
|
21
|
+
getResizeObserver().observe(element);
|
|
19
22
|
}
|
|
20
23
|
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
24
|
+
// save the callbacks in an array
|
|
25
|
+
observedElements.set(element, [...callbacks, callback]);
|
|
26
|
+
};
|
|
27
|
+
|
|
28
|
+
let unobserve = (element, callback) => {
|
|
29
|
+
const callbacks = observedElements.get(element) || [];
|
|
30
|
+
if (callbacks.length === 0) {
|
|
31
|
+
return;
|
|
29
32
|
}
|
|
30
33
|
|
|
34
|
+
const filteredCallbacks = callbacks.filter(fn => fn !== callback);
|
|
35
|
+
if (filteredCallbacks.length === 0) {
|
|
36
|
+
getResizeObserver().unobserve(element);
|
|
37
|
+
observedElements.delete(element);
|
|
38
|
+
} else {
|
|
39
|
+
observedElements.set(element, filteredCallbacks);
|
|
40
|
+
}
|
|
41
|
+
};
|
|
31
42
|
|
|
43
|
+
/**
|
|
44
|
+
* Allows to register/deregister resize observers for a DOM element
|
|
45
|
+
*
|
|
46
|
+
* @public
|
|
47
|
+
* @class
|
|
48
|
+
*/
|
|
49
|
+
class ResizeHandler {
|
|
32
50
|
/**
|
|
33
51
|
* @static
|
|
34
52
|
* @public
|
|
35
|
-
* @param {*}
|
|
53
|
+
* @param {*} element UI5 Web Component or DOM Element to be observed
|
|
36
54
|
* @param {*} callback Callback to be executed
|
|
37
|
-
* @memberof ResizeHandler
|
|
38
55
|
*/
|
|
39
|
-
static register(
|
|
40
|
-
if (
|
|
41
|
-
|
|
56
|
+
static register(element, callback) {
|
|
57
|
+
if (element.isUI5Element) {
|
|
58
|
+
element = element.getDomRef();
|
|
42
59
|
}
|
|
43
60
|
|
|
44
|
-
|
|
61
|
+
if (element instanceof HTMLElement) {
|
|
62
|
+
observe(element, callback);
|
|
63
|
+
} else {
|
|
64
|
+
console.warn("Cannot register ResizeHandler for element", element); // eslint-disable-line
|
|
65
|
+
}
|
|
45
66
|
}
|
|
46
67
|
|
|
47
|
-
|
|
48
68
|
/**
|
|
49
69
|
* @static
|
|
50
70
|
* @public
|
|
51
|
-
* @param {*}
|
|
52
|
-
* @
|
|
71
|
+
* @param {*} element UI5 Web Component or DOM Element to be unobserved
|
|
72
|
+
* @param {*} callback Callback to be removed
|
|
53
73
|
*/
|
|
54
|
-
static deregister(
|
|
55
|
-
if (
|
|
56
|
-
|
|
74
|
+
static deregister(element, callback) {
|
|
75
|
+
if (element.isUI5Element) {
|
|
76
|
+
element = element.getDomRef();
|
|
57
77
|
}
|
|
58
78
|
|
|
59
|
-
|
|
79
|
+
if (element instanceof HTMLElement) {
|
|
80
|
+
unobserve(element, callback);
|
|
81
|
+
} else {
|
|
82
|
+
console.warn("Cannot deregister ResizeHandler for element", element); // eslint-disable-line
|
|
83
|
+
}
|
|
60
84
|
}
|
|
61
85
|
}
|
|
62
86
|
|
|
63
|
-
|
|
87
|
+
/**
|
|
88
|
+
* Set a function to be executed whenever a DOM node needs to be observed for size change.
|
|
89
|
+
* @public
|
|
90
|
+
* @param fn
|
|
91
|
+
*/
|
|
92
|
+
const setResizeHandlerObserveFn = fn => {
|
|
93
|
+
observe = fn;
|
|
94
|
+
};
|
|
95
|
+
|
|
96
|
+
/**
|
|
97
|
+
* Set a function to be executed whenever a DOM node needs to no longer be observed for size changes
|
|
98
|
+
* @public
|
|
99
|
+
* @param fn
|
|
100
|
+
*/
|
|
101
|
+
const setResizeHandlerUnobserveFn = fn => {
|
|
102
|
+
unobserve = fn;
|
|
103
|
+
};
|
|
64
104
|
|
|
65
105
|
export default ResizeHandler;
|
|
106
|
+
export { setResizeHandlerObserveFn, setResizeHandlerUnobserveFn };
|