feat(ui5-segmented-button-item): introduce new component to serve as child of SegmentedButton

docs/Public Module Imports.md

@@ -61,6 +61,7 @@ For API documentation and samples, please check the [UI5 Web Components Playgrou
 | Select                   | `ui5-select`             | `import "@ui5/webcomponents/dist/Select.js";`              |
 | Select Option            | `ui5-option`             | comes with `ui5-select `                                   |
 | Segmented Button         | `ui5-segmentedbutton`    | `import "@ui5/webcomponents/dist/SegmentedButton.js";`     |
+| Segmented Button Item    | `ui5-segmentedbutton-item`| comes with `ui5-segmentedbutton `                         |
 | Suggestion Item          | `ui5-suggestion-item`    | comes with `InputSuggestions.js` feature - see below       |
 | Slider                   | `ui5-slider`             | `import "@ui5/webcomponents/dist/Slider.js";`              |
 | Step Input               | `ui5-step-input`         | `import "@ui5/webcomponents/dist/StepInput.js";`           |

packages/main/bundle.common.js

@@ -58,6 +58,7 @@ import Panel from "./dist/Panel.js";
 import RadioButton from "./dist/RadioButton.js";
 import ResponsivePopover from "./dist/ResponsivePopover.js";
 import SegmentedButton from "./dist/SegmentedButton.js";
+import SegmentedButtonItem from "./dist/SegmentedButtonItem.js";
 import Select from "./dist/Select.js";
 import Slider from "./dist/Slider.js";
 import StepInput from "./dist/StepInput.js";

packages/main/src/SegmentedButton.hbs

@@ -1,10 +1,15 @@
-<div
+<ul
 	@click="{{_onclick}}"
 	@focusin="{{_onfocusin}}"
 	class="ui5-segmentedbutton-root"
-	role="group"
+	role="listbox"
 	dir="{{effectiveDir}}"
-	aria-roledescription="{{ariaDescription}}"
+	aria-multiselectable="true"
+	aria-describedby="{{_id}}-invisibleText"
+	aria-roledescription={{ariaDescription}}
 >
 	<slot></slot>
-</div>
+
+	<span id="{{_id}}-invisibleText" class="ui5-hidden-text">{{ariaDescribedBy}}</span>
+
+</ul>

packages/main/src/SegmentedButton.js

@@ -5,8 +5,8 @@ import { fetchI18nBundle, getI18nBundle } from "@ui5/webcomponents-base/dist/i18
 import ResizeHandler from "@ui5/webcomponents-base/dist/delegate/ResizeHandler.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 { 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";
@@ -29,7 +29,7 @@ const metadata = {
 		 * <br><br>
 		 * <b>Note:</b> Multiple buttons are allowed.
 		 * <br><br>
-		 * <b>Note:</b> Use the <code>ui5-togglebutton</code> for the intended design.
+		 * <b>Note:</b> Use the <code>ui5-segmentedbutton-item</code> for the intended design.
 		 * @type {sap.ui.webcomponents.main.IButton[]}
 		 * @slot buttons
 		 * @public
@@ -77,6 +77,7 @@ const metadata = {
  * @extends sap.ui.webcomponents.base.UI5Element
  * @tagname ui5-segmentedbutton
  * @since 1.0.0-rc.6
+ * @appenddocs SegmentedButtonItem
  * @public
  */
 class SegmentedButton extends UI5Element {
@@ -97,7 +98,7 @@ class SegmentedButton extends UI5Element {
 	}
 
 	static get dependencies() {
-		return [ToggleButton];
+		return [SegmentedButtonItem];
 	}
 
 	static async onDefine() {
@@ -128,6 +129,13 @@ class SegmentedButton extends UI5Element {
 	}
 
 	onBeforeRendering() {
+		const buttons = this.getSlottedNodes("buttons");
+
+		buttons.forEach((item, index, arr) => {
+			item.posInSet = index + 1;
+			item.sizeOfSet = arr.length;
+		});
+
 		this.normalizeSelection();
 	}
 
@@ -236,13 +244,17 @@ class SegmentedButton extends UI5Element {
 	 * Currently selected button.
 	 *
 	 * @readonly
-	 * @type { ui5-togglebutton }
+	 * @type { ui5-segmentedbutton-item }
 	 * @public
 	 */
 	get selectedButton() {
 		return this._selectedButton;
 	}
 
+	get ariaDescribedBy() {
+		return this.i18nBundle.getText(SEGMENTEDBUTTON_ARIA_DESCRIBEDBY);
+	}
+
 	get ariaDescription() {
 		return this.i18nBundle.getText(SEGMENTEDBUTTON_ARIA_DESCRIPTION);
 	}

packages/main/src/SegmentedButtonItem.hbs

@@ -0,0 +1,45 @@
+<li
+		role="option"
+		aria-roledescription="{{ariaDescription}}"
+		aria-posinset="{{posInSet}}"
+		aria-setsize="{{sizeOfSet}}"
+		aria-selected="{{pressed}}"
+		class="ui5-button-root ui5-segmentedbutton-item-root"
+		?disabled="{{disabled}}"
+		data-sap-focus-ref
+	{{> ariaPressed}}
+		dir="{{effectiveDir}}"
+		@focusout={{_onfocusout}}
+		@focusin={{_onfocusin}}
+		@click={{_onclick}}
+		@mousedown={{_onmousedown}}
+		@mouseup={{_onmouseup}}
+		@keydown={{_onkeydown}}
+		@keyup={{_onkeyup}}
+		@touchstart="{{_ontouchstart}}"
+		@touchend="{{_ontouchend}}"
+		tabindex={{tabIndexValue}}
+		aria-expanded="{{accInfo.ariaExpanded}}"
+		aria-controls="{{accInfo.ariaControls}}"
+		aria-haspopup="{{accInfo.ariaHaspopup}}"
+		aria-label="{{ariaLabelText}}"
+		title="{{accInfo.title}}"
+>
+	{{#if icon}}
+		<ui5-icon
+				style="{{styles.icon}}"
+				class="ui5-button-icon"
+				name="{{icon}}"
+				?show-tooltip={{showIconTooltip}}
+		></ui5-icon>
+	{{/if}}
+
+	<span id="{{_id}}-content" class="ui5-button-text">
+		<bdi>
+			<slot></slot>
+		</bdi>
+	</span>
+
+</li>
+
+{{#*inline "ariaPressed"}}{{/inline}}

packages/main/src/SegmentedButtonItem.js

@@ -0,0 +1,96 @@
+import isLegacyBrowser from "@ui5/webcomponents-base/dist/isLegacyBrowser.js";
+import Button from "./Button.js";
+import SegmentedButtonItemTemplate from "./generated/templates/SegmentedButtonItemTemplate.lit.js";
+import { SEGMENTEDBUTTONITEM_ARIA_DESCRIPTION } from "./generated/i18n/i18n-defaults.js";
+
+// Styles
+import segmentedButtonItemCss from "./generated/themes/SegmentedButtonItem.css.js";
+import segmentedButtonItemIECss from "./generated/themes/SegmentedButtonItem.ie11.css.js";
+
+/**
+ * @public
+ */
+const metadata = {
+	tag: "ui5-segmentedbutton-item",
+	properties: /** @lends  sap.ui.webcomponents.main.SegmentedButtonItem.prototype */ {
+		/**
+		 * Determines whether the <code>ui5-segmentedbutton-item</code> is displayed as pressed.
+		 *
+		 * @type {boolean}
+		 * @defaultvalue false
+		 * @public
+		 */
+		pressed: {
+			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>
+ *
+ * The <code>ui5-segmentedbutton-item</code> component is an enhanced <code>ui5-button</code>
+ * that can be toggled between pressed and normal states.
+ * Users can use the <code>ui5-segmentedbutton-item</code> as part of a <code>ui5-segmentedbutton</code>.
+ * <br><br>
+ * Clicking or tapping on a <code>ui5-segmentedbutton-item</code> changes its state to <code>pressed</code>.
+ * The button 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-segmentedbutton-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 Button
+ * @tagname ui5-segmentedbutton-item
+ * @public
+ */
+class SegmentedButtonItem extends Button {
+	static get metadata() {
+		return metadata;
+	}
+
+	static get template() {
+		return SegmentedButtonItemTemplate;
+	}
+
+	static get styles() {
+		return [Button.styles, segmentedButtonItemCss, isLegacyBrowser() && segmentedButtonItemIECss];
+	}
+
+	get ariaDescription() {
+		return this.i18nBundle.getText(SEGMENTEDBUTTONITEM_ARIA_DESCRIPTION);
+	}
+
+	_onclick() {
+		this.pressed = !this.pressed;
+	}
+}
+
+SegmentedButtonItem.define();
+
+export default SegmentedButtonItem;

packages/main/src/i18n/messagebundle.properties

@@ -149,7 +149,13 @@ RATING_INDICATOR_TEXT=Rating Indicator
 RESPONSIVE_POPOVER_CLOSE_DIALOG_BUTTON=Decline
 
 #XACT: ARIA description for the segmented button
-SEGMENTEDBUTTON_ARIA_DESCRIPTION=Segmented button
+SEGMENTEDBUTTON_ARIA_DESCRIPTION=Segmented button group
+
+#XACT: ARIA described by for the segmented button
+SEGMENTEDBUTTON_ARIA_DESCRIBEDBY=Press SPACE or ENTER to select an item
+
+#XACT: ARIA description for the segmented button item
+SEGMENTEDBUTTONITEM_ARIA_DESCRIPTION=Segmented button
 
 #XACT: ARIA description for slider handle
 SLIDER_ARIA_DESCRIPTION=Slider handle

packages/main/src/themes/SegmentedButton.css

@@ -1,12 +1,16 @@
+@import "./InvisibleTextStyles.css";
+
 :host(:not([hidden])) {
 	display: inline-block;
 }
 
 .ui5-segmentedbutton-root {
 	display: flex;
+    margin: 0;
+    padding: 0;
 }
 
-::slotted([ui5-togglebutton]) {
+::slotted([ui5-segmentedbutton-item]) {
 	border-radius: 0;
 	height: var(--_ui5_button_base_height);
 	min-width: 2.5rem;
@@ -15,41 +19,41 @@
 	text-overflow: ellipsis;
 }
 
-::slotted([ui5-togglebutton]:nth-child(odd)) {
+::slotted([ui5-segmentedbutton-item]:nth-child(odd)) {
 	border: 1px solid var(--sapButton_Selected_BorderColor);
 	border-right: 0;
 	border-left: 0;
 }
 
-::slotted([ui5-togglebutton]:last-child) {
+::slotted([ui5-segmentedbutton-item]:last-child) {
 	border-top-right-radius: var(--_ui5_segmented_btn_border_radius);
 	border-bottom-right-radius: var(--_ui5_segmented_btn_border_radius);
 	border-right: 1px solid var(--sapButton_Selected_BorderColor);
 }
 
-::slotted([ui5-togglebutton]:first-child) {
+::slotted([ui5-segmentedbutton-item]:first-child) {
 	border-top-left-radius: var(--_ui5_segmented_btn_border_radius);
 	border-bottom-left-radius: var(--_ui5_segmented_btn_border_radius);
 	border-left: 1px solid var(--sapButton_Selected_BorderColor);
 }
 
-[dir="rtl"] ::slotted([ui5-togglebutton]:first-child) {
+[dir="rtl"] ::slotted([ui5-segmentedbutton-item]:first-child) {
 	border-top-right-radius: var(--_ui5_segmented_btn_border_radius);
 	border-bottom-right-radius: var(--_ui5_segmented_btn_border_radius);
 	border-top-left-radius: 0;
 	border-bottom-left-radius: 0;
 	border-right: 1px solid var(--sapButton_Selected_BorderColor);
 }
 
-[dir="rtl"] ::slotted([ui5-togglebutton]:last-child) {
+[dir="rtl"] ::slotted([ui5-segmentedbutton-item]:last-child) {
 	border-top-right-radius: 0;
 	border-bottom-right-radius: 0;
 	border-top-left-radius: var(--_ui5_segmented_btn_border_radius);
 	border-bottom-left-radius: var(--_ui5_segmented_btn_border_radius);
 	border-left: 1px solid var(--sapButton_Selected_BorderColor);
 }
 
-[dir="rtl"] ::slotted([ui5-togglebutton]:only-child) {
+[dir="rtl"] ::slotted([ui5-segmentedbutton-item]:only-child) {
 	border-top-right-radius: var(--_ui5_segmented_btn_border_radius);
 	border-bottom-right-radius: var(--_ui5_segmented_btn_border_radius);
 	border-top-left-radius: var(--_ui5_segmented_btn_border_radius);

packages/main/src/themes/SegmentedButtonItem.css

@@ -0,0 +1,22 @@
+:host(:not([hidden])) {
+	display: inline-block;
+}
+
+/* this line is also included from the Button.css, but keep it here in case we start using it for automatic IE11 compilation */
+:host([disabled]) {
+	pointer-events: none;
+}
+
+:host([pressed]),
+:host([pressed]:hover),
+:host([pressed][focused]) {
+	background: var(--sapButton_Selected_Background);
+	border-color: var(--sapButton_Selected_BorderColor);
+	color: var(--sapButton_Selected_TextColor);
+	outline-color: var(--sapContent_ContrastFocusColor);
+}
+
+:host([pressed][active]),
+:host([pressed]:not([active]):not([non-interactive]):not([_is-touch]):hover) {
+	background: var(--sapButton_Selected_Hover_Background);
+}

packages/main/src/themes/SegmentedButtonItem.ie11.css

@@ -0,0 +1,28 @@
+[ui5-segmentedbutton-item][focused] {
+	outline: none;
+}
+
+[ui5-segmentedbutton-item][focused] .ui5-button-root {
+	position: relative;
+}
+
+[ui5-segmentedbutton-item][focused] .ui5-button-root::after {
+	content: "";
+	position: absolute;
+	border-width: 1px;
+	border-style: dotted;
+	border-color: var(--_ui5_button_focus_color);
+	top: var(--_ui5_button_focus_offset);
+	bottom: var(--_ui5_button_focus_offset);
+	left: var(--_ui5_button_focus_offset);
+	right: var(--_ui5_button_focus_offset);
+}
+
+[ui5-segmentedbutton-item][active] .ui5-button-root::after {
+	border-color: var(--sapContent_ContrastFocusColor);
+}
+
+[ui5-segmentedbutton-item] [ui5-icon].ui5-button-icon {
+	height: var(--_ui5_button_icon_font_size); /* Center vertically all icons*/
+	top: 0;
+}