@ui5/webcomponents 1.0.0-rc.8 → 1.0.2

package/src/Card.js

@@ -1,16 +1,13 @@
 import UI5Element from "@ui5/webcomponents-base/dist/UI5Element.js";
 import litRender from "@ui5/webcomponents-base/dist/renderer/LitRenderer.js";
-import { fetchI18nBundle, getI18nBundle } from "@ui5/webcomponents-base/dist/i18nBundle.js";
-import { isSpace, isEnter } from "@ui5/webcomponents-base/dist/Keys.js";
+import { getI18nBundle } from "@ui5/webcomponents-base/dist/i18nBundle.js";
+import { getEffectiveAriaLabelText } from "@ui5/webcomponents-base/dist/util/AriaLabelHelper.js";
 import CardTemplate from "./generated/templates/CardTemplate.lit.js";
 import Icon from "./Icon.js";
 
 import {
 	ARIA_ROLEDESCRIPTION_CARD,
-	AVATAR_TOOLTIP,
 	ARIA_LABEL_CARD_CONTENT,
-	ARIA_ROLEDESCRIPTION_CARD_HEADER,
-	ARIA_ROLEDESCRIPTION_INTERACTIVE_CARD_HEADER,
 } from "./generated/i18n/i18n-defaults.js";
 
 // Styles
@@ -26,9 +23,9 @@ const metadata = {
 	slots: /** @lends sap.ui.webcomponents.main.Card.prototype */ {
 
 		/**
-		 * Defines the content of the <code>ui5-card</code>.
+		 * Defines the content of the component.
 		 * @type {HTMLElement[]}
-		 * @slot
+		 * @slot content
 		 * @public
 		 */
 		"default": {
@@ -37,97 +34,48 @@ const metadata = {
 		},
 
 		/**
-		 * Defines the visual representation in the header of the card.
-		 * Supports images and icons.
+		 * Defines the header of the component.
 		 * <br><br>
-		 * <b>Note:</b>
-		 * SAP-icons font provides numerous options. To find all the 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>.
+		 * <b>Note:</b> Use <code>ui5-card-header</code> for the intended design.
 		 * @type {HTMLElement[]}
-		 * @slot
+		 * @since 1.0.0-rc.15
+		 * @slot content
 		 * @public
 		 */
-		avatar: {
-			type: HTMLElement,
-		},
-
-		/**
-		 * Defines an action, displayed in the right most part of the header.
-		 * <br><br>
-		 * <b>Note:</b> If set, the <code>status</code> text will not be displayed,
-		 * you can either have <code>action</code>, or <code>status</code>.
-		 * @type {HTMLElement[]}
-		 * @slot
-		 * @public
-		 * @since 1.0.0-rc.8
-		 */
-		action: {
+		header: {
 			type: HTMLElement,
 		},
 	},
 	properties: /** @lends sap.ui.webcomponents.main.Card.prototype */ {
 
 		/**
-		 * Defines the title displayed in the <code>ui5-card</code> header.
-		 * @type {string}
-		 * @defaultvalue ""
-		 * @public
-		 */
-		heading: {
-			type: String,
-		},
-
-		/**
-		 * Defines the subheading displayed in the <code>ui5-card</code> header.
-		 * @type {string}
+		 * Defines the accessible name of the component, which is used as the name of the card region and should be unique per card.
+		 * <b>Note:</b> <code>accessibleName</code> should be always set, unless <code>accessibleNameRef</code> is set.
+		 *
+		 *
+		 * @type {String}
 		 * @defaultvalue ""
 		 * @public
+		 * @since 1.0.0-rc.16
 		 */
-		subheading: {
+		accessibleName: {
 			type: String,
 		},
 
 		/**
-		 * Defines the status displayed in the <code>ui5-card</code> header.
-		 * <br><br>
-		 * <b>Note:</b> If the <code>action</code> slot is set, the <code>status</code> will not be displayed,
-		 * you can either have <code>action</code>, or <code>status</code>.
-		 * @type {string}
+		 * Defines the IDs of the elements that label the component.
+		 *
+		 * @type {String}
 		 * @defaultvalue ""
 		 * @public
+		 * @since 1.0.0-rc.16
 		 */
-		status: {
+		accessibleNameRef: {
 			type: String,
 		},
-
-		/**
-		 * Defines if the <code>ui5-card</code> header would be interactive,
-		 * e.g gets hover effect, gets focused and <code>headerPress</code> event is fired, when it is pressed.
-		 * @type {boolean}
-		 * @defaultvalue false
-		 * @public
-		 */
-		headerInteractive: {
-			type: Boolean,
-		},
-
-		_headerActive: {
-			type: Boolean,
-			noAttribute: true,
-		},
 	},
 	events: /** @lends sap.ui.webcomponents.main.Card.prototype */ {
 
-		/**
-		 * Fired when the <code>ui5-card</code> header is activated
-		 * by mouse/tap or by using the Enter or Space key.
-		 * <br><br>
-		 * <b>Note:</b> The event would be fired only if the <code>headerInteractive</code> property is set to true.
-		 * @event sap.ui.webcomponents.main.Card#header-click
-		 * @public
-		 * @since 0.10.0
-		 */
-		"header-click": {},
 	},
 };
 
@@ -138,15 +86,19 @@ const metadata = {
  * The <code>ui5-card</code> is a component that represents information in the form of a
  * tile with separate header and content areas.
  * The content area of a <code>ui5-card</code> can be arbitrary HTML content.
- * The header can be used through several properties, such as: <code>heading</code>, <code>subheading</code>, <code>status</code>
- * and two slots: <code>avatar</code> and <code>action</code>.
+ * The header can be used through slot <code>header</code>. For which there is a <code>ui5-card-header</code> component to achieve the card look and fill.
  *
- * <h3>Keyboard handling</h3>
- * In case you enable <code>headerInteractive</code> property, you can press the <code>ui5-card</code> header by Space and Enter keys.
+ * Note: We recommend the usage of <code>ui5-card-header</code> for the header slot, so advantage can be taken for keyboard handling, styling and accessibility.
+ *
+ * <h3>CSS Shadow Parts</h3>
+ *
+ * <ui5-link target="_blank" href="https://developer.mozilla.org/en-US/docs/Web/CSS/::part">CSS Shadow Parts</ui5-link> allow developers to style elements inside the Shadow DOM.
  *
  * <h3>ES6 Module Import</h3>
  *
  * <code>import "@ui5/webcomponents/dist/Card";</code>
+ * <br>
+ * <code>import "@ui5/webcomponents/dist/CardHeader.js";</code> (for <code>ui5-card-header</code>)
  *
  * @constructor
  * @author SAP SE
@@ -154,14 +106,9 @@ const metadata = {
  * @extends sap.ui.webcomponents.base.UI5Element
  * @tagname ui5-card
  * @public
+ * @appenddocs CardHeader
  */
 class Card extends UI5Element {
-	constructor() {
-		super();
-
-		this.i18nBundle = getI18nBundle("@ui5/webcomponents");
-	}
-
 	static get metadata() {
 		return metadata;
 	}
@@ -180,107 +127,31 @@ class Card extends UI5Element {
 
 	get classes() {
 		return {
-			main: {
-				"ui5-card-root": true,
-				"ui5-card--nocontent": !this.content.length,
-			},
-			header: {
-				"ui5-card-header": true,
-				"ui5-card-header--interactive": this.headerInteractive,
-				"ui5-card-header--active": this.headerInteractive && this._headerActive,
-			},
+			"ui5-card-root": true,
+			"ui5-card--nocontent": !this.content.length,
 		};
 	}
 
-	get icon() {
-		return !!this.avatar && this.avatar.startsWith("sap-icon://");
-	}
-
-	get image() {
-		return !!this.avatar && !this.icon;
-	}
-
-	get ariaHeaderRole() {
-		return this.headerInteractive ? "button" : "heading";
-	}
-
-	get ariaLevel() {
-		return this.headerInteractive ? undefined : "3";
+	get _hasHeader() {
+		return !!this.header.length;
 	}
 
-	get hasHeader() {
-		return !!(this.heading || this.subheading || this.status || this.hasAction || this.avatar);
+	get _getAriaLabel() {
+		const effectiveAriaLabelText = getEffectiveAriaLabelText(this),
+			effectiveAriaLabel = effectiveAriaLabelText ? ` ${effectiveAriaLabelText}` : "";
+		return Card.i18nBundle.getText(ARIA_ROLEDESCRIPTION_CARD) + effectiveAriaLabel;
 	}
 
-	get ariaCardRoleDescription() {
-		return this.i18nBundle.getText(ARIA_ROLEDESCRIPTION_CARD);
+	get _ariaCardContentLabel() {
+		return Card.i18nBundle.getText(ARIA_LABEL_CARD_CONTENT);
 	}
 
-	get ariaCardHeaderRoleDescription() {
-		return this.headerInteractive ? this.i18nBundle.getText(ARIA_ROLEDESCRIPTION_INTERACTIVE_CARD_HEADER) : this.i18nBundle.getText(ARIA_ROLEDESCRIPTION_CARD_HEADER);
-	}
-
-	get ariaCardAvatarLabel() {
-		return this.i18nBundle.getText(AVATAR_TOOLTIP);
-	}
-
-	get ariaCardContentLabel() {
-		return this.i18nBundle.getText(ARIA_LABEL_CARD_CONTENT);
-	}
-
-	get hasAvatar() {
-		return !!this.avatar.length;
-	}
-
-	get hasAction() {
-		return !!this.action.length;
+	static get dependencies() {
+		return [Icon];
 	}
 
 	static async onDefine() {
-		await Promise.all([
-			Icon.define(),
-			fetchI18nBundle("@ui5/webcomponents"),
-		]);
-	}
-
-	_headerClick() {
-		if (this.headerInteractive) {
-			this.fireEvent("header-click");
-		}
-	}
-
-	_headerKeydown(event) {
-		if (!this.headerInteractive) {
-			return;
-		}
-
-		const enter = isEnter(event);
-		const space = isSpace(event);
-
-		this._headerActive = enter || space;
-
-		if (enter) {
-			this.fireEvent("header-click");
-			return;
-		}
-
-		if (space) {
-			event.preventDefault();
-		}
-	}
-
-	_headerKeyup(event) {
-		if (!this.headerInteractive) {
-			return;
-		}
-
-		const space = isSpace(event);
-
-		this._headerActive = false;
-
-		if (space) {
-			this.fireEvent("header-click");
-		}
+		Card.i18nBundle = await getI18nBundle("@ui5/webcomponents");
 	}
 }
 

package/src/CardHeader.hbs

@@ -0,0 +1,35 @@
+<div
+	class="{{classes}}"
+	dir="{{effectiveDir}}"
+	@click="{{_headerClick}}"
+	@keydown="{{_headerKeydown}}"
+	@keyup="{{_headerKeyup}}"
+	role="{{ariaHeaderRole}}"
+	aria-labelledby="{{ariaLabelledByHeader}}"
+	aria-level="{{_ariaLevel}}"
+	aria-roledescription="{{ariaCardHeaderRoleDescription}}"
+	tabindex="0"
+	id="{{_id}}--header"
+>
+	{{#if hasAvatar}}
+		<div id="{{_id}}-avatar" class="ui5-card-header-avatar" aria-label="{{ariaCardAvatarLabel}}">
+			<slot name="avatar"></slot>
+		</div>
+	{{/if}}
+
+	<div class="ui5-card-header-text">
+		{{#if titleText}}
+			<div id="{{_id}}-title" class="ui5-card-header-title" part="title">{{titleText}}</div>
+		{{/if}}
+
+		{{#if subtitleText}}
+			<div id="{{_id}}-subtitle" class="ui5-card-header-subtitle" part="subtitle">{{subtitleText}}</div>
+		{{/if}}
+	</div>
+
+	{{#if hasAction}}
+		<slot name="action"></slot>
+	{{else}}
+		<span id="{{_id}}-status" part="status" class="ui5-card-header-status" dir="auto">{{status}}</span>
+	{{/if}}
+</div>

package/src/CardHeader.js

@@ -0,0 +1,288 @@
+import UI5Element from "@ui5/webcomponents-base/dist/UI5Element.js";
+import litRender from "@ui5/webcomponents-base/dist/renderer/LitRenderer.js";
+import { getI18nBundle } from "@ui5/webcomponents-base/dist/i18nBundle.js";
+import { isSpace, isEnter } from "@ui5/webcomponents-base/dist/Keys.js";
+import Integer from "@ui5/webcomponents-base/dist/types/Integer.js";
+import CardHeaderTemplate from "./generated/templates/CardHeaderTemplate.lit.js";
+import Icon from "./Icon.js";
+
+import {
+	AVATAR_TOOLTIP,
+	ARIA_ROLEDESCRIPTION_CARD_HEADER,
+	ARIA_ROLEDESCRIPTION_INTERACTIVE_CARD_HEADER,
+} from "./generated/i18n/i18n-defaults.js";
+
+// Styles
+import cardHeaderCss from "./generated/themes/CardHeader.css.js";
+
+/**
+ * @public
+ */
+const metadata = {
+	tag: "ui5-card-header",
+	languageAware: true,
+	managedSlots: true,
+	slots: /** @lends sap.ui.webcomponents.main.CardHeader.prototype */ {
+
+		/**
+		 * Defines an avatar image, displayed in the left most part of the header.
+		 * @type {HTMLElement[]}
+		 * @slot
+		 * @public
+		 */
+		avatar: {
+			type: HTMLElement,
+		},
+
+		/**
+		 * Defines an action, displayed in the right most part of the header.
+		 * <br><br>
+		 * <b>Note:</b> If set, the <code>status</code> text will not be displayed,
+		 * you can either have <code>action</code>, or <code>status</code>.
+		 * @type {HTMLElement[]}
+		 * @slot
+		 * @public
+		 */
+		action: {
+			type: HTMLElement,
+		},
+	},
+	properties: /** @lends sap.ui.webcomponents.main.CardHeader.prototype */ {
+
+		/**
+		 * Defines the title text.
+		 * @type {string}
+		 * @defaultvalue ""
+		 * @public
+		 */
+		titleText: {
+			type: String,
+		},
+
+		/**
+		 * Defines the subtitle text.
+		 * @type {string}
+		 * @defaultvalue ""
+		 * @public
+		 */
+		subtitleText: {
+			type: String,
+		},
+
+		/**
+		 * Defines the status text.
+		 * <br><br>
+		 * <b>Note:</b> If the <code>action</code> slot is set, the <code>status</code> will not be displayed,
+		 * you can either have <code>action</code>, or <code>status</code>.
+		 * @type {string}
+		 * @defaultvalue ""
+		 * @public
+		 */
+		status: {
+			type: String,
+		},
+
+		/**
+		 * Defines if the component would be interactive,
+		 * e.g gets hover effect, gets focus outline and <code>click</code> event is fired, when pressed.
+		 * @type {boolean}
+		 * @defaultvalue false
+		 * @public
+		 */
+		interactive: {
+			type: Boolean,
+		},
+
+		/**
+		 * Define the <code>aria-level</code> attribute of the component
+		 * <b>Note: </b> If the interactive property is set, <code>aria-level</code> attribute is not rendered at all.
+		 * @private
+		 * @type {Integer}
+		 * @defaultValue 3
+		 */
+		ariaLevel: {
+			type: Integer,
+			defaultValue: 3,
+		},
+
+		_headerActive: {
+			type: Boolean,
+			noAttribute: true,
+		},
+	},
+	events: /** @lends sap.ui.webcomponents.main.CardHeader.prototype */ {
+
+		/**
+		 * Fired when the component is activated by mouse/tap or by using the Enter or Space key.
+		 * <br><br>
+		 * <b>Note:</b> The event would be fired only if the <code>interactive</code> property is set to true.
+		 * @event sap.ui.webcomponents.main.CardHeader#click
+		 * @public
+		 */
+		"click": {},
+	},
+};
+
+/**
+ * @class
+ * <h3 class="comment-api-title">Overview</h3>
+ *
+ * The <code>ui5-card-header</code> is a component, meant to be used as a header of the <code>ui5-card</code> component.
+ * It displays valuable information, that can be defined with several properties, such as: <code>titleText</code>, <code>subtitleText</code>, <code>status</code>
+ * and two slots: <code>avatar</code> and <code>action</code>.
+ *
+ * <h3>Keyboard handling</h3>
+ * In case you enable <code>interactive</code> property, you can press the <code>ui5-card-header</code> by Space and Enter keys.
+ *
+ * <h3>CSS Shadow Parts</h3>
+ *
+ * <ui5-link target="_blank" href="https://developer.mozilla.org/en-US/docs/Web/CSS/::part">CSS Shadow Parts</ui5-link> allow developers to style elements inside the Shadow DOM.
+ * <br>
+ * The <code>ui5-card</code> exposes the following CSS Shadow Parts:
+ * <ul>
+ * <li>title - Used to style the title of the CardHeader</li>
+ * <li>subtitle - Used to style the subtitle of the CardHeader</li>
+ * <li>status - Used to style the status of the CardHeader</li>
+ * </ul>
+ *
+ * <h3>ES6 Module Import</h3>
+ *
+ * <code>import "@ui5/webcomponents/dist/CardHeader";</code>
+ *
+ * @constructor
+ * @author SAP SE
+ * @alias sap.ui.webcomponents.main.CardHeader
+ * @extends sap.ui.webcomponents.base.UI5Element
+ * @tagname ui5-card-header
+ * @public
+ * @since 1.0.0-rc.15
+ */
+class CardHeader extends UI5Element {
+	static get metadata() {
+		return metadata;
+	}
+
+	static get render() {
+		return litRender;
+	}
+
+	static get template() {
+		return CardHeaderTemplate;
+	}
+
+	static get styles() {
+		return cardHeaderCss;
+	}
+
+	get classes() {
+		return {
+			"ui5-card-header": true,
+			"ui5-card-header--interactive": this.interactive,
+			"ui5-card-header--active": this.interactive && this._headerActive,
+		};
+	}
+
+	get ariaHeaderRole() {
+		return this.interactive ? "button" : "heading";
+	}
+
+	get _ariaLevel() {
+		if (this.interactive) {
+			return undefined;
+		}
+
+		return this.ariaLevel;
+	}
+
+	get ariaCardHeaderRoleDescription() {
+		return this.interactive ? CardHeader.i18nBundle.getText(ARIA_ROLEDESCRIPTION_INTERACTIVE_CARD_HEADER) : CardHeader.i18nBundle.getText(ARIA_ROLEDESCRIPTION_CARD_HEADER);
+	}
+
+	get ariaCardAvatarLabel() {
+		return CardHeader.i18nBundle.getText(AVATAR_TOOLTIP);
+	}
+
+	get ariaLabelledByHeader() {
+		const labels = [];
+
+		if (this.titleText) {
+			labels.push(`${this._id}-title`);
+		}
+
+		if (this.subtitleText) {
+			labels.push(`${this._id}-subtitle`);
+		}
+
+		if (this.status) {
+			labels.push(`${this._id}-status`);
+		}
+
+		if (this.hasAvatar) {
+			labels.push(`${this._id}-avatar`);
+		}
+
+		return labels.length !== 0 ? labels.join(" ") : undefined;
+	}
+
+	get hasAvatar() {
+		return !!this.avatar.length;
+	}
+
+	get hasAction() {
+		return !!this.action.length;
+	}
+
+	static get dependencies() {
+		return [Icon];
+	}
+
+	static async onDefine() {
+		CardHeader.i18nBundle = await getI18nBundle("@ui5/webcomponents");
+	}
+
+	_headerClick(event) {
+		event.stopImmediatePropagation(); // prevents the native browser "click" event from firing
+
+		if (this.interactive) {
+			this.fireEvent("click");
+		}
+	}
+
+	_headerKeydown(event) {
+		if (!this.interactive) {
+			return;
+		}
+
+		const enter = isEnter(event);
+		const space = isSpace(event);
+
+		this._headerActive = enter || space;
+
+		if (enter) {
+			this.fireEvent("click");
+			return;
+		}
+
+		if (space) {
+			event.preventDefault();
+		}
+	}
+
+	_headerKeyup(event) {
+		if (!this.interactive) {
+			return;
+		}
+
+		const space = isSpace(event);
+
+		this._headerActive = false;
+
+		if (space) {
+			this.fireEvent("click");
+		}
+	}
+}
+
+CardHeader.define();
+
+export default CardHeader;