@ui5/webcomponents-base 0.0.0-0742854fd → 0.0.0-11d529e8a

package/src/types/Integer.js

@@ -4,6 +4,10 @@ class Integer extends DataType {
 	static isValid(value) {
 		return Number.isInteger(value);
 	}
+
+	static attributeToProperty(attributeValue) {
+		return parseInt(attributeValue);
+	}
 }
 
 export default Integer;

package/src/types/InvisibleMessageMode.js

@@ -0,0 +1,30 @@
+import DataType from "./DataType.js";
+
+/**
+ * Enumeration for different mode behaviors of the <code>InvisibleMessage</code>.
+ * @private
+ */
+const InvisibleMessageModes = {
+
+	/**
+     * Indicates that updates to the region should be presented at the next graceful opportunity,
+     * such as at the end of reading the current sentence, or when the user pauses typing.
+     */
+	Polite: "Polite",
+
+	/**
+     * Indicates that updates to the region have the highest priority and should be presented to the user immediately.
+     */
+	Assertive: "Assertive",
+
+};
+
+class InvisibleMessageMode extends DataType {
+	static isValid(value) {
+		return !!InvisibleMessageModes[value];
+	}
+}
+
+InvisibleMessageMode.generateTypeAccessors(InvisibleMessageModes);
+
+export default InvisibleMessageModes;

package/src/types/ItemNavigationBehavior.js

@@ -4,18 +4,13 @@
  */
 const ItemNavigationBehavior = {
 	/**
-	* Static behavior: when border of the items is reached, you can't go out of the cage.
+	* Static behavior: navigations stops at the first or last item.
  	*/
 	Static: "Static",
 
 	/**
-	* Cycling behavior: when border of the items is reached, you can cycle through the items.
+	* Cycling behavior: navigating past the last item continues with the first and vice versa.
  	*/
 	Cyclic: "Cyclic",
-
-	/**
-	* Paging behavior: when border of the items is reached, tou can go up/down based on the rowsize(e.g. DayPicker)
- 	*/
-	Paging: "Paging",
 };
 export default ItemNavigationBehavior;

package/src/types/PopupState.js

@@ -32,6 +32,6 @@ class PopupState extends DataType {
 	}
 }
 
-PopupState.generataTypeAcessors(PopupStates);
+PopupState.generateTypeAccessors(PopupStates);
 
 export default PopupState;

package/src/types/ValueState.js

@@ -17,6 +17,6 @@ class ValueState extends DataType {
 	}
 }
 
-ValueState.generataTypeAcessors(ValueStates);
+ValueState.generateTypeAccessors(ValueStates);
 
 export default ValueState;

package/src/updateShadowRoot.js

@@ -0,0 +1,26 @@
+import executeTemplate from "./renderer/executeTemplate.js";
+import getConstructableStyle from "./theming/getConstructableStyle.js";
+import getEffectiveStyle from "./theming/getEffectiveStyle.js";
+import isLegacyBrowser from "./isLegacyBrowser.js";
+
+/**
+ * Updates the shadow root of a UI5Element or its static area item
+ * @param element
+ * @param forStaticArea
+ */
+const updateShadowRoot = (element, forStaticArea = false) => {
+	let styleToPrepend;
+	const template = forStaticArea ? "staticAreaTemplate" : "template";
+	const shadowRoot = forStaticArea ? element.staticAreaItem.shadowRoot : element.shadowRoot;
+	const renderResult = executeTemplate(element.constructor[template], element);
+
+	if (document.adoptedStyleSheets) { // Chrome
+		shadowRoot.adoptedStyleSheets = getConstructableStyle(element.constructor, forStaticArea);
+	} else if (!isLegacyBrowser()) { // FF, Safari
+		styleToPrepend = getEffectiveStyle(element.constructor, forStaticArea);
+	}
+
+	element.constructor.render(renderResult, shadowRoot, styleToPrepend, { host: element });
+};
+
+export default updateShadowRoot;

package/src/util/AriaLabelHelper.js

@@ -1,9 +1,9 @@
 import findNodeOwner from "./findNodeOwner.js";
 
 const getEffectiveAriaLabelText = el => {
-	if (!el.ariaLabelledby) {
-		if (el.ariaLabel) {
-			return el.ariaLabel;
+	if (!el.accessibleNameRef) {
+		if (el.accessibleName) {
+			return el.accessibleName;
 		}
 
 		return undefined;
@@ -19,7 +19,7 @@ const getEffectiveAriaLabelText = el => {
  * @param {String} readyIds (Optional) Defines a string of elements ids. The text of these elements will be returned. If used you should provide either el or ownerDocument
  */
 const getAriaLabelledByTexts = (el, ownerDocument, readyIds = "") => {
-	const ids = (readyIds && readyIds.split(" ")) || el.ariaLabelledby.split(" ");
+	const ids = (readyIds && readyIds.split(" ")) || el.accessibleNameRef.split(" ");
 	const owner = ownerDocument || findNodeOwner(el);
 	let result = "";
 

package/src/util/Caret.js

@@ -0,0 +1,45 @@
+/**
+ * Returns the caret (cursor) position of the specified text field (field).
+ * Return value range is 0-field.value.length.
+ */
+const getCaretPosition = field => {
+	// Initialize
+	let caretPos = 0;
+
+	// IE Support
+	if (document.selection) {
+		// Set focus on the element
+		field.focus();
+
+		// To get cursor position, get empty selection range
+		const selection = document.selection.createRange();
+
+		// Move selection start to 0 position
+		selection.moveStart("character", -field.value.length);
+
+		// The caret position is selection length
+		caretPos = selection.text.length;
+	} else if (field.selectionStart || field.selectionStart === "0") { // Firefox support
+		caretPos = field.selectionDirection === "backward" ? field.selectionStart : field.selectionEnd;
+	}
+
+	return caretPos;
+};
+
+const setCaretPosition = (field, caretPos) => {
+	if (field.createTextRange) {
+		const range = field.createTextRange();
+		range.move("character", caretPos);
+		range.select();
+	} else if (field.selectionStart) {
+		field.focus();
+		field.setSelectionRange(caretPos, caretPos);
+	} else {
+		field.focus();
+	}
+};
+
+export {
+	getCaretPosition,
+	setCaretPosition,
+};

package/src/util/ColorConversion.js

@@ -0,0 +1,370 @@
+/**
+ *
+ * @param {String} color Color in one of the following formats: RGBA or HEX
+ */
+
+/**
+ * Map of CSS colors to hex representation
+ */
+const CSSColors = {
+	aliceblue: "f0f8ff",
+	antiquewhite: "faebd7",
+	aqua: "00ffff",
+	aquamarine: "7fffd4",
+	azure: "f0ffff",
+	beige: "f5f5dc",
+	bisque: "ffe4c4",
+	black: "000000",
+	blanchedalmond: "ffebcd",
+	blue: "0000ff",
+	blueviolet: "8a2be2",
+	brown: "a52a2a",
+	burlywood: "deb887",
+	cadetblue: "5f9ea0",
+	chartreuse: "7fff00",
+	chocolate: "d2691e",
+	coral: "ff7f50",
+	cornflowerblue: "6495ed",
+	cornsilk: "fff8dc",
+	crimson: "dc143c",
+	cyan: "00ffff",
+	darkblue: "00008b",
+	darkcyan: "008b8b",
+	darkgoldenrod: "b8860b",
+	darkgray: "a9a9a9",
+	darkgrey: "a9a9a9",
+	darkgreen: "006400",
+	darkkhaki: "bdb76b",
+	darkmagenta: "8b008b",
+	darkolivegreen: "556b2f",
+	darkorange: "ff8c00",
+	darkorchid: "9932cc",
+	darkred: "8b0000",
+	darksalmon: "e9967a",
+	darkseagreen: "8fbc8f",
+	darkslateblue: "483d8b",
+	darkslategray: "2f4f4f",
+	darkslategrey: "2f4f4f",
+	darkturquoise: "00ced1",
+	darkviolet: "9400d3",
+	deeppink: "ff1493",
+	deepskyblue: "00bfff",
+	dimgray: "696969",
+	dimgrey: "696969",
+	dodgerblue: "1e90ff",
+	firebrick: "b22222",
+	floralwhite: "fffaf0",
+	forestgreen: "228b22",
+	fuchsia: "ff00ff",
+	gainsboro: "dcdcdc",
+	ghostwhite: "f8f8ff",
+	gold: "ffd700",
+	goldenrod: "daa520",
+	gray: "808080",
+	grey: "808080",
+	green: "008000",
+	greenyellow: "adff2f",
+	honeydew: "f0fff0",
+	hotpink: "ff69b4",
+	indianred: "cd5c5c",
+	indigo: "4b0082",
+	ivory: "fffff0",
+	khaki: "f0e68c",
+	lavender: "e6e6fa",
+	lavenderblush: "fff0f5",
+	lawngreen: "7cfc00",
+	lemonchiffon: "fffacd",
+	lightblue: "add8e6",
+	lightcoral: "f08080",
+	lightcyan: "e0ffff",
+	lightgoldenrodyellow: "fafad2",
+	lightgray: "d3d3d3",
+	lightgrey: "d3d3d3",
+	lightgreen: "90ee90",
+	lightpink: "ffb6c1",
+	lightsalmon: "ffa07a",
+	lightseagreen: "20b2aa",
+	lightskyblue: "87cefa",
+	lightslategray: "778899",
+	lightslategrey: "778899",
+	lightsteelblue: "b0c4de",
+	lightyellow: "ffffe0",
+	lime: "00ff00",
+	limegreen: "32cd32",
+	linen: "faf0e6",
+	magenta: "ff00ff",
+	maroon: "800000",
+	mediumaquamarine: "66cdaa",
+	mediumblue: "0000cd",
+	mediumorchid: "ba55d3",
+	mediumpurple: "9370db",
+	mediumseagreen: "3cb371",
+	mediumslateblue: "7b68ee",
+	mediumspringgreen: "00fa9a",
+	mediumturquoise: "48d1cc",
+	mediumvioletred: "c71585",
+	midnightblue: "191970",
+	mintcream: "f5fffa",
+	mistyrose: "ffe4e1",
+	moccasin: "ffe4b5",
+	navajowhite: "ffdead",
+	navy: "000080",
+	oldlace: "fdf5e6",
+	olive: "808000",
+	olivedrab: "6b8e23",
+	orange: "ffa500",
+	orangered: "ff4500",
+	orchid: "da70d6",
+	palegoldenrod: "eee8aa",
+	palegreen: "98fb98",
+	paleturquoise: "afeeee",
+	palevioletred: "db7093",
+	papayawhip: "ffefd5",
+	peachpuff: "ffdab9",
+	peru: "cd853f",
+	pink: "ffc0cb",
+	plum: "dda0dd",
+	powderblue: "b0e0e6",
+	purple: "800080",
+	red: "ff0000",
+	rosybrown: "bc8f8f",
+	royalblue: "4169e1",
+	saddlebrown: "8b4513",
+	salmon: "fa8072",
+	sandybrown: "f4a460",
+	seagreen: "2e8b57",
+	seashell: "fff5ee",
+	sienna: "a0522d",
+	silver: "c0c0c0",
+	skyblue: "87ceeb",
+	slateblue: "6a5acd",
+	slategray: "708090",
+	slategrey: "708090",
+	snow: "fffafa",
+	springgreen: "00ff7f",
+	steelblue: "4682b4",
+	tan: "d2b48c",
+	teal: "008080",
+	thistle: "d8bfd8",
+	tomato: "ff6347",
+	turquoise: "40e0d0",
+	violet: "ee82ee",
+	wheat: "f5deb3",
+	white: "ffffff",
+	whitesmoke: "f5f5f5",
+	yellow: "ffff00",
+	yellowgreen: "9acd32",
+	transparent: "00000000",
+};
+
+const getRGBColor = color => {
+	if (color.startsWith("rgba")) {
+		return RGBAToRGB(color);
+	}
+
+	if (color.startsWith("rgb")) {
+		return RGBToRGB(color);
+	}
+
+	// HEX
+	if (color.indexOf("#") === 0) {
+		// Shorthand Syntax
+		if (color.length === 4) {
+			color = `${color[1]}${color[1]}${color[2]}${color[2]}${color[3]}${color[3]}`;
+		} else {
+			color = color.slice(1, color.length);
+		}
+	}
+
+	// Css Color
+	if (Object.keys(CSSColors).includes(color)) {
+		color = CSSColors[color];
+	}
+
+	return HEXToRGB(color);
+};
+
+/**
+ * Return an object with the properties for each of the main colors(red, green, blue)
+ * @param {String} color Receives a color in the following format: "rgba(0, 0, 0, 1)
+ */
+const RGBAToRGB = color => {
+	const openingBracketIndex = color.indexOf("("),
+		commasIndexes = [];
+
+	for (let i = 0; i < color.length; i++) {
+		if (color[i] === ",") {
+			commasIndexes.push(i);
+		}
+	}
+
+	return {
+		r: parseInt(color.slice(openingBracketIndex + 1, commasIndexes[0]).trim()),
+		g: parseInt(color.slice(commasIndexes[0] + 1, commasIndexes[1]).trim()),
+		b: parseInt(color.slice(commasIndexes[1] + 1, commasIndexes[2]).trim()),
+	};
+};
+
+/**
+ * Return an object with the properties for each of the main colors(red, green, blue)
+ * @param {String} color Receives a color in the following format: "rgb(0, 0, 0)
+ */
+const RGBToRGB = color => {
+	const openingBracketIndex = color.indexOf("("),
+		closingBraketIndex = color.indexOf(")"),
+		commasIndexes = [];
+
+	for (let i = 0; i < color.length; i++) {
+		if (color[i] === ",") {
+			commasIndexes.push(i);
+		}
+	}
+
+	return {
+		r: parseInt(color.slice(openingBracketIndex + 1, commasIndexes[0]).trim()),
+		g: parseInt(color.slice(commasIndexes[0] + 1, commasIndexes[1]).trim()),
+		b: parseInt(color.slice(commasIndexes[1] + 1, closingBraketIndex).trim()),
+	};
+};
+
+const HSLToRGB = (color = {
+	h: undefined,
+	s: undefined,
+	l: undefined,
+}) => {
+	// Formula taken from https://www.rapidtables.com/convert/color/hsl-to-rgb.html
+	const C = (1 - Math.abs((2 * color.l) - 1)) * color.s,
+		X = C * (1 - Math.abs(((color.h / 60) % 2) - 1)),
+		m = color.l - C / 2;
+
+	let tempColor = {};
+	switch (Math.round(color.h / 60)) {
+	// 0 ≤ H < 60
+	case 0:
+		tempColor = {
+			r: C,
+			g: X,
+			b: 0,
+		};
+		break;
+
+	// 60 ≤ H < 120
+	case 1:
+		tempColor = {
+			r: X,
+			g: C,
+			b: 0,
+		};
+		break;
+
+	// 120 ≤ H < 180
+	case 2:
+		tempColor = {
+			r: 0,
+			g: C,
+			b: X,
+		};
+		break;
+
+	// 180 ≤ H < 240
+	case 3:
+		tempColor = {
+			r: 0,
+			g: X,
+			b: C,
+		};
+		break;
+
+	// 240 ≤ H < 300
+	case 4:
+		tempColor = {
+			r: X,
+			g: 0,
+			b: C,
+		};
+		break;
+
+	// 300 ≤ H < 360
+	default:
+		tempColor = {
+			r: C,
+			g: 0,
+			b: X,
+		};
+	}
+
+	return {
+		r: Math.floor((tempColor.r + m) * 255),
+		g: Math.floor((tempColor.g + m) * 255),
+		b: Math.floor((tempColor.b + m) * 255),
+	};
+};
+
+const HEXToRGB = hex => {
+	// Please make sure you pass a valid 6 digit hex color
+	// In the implementation of this method we assume that the hex argument is a 6 digit valid hex color
+
+	const rgbValues = {
+		r: hex.substr(0, 2),
+		g: hex.substr(2, 2),
+		b: hex.substr(4, 2),
+	};
+
+	const rgbKeys = Object.keys(rgbValues);
+
+	rgbKeys.forEach(key => {
+		rgbValues[key] = parseInt(rgbValues[key], 16);
+	});
+
+	return rgbValues;
+};
+
+const RGBToHSL = (color = {
+	r: undefined,
+	g: undefined,
+	b: undefined,
+}) => {
+	const R = color.r / 255,
+		G = color.g / 255,
+		B = color.b / 255,
+		max = Math.max(R, G, B),
+		min = Math.min(R, G, B),
+		delta = max - min;
+
+	let h,
+		s;
+
+	// Hue calculation
+	if (delta === 0) {
+		h = 0;
+	} else if (max === R) {
+		h = 60 * (((G - B) / delta) % 6);
+	} else if (max === G) {
+		h = 60 * (((B - R) / delta) + 2);
+	} else if (max === B) {
+		h = 60 * (((R - G) / delta) + 4);
+	}
+
+	// Lightness calculation
+	const l = (max + min) / 2;
+
+	// Saturation calculation
+	if (delta === 0) {
+		s = 0;
+	} else {
+		s = delta / (1 - Math.abs(2 * l - 1));
+	}
+
+	return {
+		h,
+		s,
+		l,
+	};
+};
+
+export {
+	getRGBColor,
+	HSLToRGB,
+	HEXToRGB,
+	RGBToHSL,
+};

package/src/util/FocusableElements.js

@@ -5,7 +5,7 @@ const isFocusTrap = el => {
 	return el.hasAttribute("data-ui5-focus-trap");
 };
 
-const getFirstFocusableElement = container => {
+const getFirstFocusableElement = async container => {
 	if (!container || isNodeHidden(container)) {
 		return null;
 	}
@@ -13,7 +13,7 @@ const getFirstFocusableElement = container => {
 	return findFocusableElement(container, true);
 };
 
-const getLastFocusableElement = container => {
+const getLastFocusableElement = async container => {
 	if (!container || isNodeHidden(container)) {
 		return null;
 	}
@@ -21,7 +21,11 @@ const getLastFocusableElement = container => {
 	return findFocusableElement(container, false);
 };
 
-const findFocusableElement = (container, forward) => {
+const isElemFocusable = el => {
+	return el.hasAttribute("data-ui5-focus-redirect") || !isNodeHidden(el);
+};
+
+const findFocusableElement = async (container, forward) => {
 	let child;
 
 	if (container.shadowRoot) {
@@ -35,20 +39,25 @@ const findFocusableElement = (container, forward) => {
 
 	let focusableDescendant;
 
+	/* eslint-disable no-await-in-loop */
+
 	while (child) {
 		const originalChild = child;
 
-		child = child.isUI5Element ? child.getFocusDomRef() : child;
+		if (child.isUI5Element) {
+			child = await child.getFocusDomRefAsync();
+		}
+
 		if (!child) {
 			return null;
 		}
 
-		if (child.nodeType === 1 && !isNodeHidden(child) && !isFocusTrap(child)) {
+		if (child.nodeType === 1 && isElemFocusable(child) && !isFocusTrap(child)) {
 			if (isNodeClickable(child)) {
 				return (child && typeof child.focus === "function") ? child : null;
 			}
 
-			focusableDescendant = findFocusableElement(child, forward);
+			focusableDescendant = await findFocusableElement(child, forward);
 			if (focusableDescendant) {
 				return (focusableDescendant && typeof focusableDescendant.focus === "function") ? focusableDescendant : null;
 			}
@@ -57,6 +66,8 @@ const findFocusableElement = (container, forward) => {
 		child = forward ? originalChild.nextSibling : originalChild.previousSibling;
 	}
 
+	/* eslint-enable no-await-in-loop */
+
 	return null;
 };
 

package/src/util/HTMLSanitizer.js

@@ -0,0 +1,7 @@
+import sanitizeHTML from "../sap/base/security/sanitizeHTML.js";
+import URLListValidator from "../sap/base/security/URLListValidator.js";
+
+export {
+	URLListValidator,
+	sanitizeHTML,
+};

package/src/util/InvisibleMessage.js

@@ -0,0 +1,58 @@
+import InvisibleMessageMode from "../types/InvisibleMessageMode.js";
+import getSingletonElementInstance from "./getSingletonElementInstance.js";
+import { attachBoot } from "../Boot.js";
+
+let politeSpan;
+let assertiveSpan;
+
+attachBoot(() => {
+	if (politeSpan && assertiveSpan) {
+		return;
+	}
+
+	const styles = `position: absolute;
+	clip: rect(1px,1px,1px,1px);
+	user-select: none;
+	left: -1000px;
+	top: -1000px;
+	pointer-events: none;`;
+
+	politeSpan = document.createElement("span");
+	assertiveSpan = document.createElement("span");
+
+	politeSpan.classList.add("ui5-invisiblemessage-polite");
+	assertiveSpan.classList.add("ui5-invisiblemessage-assertive");
+
+	politeSpan.setAttribute("aria-live", "polite");
+	assertiveSpan.setAttribute("aria-live", "assertive");
+
+	politeSpan.setAttribute("role", "alert");
+	assertiveSpan.setAttribute("role", "alert");
+
+	politeSpan.style.cssText = styles;
+	assertiveSpan.style.cssText = styles;
+
+	getSingletonElementInstance("ui5-static-area").appendChild(politeSpan);
+	getSingletonElementInstance("ui5-static-area").appendChild(assertiveSpan);
+});
+
+/**
+ * Inserts the string into the respective span, depending on the mode provided.
+ *
+ * @param {string} message String to be announced by the screen reader.
+ * @param {sap.ui.core.InvisibleMessageMode} mode The mode to be inserted in the aria-live attribute.
+ */
+const announce = (message, mode) => {
+	// If no type is presented, fallback to polite announcement.
+	const span = mode === InvisibleMessageMode.Assertive ? assertiveSpan : politeSpan;
+
+	// Set textContent to empty string in order to trigger screen reader's announcement.
+	span.textContent = "";
+	span.textContent = message;
+
+	if (mode !== InvisibleMessageMode.Assertive && mode !== InvisibleMessageMode.Polite) {
+		console.warn(`You have entered an invalid mode. Valid values are: "Polite" and "Assertive". The framework will automatically set the mode to "Polite".`); // eslint-disable-line
+	}
+};
+
+export default announce;