@ui5/webcomponents 1.0.0-rc.6 → 1.0.0

package/dist/GroupHeaderListItem.js

@@ -1,6 +1,8 @@
-import litRender from "@ui5/webcomponents-base/dist/renderer/LitRenderer.js";
+import { getI18nBundle } from "@ui5/webcomponents-base/dist/i18nBundle.js";
 import ListItemBase from "./ListItemBase.js";
 
+import { GROUP_HEADER_TEXT } from "./generated/i18n/i18n-defaults.js";
+
 // Template
 import GroupHeaderListItemTemplate from "./generated/templates/GroupHeaderListItemTemplate.lit.js";
 
@@ -12,13 +14,26 @@ import groupheaderListItemCss from "./generated/themes/GroupHeaderListItem.css.j
  */
 const metadata = {
 	tag: "ui5-li-groupheader",
+	languageAware: true,
 	properties: /** @lends  sap.ui.webcomponents.main.GroupHeaderListItem.prototype */ {
+		/**
+		 * Defines the text alternative of the component.
+		 * Note: If not provided a default text alternative will be set, if present.
+		 *
+		 * @type {string}
+		 * @defaultvalue ""
+		 * @public
+		 * @since 1.0.0-rc.15
+		 */
+		accessibleName: {
+			type: String,
+		},
 	},
 	slots: /** @lends sap.ui.webcomponents.main.GroupHeaderListItem.prototype */ {
 		/**
-		 * Defines the text of the <code>ui5-li-groupheader</code>.
+		 * Defines the text of the component.
 		 * <br>
-		 * <b>Note:</b> Аlthough this slot accepts HTML Elements, it is strongly recommended that you only use text in order to preserve the intended design.
+		 * <b>Note:</b> Although this slot accepts HTML Elements, it is strongly recommended that you only use text in order to preserve the intended design.
 		 *
 		 * @type {Node[]}
 		 * @slot
@@ -34,20 +49,17 @@ const metadata = {
 
 /**
  * @class
- * The <code>ui5-li-group-header</code> is a special list item, used only to separate other list items into logical groups.
+ * The <code>ui5-li-groupheader</code> is a special list item, used only to separate other list items into logical groups.
  *
  * @constructor
  * @author SAP SE
  * @alias sap.ui.webcomponents.main.GroupHeaderListItem
  * @extends ListItemBase
  * @tagname ui5-li-groupheader
+ * @implements sap.ui.webcomponents.main.IListItem
  * @public
  */
 class GroupHeaderListItem extends ListItemBase {
-	static get render() {
-		return litRender;
-	}
-
 	static get template() {
 		return GroupHeaderListItemTemplate;
 	}
@@ -63,6 +75,18 @@ class GroupHeaderListItem extends ListItemBase {
 	get group() {
 		return true;
 	}
+
+	get groupHeaderText() {
+		return GroupHeaderListItem.i18nBundle.getText(GROUP_HEADER_TEXT);
+	}
+
+	get ariaLabelText() {
+		return [this.textContent, this.accessibleName].filter(Boolean).join(" ");
+	}
+
+	static async onDefine() {
+		GroupHeaderListItem.i18nBundle = await getI18nBundle("@ui5/webcomponents");
+	}
 }
 
 GroupHeaderListItem.define();

package/dist/Icon.js

@@ -1,32 +1,57 @@
 import UI5Element from "@ui5/webcomponents-base/dist/UI5Element.js";
 import litRender from "@ui5/webcomponents-base/dist/renderer/LitRenderer.js";
-import { getRTL } from "@ui5/webcomponents-base/dist/config/RTL.js";
-import { getIconData, getIconDataSync } from "@ui5/webcomponents-base/dist/SVGIconRegistry.js";
+import { getIconData, getIconDataSync } from "@ui5/webcomponents-base/dist/asset-registries/Icons.js";
 import createStyleInHead from "@ui5/webcomponents-base/dist/util/createStyleInHead.js";
-import { fetchI18nBundle, getI18nBundle } from "@ui5/webcomponents-base/dist/i18nBundle.js";
+import { getI18nBundle } from "@ui5/webcomponents-base/dist/i18nBundle.js";
+import { isSpace, isEnter } from "@ui5/webcomponents-base/dist/Keys.js";
+import isLegacyBrowser from "@ui5/webcomponents-base/dist/isLegacyBrowser.js";
 import IconTemplate from "./generated/templates/IconTemplate.lit.js";
 
 // Styles
 import iconCss from "./generated/themes/Icon.css.js";
 
 const ICON_NOT_FOUND = "ICON_NOT_FOUND";
+const PRESENTATION_ROLE = "presentation";
 
 /**
  * @public
  */
 const metadata = {
 	tag: "ui5-icon",
+	languageAware: true,
+	themeAware: true,
 	properties: /** @lends sap.ui.webcomponents.main.Icon.prototype */ {
 		/**
-		 * Defines the unique identifier (icon name) of each <code>ui5-icon</code>.
-		 * <br><br>
+		 * Defines if the icon is interactive (focusable and pressable)
+		 * @type {boolean}
+		 * @defaultvalue false
+		 * @public
+		 * @since 1.0.0-rc.8
+		 */
+		interactive: {
+			type: Boolean,
+		},
+
+		/**
+		 * Defines the unique identifier (icon name) of the component.
+		 * <br>
+		 *
 		 * To browse all available icons, see the
 		 * <ui5-link target="_blank" href="https://openui5.hana.ondemand.com/test-resources/sap/m/demokit/iconExplorer/webapp/index.html" class="api-table-content-cell-link">Icon Explorer</ui5-link>.
-		 * <br><br>
+		 * <br>
+		 *
 		 * Example:
 		 * <br>
 		 * <code>name='add'</code>, <code>name='delete'</code>, <code>name='employee'</code>.
+		 * <br><br>
+		 *
+		 * <b>Note:</b> To use the SAP Fiori Tools icons,
+		 * you need to set the <code>tnt</code> prefix in front of the icon's name.
+		 * <br>
 		 *
+		 * Example:
+		 * <br>
+		 * <code>name='tnt/antenna'</code>, <code>name='tnt/actor'</code>, <code>name='tnt/api'</code>.
 		 * @type {string}
 		 * @defaultvalue ""
 		 * @public
@@ -36,7 +61,7 @@ const metadata = {
 		},
 
 		/**
-		 * Defines the text alternative of the <code>ui5-icon</code>.
+		 * Defines the text alternative of the component.
 		 * If not provided a default text alternative will be set, if present.
 		 * <br><br>
 		 * <b>Note:</b> Every icon should have a text alternative in order to
@@ -51,7 +76,7 @@ const metadata = {
 		},
 
 		/**
-		 * Defines whether the <code>ui5-icon</code> should have a tooltip.
+		 * Defines whether the component should have a tooltip.
 		 *
 		 * @type {boolean}
 		 * @defaultvalue false
@@ -61,6 +86,26 @@ const metadata = {
 			type: Boolean,
 		},
 
+		/**
+		 * Defines the accessibility role of the component.
+		 * @defaultvalue ""
+		 * @private
+		 * @since 1.0.0-rc.15
+		 */
+		role: {
+			type: String,
+		},
+
+		/**
+		 * Defines the aria hidden state of the component.
+		 * Note: If the role is presentation the default value of aria-hidden will be true.
+		 * @private
+		 * @since 1.0.0-rc.15
+		 */
+		ariaHidden: {
+			type: String,
+		},
+
 		/**
 		 * @private
 		 */
@@ -77,14 +122,36 @@ const metadata = {
 			noAttribute: true,
 		},
 
+		/**
+		 * @private
+		 */
+		focused: {
+			type: Boolean,
+		},
+
 		/**
 		* @private
 		*/
 		invalid: {
 			type: Boolean,
 		},
+
+		/**
+		 * @private
+		 */
+		effectiveAccessibleName: {
+			type: String,
+			defaultValue: undefined,
+			noAttribute: true,
+		},
 	},
-	events: {
+	events: /** @lends sap.ui.webcomponents.main.Icon.prototype */ {
+		/**
+		 * Fired on mouseup, space and enter if icon is interactive
+		 * @private
+		 * @since 1.0.0-rc.8
+		 */
+		click: {},
 	},
 };
 
@@ -98,6 +165,26 @@ const metadata = {
  * <br><br>
  * A large set of built-in icons is available
  * and they can be used by setting the <code>name</code> property on the <code>ui5-icon</code>.
+ * But before using an icon, you need to import the desired icon.
+ * <br>
+ *
+ * For the standard icon collection, you have to import an icon from the <code>@ui5/webcomponents-icons</code> package:
+ * <br>
+ * <code>import "@ui5/webcomponents-icons/dist/employee.js";</code>
+ * <br>
+ *
+ * For the SAP Fiori Tools icon collection (supported since 1.0.0-rc.10), you have to import an icon from the <code>@ui5/webcomponents-icons-tnt</code> package:
+ * <br>
+ * <code>import "@ui5/webcomponents-icons-tnt/dist/antenna.js";</code>
+ *
+ * <br><br>
+ * <h3>Keyboard Handling</h3>
+ *
+ * <ul>
+ * <li>[SPACE, ENTER, RETURN] - Fires the <code>click</code> event if the <code>interactive</code> property is set to true.</li>
+ * <li>[SHIFT] - If [SPACE] or [ENTER],[RETURN] is pressed, pressing [SHIFT] releases the ui5-icon without triggering the click event.</li>
+ * </ul>
+ * <br><br>
  *
  * <h3>ES6 Module Import</h3>
  *
@@ -108,14 +195,10 @@ const metadata = {
  * @alias sap.ui.webcomponents.main.Icon
  * @extends sap.ui.webcomponents.base.UI5Element
  * @tagname ui5-icon
+ * @implements sap.ui.webcomponents.main.IIcon
  * @public
  */
 class Icon extends UI5Element {
-	constructor() {
-		super();
-		this.i18nBundle = getI18nBundle("@ui5/webcomponents");
-	}
-
 	static get metadata() {
 		return metadata;
 	}
@@ -134,26 +217,103 @@ class Icon extends UI5Element {
 
 	static async onDefine() {
 		this.createGlobalStyle(); // hide all icons until the first icon has rendered (and added the Icon.css)
-		await fetchI18nBundle("@ui5/webcomponents");
 	}
 
-	static createGlobalStyle() {
-		if (!window.ShadyDOM) {
+	_onfocusin(event) {
+		if (this.interactive) {
+			this.focused = true;
+		}
+	}
+
+	_onfocusout(event) {
+		this.focused = false;
+	}
+
+	_onkeydown(event) {
+		if (!this.interactive) {
 			return;
 		}
-		const styleElement = document.head.querySelector(`style[data-ui5-icon-global]`);
-		if (!styleElement) {
-			createStyleInHead(`ui5-icon { display: none !important; }`, { "data-ui5-icon-global": "" });
+
+		if (isEnter(event)) {
+			this.fireEvent("click");
+		}
+
+		if (isSpace(event)) {
+			event.preventDefault(); // prevent scrolling
 		}
 	}
 
-	static removeGlobalStyle() {
-		if (!window.ShadyDOM) {
+	_onkeyup(event) {
+		if (this.interactive && isSpace(event)) {
+			this.fireEvent("click");
+		}
+	}
+
+	_onClickHandler(event) {
+		// prevent the native event and fire custom event to ensure the noConfict "ui5-click" is fired
+		event.stopPropagation();
+		this.fireEvent("click");
+	}
+
+	get _dir() {
+		if (!this.effectiveDir) {
 			return;
 		}
-		const styleElement = document.head.querySelector(`style[data-ui5-icon-global]`);
-		if (styleElement) {
-			document.head.removeChild(styleElement);
+
+		if (this.ltr) {
+			return "ltr";
+		}
+
+		return this.effectiveDir;
+	}
+
+	get effectiveAriaHidden() {
+		if (this.ariaHidden === "") {
+			if (this.isDecorative) {
+				return true;
+			}
+
+			return;
+		}
+
+		return this.ariaHidden;
+	}
+
+	get tabIndex() {
+		return this.interactive ? "0" : "-1";
+	}
+
+	get isDecorative() {
+		return this.effectiveAccessibleRole === PRESENTATION_ROLE;
+	}
+
+	get effectiveAccessibleRole() {
+		if (this.role) {
+			return this.role;
+		}
+
+		if (this.interactive) {
+			return "button";
+		}
+
+		return this.effectiveAccessibleName ? "img" : PRESENTATION_ROLE;
+	}
+
+	static createGlobalStyle() {
+		if (isLegacyBrowser()) {
+			const styleElement = document.head.querySelector(`style[data-ui5-icon-global]`);
+			if (!styleElement) {
+				createStyleInHead(`ui5-icon { display: none !important; }`, { "data-ui5-icon-global": "" });
+			}
+		}
+	}
+
+	static removeGlobalStyle() {
+		if (isLegacyBrowser()) {
+			const styleElement = document.head.querySelector(`style[data-ui5-icon-global]`);
+			if (styleElement) {
+				document.head.removeChild(styleElement);
+			}
 		}
 	}
 
@@ -171,7 +331,7 @@ class Icon extends UI5Element {
 		if (iconData === ICON_NOT_FOUND) {
 			this.invalid = true;
 			/* eslint-disable-next-line */
-			return console.warn(`Required icon is not registered. You can either import the icon as a module in order to use it e.g. "@ui5/webcomponents-icons/dist/icons/${name.replace("sap-icon://", "")}.js", or setup a JSON build step and import "@ui5/webcomponents-icons/dist/Assets.js".`);
+			return console.warn(`Required icon is not registered. You can either import the icon as a module in order to use it e.g. "@ui5/webcomponents-icons/dist/${name.replace("sap-icon://", "")}.js", or setup a JSON build step and import "@ui5/webcomponents-icons/dist/AllIcons.js".`);
 		}
 
 		if (!iconData) {
@@ -180,24 +340,25 @@ class Icon extends UI5Element {
 			return console.warn(`Required icon is not registered. Invalid icon name: ${this.name}`);
 		}
 
+		// in case a new valid name is set, show the icon
+		this.invalid = false;
 		this.pathData = iconData.pathData;
 		this.accData = iconData.accData;
-	}
+		this.ltr = iconData.ltr;
+		this.packageName = iconData.packageName;
 
-	get hasIconTooltip() {
-		return this.showTooltip && this.accessibleNameText;
-	}
+		this._onclick = this.interactive ? this._onClickHandler.bind(this) : undefined;
 
-	get accessibleNameText() {
 		if (this.accessibleName) {
-			return this.accessibleName;
+			this.effectiveAccessibleName = this.accessibleName;
+		} else if (this.accData) {
+			const i18nBundle = await getI18nBundle(this.packageName);
+			this.effectiveAccessibleName = i18nBundle.getText(this.accData) || undefined;
 		}
-
-		return this.i18nBundle.getText(this.accData) || undefined;
 	}
 
-	get dir() {
-		return getRTL() ? "rtl" : "ltr";
+	get hasIconTooltip() {
+		return this.showTooltip && this.effectiveAccessibleName;
 	}
 
 	async onEnterDOM() {