@ui5/webcomponents 0.0.0-e7dd012d7 → 0.0.0-ec448881d

package/dist/BreadcrumbsItem.js

@@ -0,0 +1,103 @@
+import UI5Element from "@ui5/webcomponents-base/dist/UI5Element.js";
+
+/**
+* @public
+*/
+const metadata = {
+	tag: "ui5-breadcrumbs-item",
+	managedSlots: true,
+	properties: /** @lends  sap.ui.webcomponents.main.BreadcrumbsItem.prototype */ {
+
+		/**
+		 * Defines the link href.
+		 * <br><br>
+		 * <b>Note:</b> Standard hyperlink behavior is supported.
+		 *
+		 * @type {string}
+		 * @defaultvalue ""
+		 * @public
+		 */
+		 href: {
+			type: String,
+		},
+
+		/**
+		 * Defines the link target.
+		 * <br><br>
+		 * Available options are:
+		 * <ul>
+		 * <li><code>_self</code></li>
+		 * <li><code>_top</code></li>
+		 * <li><code>_blank</code></li>
+		 * <li><code>_parent</code></li>
+		 * <li><code>_search</code></li>
+		 * </ul>
+		 * <br><br>
+		 * <b>Note:<b> This property must only be used when the <code>href</code> property is set.
+		 *
+		 * @type {string}
+		 * @defaultvalue undefined
+		 * @public
+		 */
+		 target: {
+			type: String,
+			defaultValue: undefined,
+		},
+
+		/**
+		 * Defines the accessible aria name of the item.
+		 *
+		 * @type {string}
+		 * @defaultvalue undefined
+		 * @public
+		 */
+		 accessibleName: {
+			type: String,
+		},
+	},
+	slots: /** @lends sap.ui.webcomponents.main.BreadcrumbsItem.prototype */ {
+		/**
+		 * Defines the text of the component.
+		 * <br><br>
+		 * <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
+		 * @public
+		 */
+		"default": {
+			type: Node,
+		},
+	},
+	events: /** @lends sap.ui.webcomponents.main.BreadcrumbsItem.prototype */ {},
+};
+
+/**
+ * @class
+ *
+ * <h3 class="comment-api-title">Overview</h3>
+ *
+ * The <code>ui5-breadcrumbs-item</code> component defines the content of an item in <code>ui5-breadcumbs</code>.
+ *
+ * @constructor
+ * @author SAP SE
+ * @alias sap.ui.webcomponents.main.BreadcrumbsItem
+ * @extends sap.ui.webcomponents.base.UI5Element
+ * @tagname ui5-breadcrumbs-item
+ * @implements sap.ui.webcomponents.main.IBreadcrumbsItem
+ * @public
+ * @since 1.0.0-rc.15
+ */
+class BreadcrumbsItem extends UI5Element {
+	static get metadata() {
+		return metadata;
+	}
+
+	get stableDomRef() {
+		return this.getAttribute("stable-dom-ref") || `${this._id}-stable-dom-ref`;
+	}
+}
+
+BreadcrumbsItem.define();
+
+export default BreadcrumbsItem;

package/dist/BusyIndicator.js

@@ -1,7 +1,9 @@
 import UI5Element from "@ui5/webcomponents-base/dist/UI5Element.js";
 import litRender from "@ui5/webcomponents-base/dist/renderer/LitRenderer.js";
 import { isIE } from "@ui5/webcomponents-base/dist/Device.js";
-import { fetchI18nBundle, getI18nBundle } from "@ui5/webcomponents-base/dist/i18nBundle.js";
+import { getI18nBundle } from "@ui5/webcomponents-base/dist/i18nBundle.js";
+import { isTabNext } from "@ui5/webcomponents-base/dist/Keys.js";
+import Integer from "@ui5/webcomponents-base/dist/types/Integer.js";
 import BusyIndicatorSize from "./types/BusyIndicatorSize.js";
 import Label from "./Label.js";
 
@@ -17,12 +19,13 @@ import busyIndicatorCss from "./generated/themes/BusyIndicator.css.js";
  * @public
  */
 const metadata = {
-	tag: "ui5-busyindicator",
+	tag: "ui5-busy-indicator",
+	altTag: "ui5-busyindicator",
 	languageAware: true,
 	slots: /** @lends sap.ui.webcomponents.main.BusyIndicator.prototype */ {
 
 		/**
-		 * Determines the content over which the <code>ui5-busyindicator</code> will appear.
+		 * Determines the content over which the component will appear.
 		 *
 		 * @type {Node[]}
 		 * @slot
@@ -35,8 +38,8 @@ const metadata = {
 	properties: /** @lends sap.ui.webcomponents.main.BusyIndicator.prototype */ {
 
 		/**
-		 * Defines text to be displayed below the busy indicator. It can be used to inform the user of the current operation.
-		 * @type {String}
+		 * Defines text to be displayed below the component. It can be used to inform the user of the current operation.
+		 * @type {string}
 		 * @public
 		 * @defaultvalue ""
 		 * @since 1.0.0-rc.7
@@ -46,9 +49,16 @@ const metadata = {
 		},
 
 		/**
-		 * Defines the size of the <code>ui5-busyindicator</code>.
+		 * Defines the size of the component.
+		 *
 		 * <br><br>
-		 * <b>Note:</b> Available options are "Small", "Medium", and "Large".
+		 * <b>Note:</b>
+		 *
+		 * <ul>
+		 * <li><code>Small</code></li>
+		 * <li><code>Medium</code></li>
+		 * <li><code>Large</code></li>
+		 * </ul>
 		 *
 		 * @type {BusyIndicatorSize}
 		 * @defaultvalue "Medium"
@@ -69,6 +79,26 @@ const metadata = {
 		active: {
 			type: Boolean,
 		},
+
+		/**
+		 * Defines the delay in milliseconds, after which the busy indicator will be visible on the screen.
+		 *
+		 * @type {Integer}
+		 * @defaultValue 1000
+		 * @public
+		 */
+		delay: {
+			type: Integer,
+			defaultValue: 1000,
+		},
+
+		/**
+		 * Defines if the component is currently in busy state.
+		 * @private
+		 */
+		_isBusy: {
+			type: Boolean,
+		},
 	},
 };
 
@@ -77,19 +107,32 @@ const metadata = {
  *
  * <h3 class="comment-api-title">Overview</h3>
  *
- * The <code>ui5-busyindicator</code> signals that some operation is going on and that the
- *  user must wait. It does not block the current UI screen so other operations could be
- *  triggered in parallel.
+ * The <code>ui5-busy-indicator</code> signals that some operation is going on and that the
+ * user must wait. It does not block the current UI screen so other operations could be triggered in parallel.
+ * It displays 3 dots and each dot expands and shrinks at a different rate, resulting in a cascading flow of animation.
  *
  * <h3>Usage</h3>
- * For the <code>ui5-busyindicator</code> you can define the size of the indicator, as well
- * as whether it is shown or hidden. In order to hide it, use the html attribute <code>hidden</code> or <code>display: none;</code>
+ * For the <code>ui5-busy-indicator</code> you can define the size, the text and whether it is shown or hidden.
+ * In order to hide it, use the "active" property.
  * <br><br>
- * In order to show busy state for an HTML element, simply nest the HTML element in a <code>ui5-busyindicator</code> instance.
+ * In order to show busy state over an HTML element, simply nest the HTML element in a <code>ui5-busy-indicator</code> instance.
  * <br>
- * <b>Note:</b> Since <code>ui5-busyindicator</code> has <code>display: inline-block;</code> by default and no width of its own,
+ * <b>Note:</b> Since <code>ui5-busy-indicator</code> has <code>display: inline-block;</code> by default and no width of its own,
  * whenever you need to wrap a block-level element, you should set <code>display: block</code> to the busy indicator as well.
  *
+ * <h4>When to use:</h4>
+ * <ul>
+ * <li>The user needs to be able to cancel the operation.</li>
+ * <li>Only part of the application or a particular control is affected.</li>
+ * </ul>
+ *
+ * <h4>When not to use:</h4>
+ * <ul>
+ * <li>The operation takes less than one second.</li>
+ * <li>You need to block the screen and prevent the user from starting another activity.</li>
+ * <li>Do not show multiple busy indicators at once.</li>
+ * </ul>
+ *
  * <h3>ES6 Module Import</h3>
  *
  * <code>import "@ui5/webcomponents/dist/BusyIndicator";</code>
@@ -98,39 +141,34 @@ const metadata = {
  * @author SAP SE
  * @alias sap.ui.webcomponents.main.BusyIndicator
  * @extends UI5Element
- * @tagname ui5-busyindicator
+ * @tagname ui5-busy-indicator
  * @public
  * @since 0.12.0
  */
 class BusyIndicator extends UI5Element {
 	constructor() {
 		super();
-
-		this.i18nBundle = getI18nBundle("@ui5/webcomponents");
-		this._preventHandler = this._preventEvent.bind(this);
-	}
-
-	onBeforeRendering() {
-		if (this.active) {
-			this.tabIndex = -1;
-		} else {
-			this.removeAttribute("tabindex");
-		}
+		this._keydownHandler = this._handleKeydown.bind(this);
+		this._preventEventHandler = this._preventEvent.bind(this);
 	}
 
 	onEnterDOM() {
-		this.addEventListener("keyup", this._preventHandler, {
+		this.addEventListener("keydown", this._keydownHandler, {
 			capture: true,
 		});
-
-		this.addEventListener("keydown", this._preventHandler, {
+		this.addEventListener("keyup", this._preventEventHandler, {
 			capture: true,
 		});
 	}
 
 	onExitDOM() {
-		this.removeEventListener("keyup", this._preventHandler, true);
-		this.removeEventListener("keydown", this._preventHandler, true);
+		if (this._busyTimeoutId) {
+			clearTimeout(this._busyTimeoutId);
+			delete this._busyTimeoutId;
+		}
+
+		this.removeEventListener("keydown", this._keydownHandler, true);
+		this.removeEventListener("keyup", this._preventEventHandler, true);
 	}
 
 	static get metadata() {
@@ -154,27 +192,75 @@ class BusyIndicator extends UI5Element {
 	}
 
 	static async onDefine() {
-		await fetchI18nBundle("@ui5/webcomponents");
+		BusyIndicator.i18nBundle = await getI18nBundle("@ui5/webcomponents");
 	}
 
 	get ariaTitle() {
-		return this.i18nBundle.getText(BUSY_INDICATOR_TITLE);
+		return BusyIndicator.i18nBundle.getText(BUSY_INDICATOR_TITLE);
+	}
+
+	get labelId() {
+		return this.text ? `${this._id}-label` : undefined;
 	}
 
 	get classes() {
 		return {
 			root: {
-				"ui5-busyindicator-root": true,
-				"ui5-busyindicator-root--ie": isIE(),
+				"ui5-busy-indicator-root": true,
+				"ui5-busy-indicator-root--ie": isIE(),
 			},
 		};
 	}
 
-	_preventEvent(event) {
+	onBeforeRendering() {
 		if (this.active) {
+			if (!this._isBusy && !this._busyTimeoutId) {
+				this._busyTimeoutId = setTimeout(() => {
+					delete this._busyTimeoutId;
+					this._isBusy = true;
+				}, Math.max(0, this.delay));
+			}
+		} else {
+			if (this._busyTimeoutId) {
+				clearTimeout(this._busyTimeoutId);
+				delete this._busyTimeoutId;
+			}
+			this._isBusy = false;
+		}
+	}
+
+	_handleKeydown(event) {
+		if (!this._isBusy) {
+			return;
+		}
+
+		event.stopImmediatePropagation();
+
+		// move the focus to the last element in this DOM and let TAB continue to the next focusable element
+		if (isTabNext(event)) {
+			this.focusForward = true;
+			this.shadowRoot.querySelector("[data-ui5-focus-redirect]").focus();
+			this.focusForward = false;
+		}
+	}
+
+	_preventEvent(event) {
+		if (this._isBusy) {
 			event.stopImmediatePropagation();
 		}
 	}
+
+	/**
+	 * Moves the focus to busy area when coming with SHIFT + TAB
+	 */
+	_redirectFocus(event) {
+		if (this.focusForward) {
+			return;
+		}
+
+		event.preventDefault();
+		this.shadowRoot.querySelector(".ui5-busy-indicator-busy-area").focus();
+	}
 }
 
 BusyIndicator.define();