@ui5/webcomponents 0.0.0-934b4df24 → 0.0.0-a3eca7ade

package/dist/RatingIndicator.js

@@ -0,0 +1,321 @@
+import UI5Element from "@ui5/webcomponents-base/dist/UI5Element.js";
+import litRender from "@ui5/webcomponents-base/dist/renderer/LitRenderer.js";
+import {
+	isDown,
+	isUp,
+	isLeft,
+	isRight,
+	isSpace,
+	isEnter,
+	isHome,
+	isEnd,
+} from "@ui5/webcomponents-base/dist/Keys.js";
+import { getI18nBundle } from "@ui5/webcomponents-base/dist/i18nBundle.js";
+import Integer from "@ui5/webcomponents-base/dist/types/Integer.js";
+import Float from "@ui5/webcomponents-base/dist/types/Float.js";
+import {
+	RATING_INDICATOR_TEXT,
+	RATING_INDICATOR_TOOLTIP_TEXT,
+} from "./generated/i18n/i18n-defaults.js";
+import RatingIndicatorTemplate from "./generated/templates/RatingIndicatorTemplate.lit.js";
+
+// Styles
+import RatingIndicatorCss from "./generated/themes/RatingIndicator.css.js";
+
+/**
+ * @public
+ */
+const metadata = {
+	tag: "ui5-rating-indicator",
+	languageAware: true,
+	properties: /** @lends sap.ui.webcomponents.main.RatingIndicator.prototype */ {
+
+		/**
+		 * The indicated value of the rating.
+		 * <br><br>
+		 * <b>Note:</b> If you set a number which is not round, it would be shown as follows:
+		 * <ul>
+		 * <li>1.0 - 1.2 -> 1</li>
+		 * <li>1.3 - 1.7 -> 1.5</li>
+		 * <li>1.8 - 1.9 -> 2</li>
+		 * <ul>
+		 * @type {Float}
+		 * @defaultvalue 0
+		 * @public
+		 */
+		value: {
+			type: Float,
+			defaultValue: 0,
+		},
+
+		/**
+		 * The number of displayed rating symbols.
+		 * @type {Integer}
+		 * @defaultvalue 5
+		 * @public
+		 * @since 1.0.0-rc.15
+		 */
+		max: {
+			type: Integer,
+			defaultValue: 5,
+		},
+
+		/**
+		 * Defines whether the component is disabled.
+		 *
+		 * <br><br>
+		 * <b>Note:</b> A disabled component is completely noninteractive.
+		 * @type {boolean}
+		 * @defaultvalue false
+		 * @public
+		 */
+		disabled: {
+			type: Boolean,
+		},
+
+		/**
+		 * Defines whether the component is read-only.
+		 * <br><br>
+		 * <b>Note:</b> A read-only component is not editable,
+		 * but still provides visual feedback upon user interaction.
+		 *
+		 * @type {boolean}
+		 * @defaultvalue false
+		 * @public
+		 */
+		readonly: {
+			type: Boolean,
+		},
+
+		/**
+		 * Defines the accessible aria name of the component.
+		 *
+		 * @type {string}
+		 * @defaultvalue: undefined
+		 * @public
+		 * @since 1.0.0-rc.15
+		 */
+		accessibleName: {
+			type: String,
+			defaultValue: undefined,
+		},
+
+		/**
+		 * @private
+		 */
+		_stars: {
+			type: Object,
+			multiple: true,
+		},
+
+		/**
+		 * @private
+		 */
+		_focused: {
+			type: Boolean,
+		},
+	},
+	slots: /** @lends sap.ui.webcomponents.main.RatingIndicator.prototype */ {
+		//
+	},
+	events: /** @lends sap.ui.webcomponents.main.RatingIndicator.prototype */ {
+
+		/**
+		 * The event is fired when the value changes.
+		 *
+		 * @event
+		 * @public
+		 */
+		change: {},
+	},
+};
+
+/**
+ * @class
+ *
+ * <h3 class="comment-api-title">Overview</h3>
+ * The Rating Indicator is used to display a specific number of icons that are used to rate an item.
+ * Additionally, it is also used to display the average and overall ratings.
+ *
+ * <h3>Usage</h3>
+ * The recommended number of icons is between 5 and 7.
+ *
+ * <h3>Responsive Behavior</h3>
+ * You can change the size of the Rating Indicator by changing its <code>font-size</code> CSS property.
+ * <br>
+ * Example: <code>&lt;ui5-rating-indicator style="font-size: 3rem;">&lt;/ui5-rating-indicator></code>
+ *
+ * <h3>Keyboard Handling</h3>
+ * When the <code>ui5-rating-indicator</code> is focused, the user can change the rating
+ * with the following keyboard shortcuts:
+ * <br>
+ *
+ * <ul>
+ * <li>[RIGHT/UP] - Increases the value of the rating by one step. If the highest value is reached, does nothing</li>
+ * <li>[LEFT/DOWN] - Decreases the value of the rating by one step. If the lowest value is reached, does nothing.</li>
+ * <li>[HOME] - Sets the lowest value.</li>
+ * <li>[END] - Sets the highest value.</li>
+ * <li>[SPACE/ENTER/RETURN] - Increases the value of the rating by one step. If the highest value is reached, sets the rating to the lowest value.</li>
+ * <li>Any number - Changes value to the corresponding number. If typed number is larger than the number of values, sets the highest value.</li>
+ * </ul>
+ *
+ * <h3>ES6 Module Import</h3>
+ *
+ * <code>import "@ui5/webcomponents/dist/RatingIndicator.js";</code>
+ *
+ * @constructor
+ * @author SAP SE
+ * @alias sap.ui.webcomponents.main.RatingIndicator
+ * @extends UI5Element
+ * @tagname ui5-rating-indicator
+ * @public
+ * @since 1.0.0-rc.8
+ */
+class RatingIndicator extends UI5Element {
+	static get metadata() {
+		return metadata;
+	}
+
+	static get render() {
+		return litRender;
+	}
+
+	static get styles() {
+		return RatingIndicatorCss;
+	}
+
+	static get template() {
+		return RatingIndicatorTemplate;
+	}
+
+	static async onDefine() {
+		RatingIndicator.i18nBundle = await getI18nBundle("@ui5/webcomponents");
+	}
+
+	constructor() {
+		super();
+
+		this._liveValue = null; // stores the value to determine when to fire change
+	}
+
+	onBeforeRendering() {
+		this.calcState();
+	}
+
+	calcState() {
+		this._stars = [];
+
+		for (let i = 1; i < this.max + 1; i++) {
+			const remainder = Math.round((this.value - Math.floor(this.value)) * 10);
+			let halfStar = false,
+				tempValue = this.value;
+
+			if (Math.floor(this.value) + 1 === i && remainder > 2 && remainder < 8) {
+				halfStar = true;
+			} else if (remainder <= 2) {
+				tempValue = Math.floor(this.value);
+			} else if (remainder >= 8) {
+				tempValue = Math.ceil(this.value);
+			}
+
+			this._stars.push({
+				selected: i <= tempValue,
+				index: i,
+				halfStar,
+			});
+		}
+	}
+
+	_onclick(event) {
+		if (this.disabled || this.readonly) {
+			return;
+		}
+
+		this.value = parseInt(event.target.getAttribute("data-value"));
+
+		if (this.value === 1 && this._liveValue === 1) {
+			this.value = 0;
+		}
+
+		if (this._liveValue !== this.value) {
+			this.fireEvent("change");
+			this._liveValue = this.value;
+		}
+	}
+
+	_onkeydown(event) {
+		if (this.disabled || this.readonly) {
+			return;
+		}
+
+		const isDecrease = isDown(event) || isLeft(event);
+		const isIncrease = isRight(event) || isUp(event);
+		const isIncreaseWithReset = isSpace(event) || isEnter(event);
+		const isMin = isHome(event);
+		const isMax = isEnd(event);
+		const isNumber = (event.keyCode >= 48 && event.keyCode <= 57) || (event.keyCode >= 96 && event.keyCode <= 105);
+
+		if (isDecrease || isIncrease || isIncreaseWithReset || isMin || isMax || isNumber) {
+			event.preventDefault();
+
+			if (isDecrease && this.value > 0) {
+				this.value = Math.round(this.value - 1);
+			} else if (isIncrease && this.value < this.max) {
+				this.value = Math.round(this.value + 1);
+			} else if (isIncreaseWithReset) {
+				const proposedValue = Math.round(this.value + 1);
+				this.value = proposedValue > this.max ? 0 : proposedValue;
+			} else if (isMin) {
+				this.value = 0;
+			} else if (isMax) {
+				this.value = this.max;
+			} else if (isNumber) {
+				const pressedNumber = parseInt(event.key);
+				this.value = pressedNumber > this.max ? this.max : pressedNumber;
+			}
+
+			this.fireEvent("change");
+		}
+	}
+
+	_onfocusin() {
+		if (this.disabled) {
+			return;
+		}
+
+		this._focused = true;
+		this._liveValue = this.value;
+	}
+
+	_onfocusout() {
+		this._focused = false;
+	}
+
+	get tabIndex() {
+		return this.disabled ? "-1" : "0";
+	}
+
+	get tooltip() {
+		return this.getAttribute("title") || this.defaultTooltip;
+	}
+
+	get defaultTooltip() {
+		return RatingIndicator.i18nBundle.getText(RATING_INDICATOR_TOOLTIP_TEXT);
+	}
+
+	get _ariaRoleDescription() {
+		return RatingIndicator.i18nBundle.getText(RATING_INDICATOR_TEXT);
+	}
+
+	get _ariaDisabled() {
+		return this.disabled || undefined;
+	}
+
+	get ariaReadonly() {
+		return this.readonly ? "true" : undefined;
+	}
+}
+
+RatingIndicator.define();
+
+export default RatingIndicator;

package/dist/ResponsivePopover.js

@@ -1,56 +1,50 @@
 import { isPhone } from "@ui5/webcomponents-base/dist/Device.js";
-import { getNextZIndex } from "./popup-utils/PopupUtils.js";
+import { getI18nBundle } from "@ui5/webcomponents-base/dist/i18nBundle.js";
+import { getNextZIndex } from "@ui5/webcomponents-base/dist/util/PopupUtils.js";
+import { RESPONSIVE_POPOVER_CLOSE_DIALOG_BUTTON } from "./generated/i18n/i18n-defaults.js";
 import ResponsivePopoverTemplate from "./generated/templates/ResponsivePopoverTemplate.lit.js";
 import Popover from "./Popover.js";
 import Dialog from "./Dialog.js";
 import Button from "./Button.js";
 import Title from "./Title.js";
-import "@ui5/webcomponents-icons/dist/icons/decline.js";
+import "@ui5/webcomponents-icons/dist/decline.js";
 
 // Styles
 import ResponsivePopoverCss from "./generated/themes/ResponsivePopover.css.js";
 
-const POPOVER_MIN_WIDTH = 100;
-
 /**
  * @public
  */
 const metadata = {
 	tag: "ui5-responsive-popover",
 	properties: /** @lends sap.ui.webcomponents.main.ResponsivePopover.prototype */ {
-
-		/**
-		 * Defines whether the component will stretch to fit its content.
-		 * <br/><b>Note:</b> by default the popover will be as wide as its opener component and will grow if the content is not fitting.
-		 * <br/><b>Note:</b> if set to true, it will take only as much space as it needs.
-		 * @private
-		 */
-		noStretch: {
-			type: Boolean,
-		},
-
 		/**
-		 * Defines if padding would be added around the content.
+		 * Defines if only the content would be displayed (without header and footer) in the popover on Desktop.
+		 * By default both the header and footer would be displayed.
 		 * @private
 		 */
-		withPadding: {
+		contentOnlyOnDesktop: {
 			type: Boolean,
 		},
 
 		/**
-		 * Defines if only the content would be displayed (without header and footer) in the popover on Desktop.
-		 * By default both the header and footer would be displayed.
+		 * Used internaly for controls which must not have header.
 		 * @private
 		 */
-		contentOnlyOnDesktop: {
+		_hideHeader: {
 			type: Boolean,
 		},
 
 		/**
-		 * Used internaly for controls which must not have header.
+		 * Defines whether a close button will be rendered in the header of the component
+		 * <b>Note:</b> If you are using the <code>header</code> slot, this property will have no effect
+		 *
 		 * @private
+		 * @type {boolean}
+		 * @defaultvalue false
+		 * @since 1.0.0-rc.16
 		 */
-		_hideHeader: {
+		_hideCloseButton: {
 			type: Boolean,
 		},
 	},
@@ -66,6 +60,17 @@ const metadata = {
  * <h3>Usage</h3>
  * Use it when you want to make sure that all the content is visible on any device.
  *
+ * <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-responsive-popover</code> exposes the following CSS Shadow Parts:
+ * <ul>
+ * <li>header - Used to style the header of the component</li>
+ * <li>content - Used to style the content of the component</li>
+ * <li>footer - Used to style the footer of the component</li>
+ * </ul>
+ *
  * @constructor
  * @author SAP SE
  * @alias sap.ui.webcomponents.main.ResponsivePopover
@@ -75,48 +80,57 @@ const metadata = {
  * @public
  */
 class ResponsivePopover extends Popover {
+	constructor() {
+		super();
+	}
+
 	static get metadata() {
 		return metadata;
 	}
 
 	static get styles() {
-		return [...Popover.styles, ResponsivePopoverCss];
+		return [Popover.styles, ResponsivePopoverCss];
+	}
+
+	get classes() {
+		const allClasses = super.classes;
+
+		allClasses.header = {
+			"ui5-responsive-popover-header": true,
+			"ui5-responsive-popover-header-no-title": !this.headerText,
+		};
+
+		return allClasses;
 	}
 
 	static get template() {
 		return ResponsivePopoverTemplate;
 	}
 
-	static async onDefine() {
-		await Promise.all([
-			Button.define(),
-			Dialog.define(),
-			Title.define(),
-		]);
+	static get dependencies() {
+		return [
+			...Popover.dependencies,
+			Button,
+			Dialog,
+			Title,
+		];
 	}
 
 	/**
-	 * Opens popover on desktop and dialog on mobile.
-	 * @param {HTMLElement} opener the element that the popover is opened by
+	 * Shows popover on desktop and dialog on mobile.
+	 * @param {HTMLElement} opener the element that the popover is shown at
+	 * @param {boolean} preventInitialFocus Prevents applying the focus inside the popup
 	 * @public
+	 * @async
+	 * @returns {Promise} Resolves when the responsive popover is open
 	 */
-	open(opener) {
-		this.style.display = this._isPhone ? "contents" : "";
-
-		if (this.isOpen() || (this._dialog && this._dialog.isOpen())) {
-			return;
-		}
-
+	async showAt(opener, preventInitialFocus = false) {
 		if (!isPhone()) {
-			// make popover width be >= of the opener's width
-			if (!this.noStretch) {
-				this._minWidth = Math.max(POPOVER_MIN_WIDTH, opener.getBoundingClientRect().width);
-			}
-
-			this.openBy(opener);
+			await super.showAt(opener, preventInitialFocus);
 		} else {
+			this.style.display = "contents";
 			this.style.zIndex = getNextZIndex();
-			this._dialog.open();
+			await this._dialog.show(preventInitialFocus);
 		}
 	}
 
@@ -124,11 +138,11 @@ class ResponsivePopover extends Popover {
 	 * Closes the popover/dialog.
 	 * @public
 	 */
-	close() {
+	close(escPressed = false, preventRegistryUpdate = false, preventFocusRestore = false) {
 		if (!isPhone()) {
-			super.close();
+			super.close(escPressed, preventRegistryUpdate, preventFocusRestore);
 		} else {
-			this._dialog.close();
+			this._dialog.close(escPressed, preventRegistryUpdate, preventFocusRestore);
 		}
 	}
 
@@ -137,25 +151,20 @@ class ResponsivePopover extends Popover {
 			return this.close();
 		}
 
-		this.open(opener);
+		this.showAt(opener);
 	}
 
+	/**
+	 * Tells if the responsive popover is open
+	 * @public
+	 * @returns {boolean}
+	 */
 	isOpen() {
 		return isPhone() ? this._dialog.isOpen() : super.isOpen();
 	}
 
-	get styles() {
-		const popoverStyles = super.styles;
-
-		popoverStyles.root = {
-			"min-width": `${this._minWidth}px`,
-		};
-
-		return popoverStyles;
-	}
-
 	get _dialog() {
-		return this.shadowRoot.querySelector("ui5-dialog");
+		return this.shadowRoot.querySelector("[ui5-dialog]");
 	}
 
 	get _isPhone() {
@@ -163,19 +172,25 @@ class ResponsivePopover extends Popover {
 	}
 
 	get _displayHeader() {
-		return this._isPhone || !this.contentOnlyOnDesktop;
+		return (this._isPhone || !this.contentOnlyOnDesktop) && super._displayHeader;
 	}
 
 	get _displayFooter() {
 		return this._isPhone || !this.contentOnlyOnDesktop;
 	}
 
+	get _closeDialogAriaLabel() {
+		return ResponsivePopover.i18nBundle.getText(RESPONSIVE_POPOVER_CLOSE_DIALOG_BUTTON);
+	}
+
 	_afterDialogOpen(event) {
+		this.open = true;
 		this.opened = true;
 		this._propagateDialogEvent(event);
 	}
 
 	_afterDialogClose(event) {
+		this.open = false;
 		this.opened = false;
 		this._propagateDialogEvent(event);
 	}
@@ -185,6 +200,10 @@ class ResponsivePopover extends Popover {
 
 		this.fireEvent(type, event.detail);
 	}
+
+	static async onDefine() {
+		ResponsivePopover.i18nBundle = await getI18nBundle("@ui5/webcomponents");
+	}
 }
 
 ResponsivePopover.define();