@ui5/webcomponents 0.0.0-e7dd012d7 → 0.0.0-ec448881d

package/dist/SegmentedButton.js

@@ -1,12 +1,16 @@
 import UI5Element from "@ui5/webcomponents-base/dist/UI5Element.js";
 import ItemNavigation from "@ui5/webcomponents-base/dist/delegate/ItemNavigation.js";
 import litRender from "@ui5/webcomponents-base/dist/renderer/LitRenderer.js";
-import { fetchI18nBundle, getI18nBundle } from "@ui5/webcomponents-base/dist/i18nBundle.js";
+import { getI18nBundle } from "@ui5/webcomponents-base/dist/i18nBundle.js";
 import ResizeHandler from "@ui5/webcomponents-base/dist/delegate/ResizeHandler.js";
-import RenderScheduler from "@ui5/webcomponents-base/dist/RenderScheduler.js";
+import { renderFinished } from "@ui5/webcomponents-base/dist/Render.js";
 import { isIE } from "@ui5/webcomponents-base/dist/Device.js";
-import { SEGMENTEDBUTTON_ARIA_DESCRIPTION } from "./generated/i18n/i18n-defaults.js";
-import ToggleButton from "./ToggleButton.js";
+import {
+	isSpace,
+	isEnter,
+} from "@ui5/webcomponents-base/dist/Keys.js";
+import { SEGMENTEDBUTTON_ARIA_DESCRIPTION, SEGMENTEDBUTTON_ARIA_DESCRIBEDBY } from "./generated/i18n/i18n-defaults.js";
+import SegmentedButtonItem from "./SegmentedButtonItem.js";
 
 // Template
 import SegmentedButtonTemplate from "./generated/templates/SegmentedButtonTemplate.lit.js";
@@ -18,39 +22,53 @@ import SegmentedButtonCss from "./generated/themes/SegmentedButton.css.js";
  * @public
  */
 const metadata = {
-	tag: "ui5-segmentedbutton",
+	tag: "ui5-segmented-button",
+	altTag: "ui5-segmentedbutton",
 	languageAware: true,
-	properties: /** @lends sap.ui.webcomponents.main.SegmentedButton.prototype */  {},
+	properties: /** @lends sap.ui.webcomponents.main.SegmentedButton.prototype */  {
+		/**
+		 * Defines the accessible aria name of the component.
+		 *
+		 * @type {string}
+		 * @defaultvalue: ""
+		 * @public
+		 * @since 1.0.3
+		 */
+		 accessibleName: {
+			type: String,
+			defaultValue: undefined,
+		},
+	},
 	managedSlots: true,
 	slots: /** @lends sap.ui.webcomponents.main.SegmentedButton.prototype */ {
 
 		/**
-		 * Defines the buttons of <code>ui5-segmentedbutton</code>.
+		 * Defines the items of <code>ui5-segmented-button</code>.
 		 * <br><br>
-		 * <b>Note:</b> Multiple buttons are allowed.
+		 * <b>Note:</b> Multiple items are allowed.
 		 * <br><br>
-		 * <b>Note:</b> Use the <code>ui5-togglebutton</code> for the intended design.
-		 * @type {HTMLElement[]}
-		 * @slot
+		 * <b>Note:</b> Use the <code>ui5-segmented-button-item</code> for the intended design.
+		 * @type {sap.ui.webcomponents.main.ISegmentedButtonItem[]}
+		 * @slot items
 		 * @public
 		 */
 		"default": {
-			propertyName: "buttons",
+			propertyName: "items",
 			type: HTMLElement,
 		},
 	},
 	events: /** @lends sap.ui.webcomponents.main.SegmentedButton.prototype */ {
 
 		/**
-		 * Fired when the selected button changes.
+		 * Fired when the selected item changes.
 		 *
 		 * @event sap.ui.webcomponents.main.SegmentedButton#selection-change
-		 * @param {HTMLElement} selectedButton the pressed button.
+		 * @param {HTMLElement} selectedItem the pressed item.
 		 * @public
 		 */
 		"selection-change": {
 			detail: {
-				selectedButton: { type: HTMLElement },
+				selectedItem: { type: HTMLElement },
 			},
 		},
 	},
@@ -61,11 +79,11 @@ const metadata = {
  *
  * <h3 class="comment-api-title">Overview</h3>
  *
- * The <code>ui5-segmentedbutton</code> shows a group of buttons. When the user clicks or taps
- * one of the buttons, it stays in a pressed state. It automatically resizes the buttons
+ * The <code>ui5-segmented-button</code> shows a group of items. When the user clicks or taps
+ * one of the items, it stays in a pressed state. It automatically resizes the items
  * to fit proportionally within the component. When no width is set, the component uses the available width.
  * <br><br>
- * <b>Note:</b> There can be just one selected <code>button</code> at a time.
+ * <b>Note:</b> There can be just one selected <code>item</code> at a time.
  *
  * <h3>ES6 Module Import</h3>
  *
@@ -75,8 +93,9 @@ const metadata = {
  * @author SAP SE
  * @alias sap.ui.webcomponents.main.SegmentedButton
  * @extends sap.ui.webcomponents.base.UI5Element
- * @tagname ui5-segmentedbutton
+ * @tagname ui5-segmented-button
  * @since 1.0.0-rc.6
+ * @appenddocs SegmentedButtonItem
  * @public
  */
 class SegmentedButton extends UI5Element {
@@ -97,23 +116,25 @@ class SegmentedButton extends UI5Element {
 	}
 
 	static get dependencies() {
-		return [ToggleButton];
+		return [SegmentedButtonItem];
 	}
 
 	static async onDefine() {
-		await fetchI18nBundle("@ui5/webcomponents");
+		SegmentedButton.i18nBundle = await getI18nBundle("@ui5/webcomponents");
 	}
 
 	constructor() {
 		super();
-		this.initItemNavigation();
+
+		this._itemNavigation = new ItemNavigation(this, {
+			getItemsCallback: () => this.getSlottedNodes("items"),
+		});
 
 		this.absoluteWidthSet = false; // set to true whenever we set absolute width to the component
 		this.percentageWidthSet = false; //  set to true whenever we set 100% width to the component
 		this.hasPreviouslyFocusedItem = false;
 
 		this._handleResizeBound = this._doLayout.bind(this);
-		this.i18nBundle = getI18nBundle("@ui5/webcomponents");
 	}
 
 	onEnterDOM() {
@@ -121,10 +142,19 @@ class SegmentedButton extends UI5Element {
 	}
 
 	onExitDOM() {
-		ResizeHandler.deregister(this.parentNode, this._handleResizeBound);
+		if (this.parentNode) {
+			ResizeHandler.deregister(this.parentNode, this._handleResizeBound);
+		}
 	}
 
 	onBeforeRendering() {
+		const items = this.getSlottedNodes("items");
+
+		items.forEach((item, index, arr) => {
+			item.posInSet = index + 1;
+			item.sizeOfSet = arr.length;
+		});
+
 		this.normalizeSelection();
 	}
 
@@ -132,24 +162,24 @@ class SegmentedButton extends UI5Element {
 		await this._doLayout();
 	}
 
-	prepareToMeasureButtons() {
+	prepareToMeasureItems() {
 		this.style.width = "";
-		this.buttons.forEach(button => {
-			button.style.width = "";
+		this.items.forEach(item => {
+			item.style.width = "";
 		});
 	}
 
-	async measureButtonsWidth() {
-		await RenderScheduler.whenDOMUpdated();
-		this.prepareToMeasureButtons();
+	async measureItemsWidth() {
+		await renderFinished();
+		this.prepareToMeasureItems();
 
-		this.widths = this.buttons.map(button => {
+		this.widths = this.items.map(item => {
 			// +1 is added because for width 100.44px the offsetWidth property returns 100px and not 101px
-			let width = button.offsetWidth + 1;
+			let width = item.offsetWidth + 1;
 
 			if (isIE()) {
-				// in IE we are adding 1 one px beacause the width of the border on a button in the middle is not calculated and if the
-				// longest button is in the middle, it truncates
+				// in IE we are adding 1 one px beacause the width of the border on an item in the middle is not calculated and if the
+				// longest item is in the middle, it truncates
 				width += 1;
 			}
 
@@ -157,76 +187,89 @@ class SegmentedButton extends UI5Element {
 		});
 	}
 
-	initItemNavigation() {
-		this._itemNavigation = new ItemNavigation(this);
-
-		this._itemNavigation.getItemsCallback = () => this.getSlottedNodes("buttons");
-	}
-
 	normalizeSelection() {
-		this._selectedButton = this.buttons.filter(button => button.pressed).pop();
+		this._selectedItem = this.items.filter(item => item.pressed).pop();
 
-		if (this._selectedButton) {
-			this.buttons.forEach(button => {
-				button.pressed = false;
+		if (this._selectedItem) {
+			this.items.forEach(item => {
+				item.pressed = false;
 			});
-			this._selectedButton.pressed = true;
+			this._selectedItem.pressed = true;
 		}
 	}
 
-	_onclick(event) {
+	_selectItem(event) {
 		if (event.target.disabled || event.target === this.getDomRef()) {
 			return;
 		}
 
-		if (event.target !== this._selectedButton) {
-			if (this._selectedButton) {
-				this._selectedButton.pressed = false;
+		if (event.target !== this._selectedItem) {
+			if (this._selectedItem) {
+				this._selectedItem.pressed = false;
 			}
-			this._selectedButton = event.target;
+			this._selectedItem = event.target;
 			this.fireEvent("selection-change", {
-				selectedButton: this._selectedButton,
+				selectedItem: this._selectedItem,
 			});
 		}
 
-		this._selectedButton.pressed = true;
-		this._itemNavigation.update(this._selectedButton);
+		this._selectedItem.pressed = true;
+		this._itemNavigation.setCurrentItem(this._selectedItem);
 
 		return this;
 	}
 
+	_onclick(event) {
+		this._selectItem(event);
+		this.selectedItem.focus();
+	}
+
+	_onkeydown(event) {
+		if (isEnter(event)) {
+			this._selectItem(event);
+		} else if (isSpace(event)) {
+			event.preventDefault();
+		}
+	}
+
+	_onkeyup(event) {
+		if (isSpace(event)) {
+			this._selectItem(event);
+		}
+	}
+
 	_onfocusin(event) {
 		// If the component was previously focused,
 		// update the ItemNavigation to sync butons` tabindex values
 		if (this.hasPreviouslyFocusedItem) {
-			this._itemNavigation.update(event.target);
+			this._itemNavigation.setCurrentItem(event.target);
 			return;
 		}
 
 		// If the component is focused for the first time
 		// focus the selected item if such present
-		if (this.selectedButton) {
-			this.selectedButton.focus();
-			this._itemNavigation.update(this._selectedButton);
+		if (this.selectedItem) {
+			this.selectedItem.focus();
+			this._itemNavigation.setCurrentItem(this._selectedItem);
 			this.hasPreviouslyFocusedItem = true;
 		}
 	}
 
 	async _doLayout() {
-		const buttonsHaveWidth = this.widths && this.widths.some(button => button.offsetWidth > 2); // 2 are the pixel's added for rounding & IE
-		if (!buttonsHaveWidth) {
-			await this.measureButtonsWidth();
+		const itemsHaveWidth = this.widths && this.widths.some(item => item.offsetWidth > 2); // 2 are the pixel's added for rounding & IE
+		if (!itemsHaveWidth) {
+			await this.measureItemsWidth();
 		}
 
-		const parentWidth = this.parentNode.offsetWidth;
+		const parentWidth = this.parentNode ? this.parentNode.offsetWidth : 0;
 
 		if (!this.style.width || this.percentageWidthSet) {
-			this.style.width = `${Math.max(...this.widths) * this.buttons.length}px`;
+			this.style.width = `${Math.max(...this.widths) * this.items.length}px`;
 			this.absoluteWidthSet = true;
 		}
 
-		this.buttons.forEach(button => {
-			button.style.width = "100%";
+		this.items.forEach(item => {
+			item.style.width = "100%";
 		});
 
 		if (parentWidth <= this.offsetWidth && this.absoluteWidthSet) {
@@ -236,18 +279,22 @@ class SegmentedButton extends UI5Element {
 	}
 
 	/**
-	 * Currently selected button.
+	 * Currently selected item.
 	 *
 	 * @readonly
-	 * @type { ui5-togglebutton }
+	 * @type { sap.ui.webcomponents.main.ISegmentedButtonItem }
 	 * @public
 	 */
-	get selectedButton() {
-		return this._selectedButton;
+	get selectedItem() {
+		return this._selectedItem;
+	}
+
+	get ariaDescribedBy() {
+		return SegmentedButton.i18nBundle.getText(SEGMENTEDBUTTON_ARIA_DESCRIBEDBY);
 	}
 
 	get ariaDescription() {
-		return this.i18nBundle.getText(SEGMENTEDBUTTON_ARIA_DESCRIPTION);
+		return SegmentedButton.i18nBundle.getText(SEGMENTEDBUTTON_ARIA_DESCRIPTION);
 	}
 }
 

package/dist/SegmentedButtonItem.js

@@ -0,0 +1,114 @@
+import SegmentedButtonItemTemplate from "./generated/templates/SegmentedButtonItemTemplate.lit.js";
+import ToggleButton from "./ToggleButton.js";
+import ButtonDesign from "./types/ButtonDesign.js";
+import Icon from "./Icon.js";
+
+import { SEGMENTEDBUTTONITEM_ARIA_DESCRIPTION } from "./generated/i18n/i18n-defaults.js";
+
+/**
+ * @public
+ */
+const metadata = {
+	tag: "ui5-segmented-button-item",
+	properties: /** @lends  sap.ui.webcomponents.main.SegmentedButtonItem.prototype */ {
+		/**
+		 * <b>Note:</b> The property is inherited and not supported. If set, it won't take any effect.
+		 *
+		 * @type {ButtonDesign}
+		 * @defaultvalue "Default"
+		 * @public
+		 */
+		design: {
+			type: ButtonDesign,
+			defaultValue: ButtonDesign.Default,
+		},
+
+		/**
+		 * <b>Note:</b> The property is inherited and not supported. If set, it won't take any effect.
+		 *
+		 * @type {boolean}
+		 * @defaultvalue false
+		 * @public
+		 */
+		iconEnd: {
+			type: Boolean,
+		},
+
+		/**
+		 * <b>Note:</b> The property is inherited and not supported. If set, it won't take any effect.
+		 *
+		 * @type {boolean}
+		 * @defaultvalue false
+		 * @public
+		 */
+		submits: {
+			type: Boolean,
+		},
+
+		/**
+		 * Defines the index of the item inside of the SegmentedButton.
+		 *
+		 * @private
+		 * @type {string}
+		 */
+		posInSet: {
+			type: String,
+		},
+
+		/**
+		 * Defines how many items are inside of the SegmentedButton.
+		 *
+		 * @private
+		 * @type {string}
+		 */
+		sizeOfSet: {
+			type: String,
+		},
+	},
+};
+
+/**
+ * @class
+ *
+ *<h3 class="comment-api-title">Overview</h3>
+ *
+ * Users can use the <code>ui5-segmented-button-item</code> as part of a <code>ui5-segmented-button</code>.
+ * <br><br>
+ * Clicking or tapping on a <code>ui5-segmented-button-item</code> changes its state to <code>pressed</code>.
+ * The item returns to its initial state when the user clicks or taps on it again.
+ * By applying additional custom CSS-styling classes, apps can give a different style to any
+ * <code>ui5-segmented-button-item</code>.
+ *
+ * <h3>ES6 Module Import</h3>
+ *
+ * <code>import "@ui5/webcomponents/dist/SegmentedButtonItem";</code>
+ *
+ * @constructor
+ * @author SAP SE
+ * @alias sap.ui.webcomponents.main.SegmentedButtonItem
+ * @extends ToggleButton
+ * @tagname ui5-segmented-button-item
+ * @implements sap.ui.webcomponents.main.ISegmentedButtonItem
+ * @public
+ */
+class SegmentedButtonItem extends ToggleButton {
+	static get metadata() {
+		return metadata;
+	}
+
+	static get template() {
+		return SegmentedButtonItemTemplate;
+	}
+
+	static get dependencies() {
+		return [Icon];
+	}
+
+	get ariaDescription() {
+		return SegmentedButtonItem.i18nBundle.getText(SEGMENTEDBUTTONITEM_ARIA_DESCRIPTION);
+	}
+}
+
+SegmentedButtonItem.define();
+
+export default SegmentedButtonItem;