@ui5/webcomponents 0.0.0-e7dd012d7 → 0.0.0-ec448881d

package/dist/RadioButton.js

@@ -2,8 +2,9 @@ import { isDesktop } from "@ui5/webcomponents-base/dist/Device.js";
 import { getFeature } from "@ui5/webcomponents-base/dist/FeaturesRegistry.js";
 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 { getI18nBundle } from "@ui5/webcomponents-base/dist/i18nBundle.js";
 import ValueState from "@ui5/webcomponents-base/dist/types/ValueState.js";
+import { getEffectiveAriaLabelText } from "@ui5/webcomponents-base/dist/util/AriaLabelHelper.js";
 import {
 	isSpace,
 	isEnter,
@@ -14,28 +15,38 @@ import {
 } from "@ui5/webcomponents-base/dist/Keys.js";
 import Label from "./Label.js";
 import RadioButtonGroup from "./RadioButtonGroup.js";
+import WrappingType from "./types/WrappingType.js";
 
 // Template
 import RadioButtonTemplate from "./generated/templates/RadioButtonTemplate.lit.js";
 
 // i18n
-import { VALUE_STATE_ERROR, VALUE_STATE_WARNING } from "./generated/i18n/i18n-defaults.js";
+import {
+	VALUE_STATE_ERROR,
+	VALUE_STATE_WARNING,
+	VALUE_STATE_SUCCESS,
+	VALUE_STATE_INFORMATION,
+} from "./generated/i18n/i18n-defaults.js";
 
 // Styles
 import radioButtonCss from "./generated/themes/RadioButton.css.js";
 
+let isGlobalHandlerAttached = false;
+let activeRadio = null;
+
 /**
  * @public
  */
 const metadata = {
-	tag: "ui5-radiobutton",
+	tag: "ui5-radio-button",
+	altTag: "ui5-radiobutton",
 	languageAware: true,
-	properties: /** @lends sap.ui.webcomponents.main.RadioButton.prototype */  {
+	properties: /** @lends sap.ui.webcomponents.main.RadioButton.prototype */ {
 
 		/**
-		 * Determines whether the <code>ui5-radiobutton</code> is disabled.
+		 * Defines whether the component is disabled.
 		 * <br><br>
-		 * <b>Note:</b> A disabled <code>ui5-radiobutton</code> is completely noninteractive.
+		 * <b>Note:</b> A disabled component is completely noninteractive.
 		 *
 		 * @type {boolean}
 		 * @defaultvalue false
@@ -46,9 +57,9 @@ const metadata = {
 		},
 
 		/**
-		 * Determines whether the <code>ui5-radiobutton</code> is read-only.
+		 * Defines whether the component is read-only.
 		 * <br><br>
-		 * <b>Note:</b> A read-only <code>ui5-radiobutton</code> is not editable,
+		 * <b>Note:</b> A read-only component is not editable,
 		 * but still provides visual feedback upon user interaction.
 		 *
 		 * @type {boolean}
@@ -60,22 +71,23 @@ const metadata = {
 		},
 
 		/**
-		 * Determines whether the <code>ui5-radiobutton</code> is selected or not.
+		 * Defines whether the component is checked or not.
 		 * <br><br>
 		 * <b>Note:</b> The property value can be changed with user interaction,
-		 * either by cliking/tapping on the <code>ui5-radiobutton</code>,
+		 * either by clicking/tapping on the component,
 		 * or by using the Space or Enter key.
 		 *
 		 * @type {boolean}
 		 * @defaultvalue false
 		 * @public
+		 * @since 1.0.0-rc.15
 		 */
-		selected: {
+		checked: {
 			type: Boolean,
 		},
 
 		/**
-		 * Defines the text of the <code>ui5-radiobutton</code>.
+		 * Defines the text of the component.
 		 *
 		 * @type  {string}
 		 * @defaultvalue ""
@@ -86,13 +98,15 @@ const metadata = {
 		},
 
 		/**
-		 * Defines the value state of the <code>ui5-radiobutton</code>.
+		 * Defines the value state of the component.
 		 * <br><br>
 		 * Available options are:
 		 * <ul>
 		 * <li><code>None</code></li>
 		 * <li><code>Error</code></li>
 		 * <li><code>Warning</code></li>
+		 * <li><code>Success</code></li>
+		 * <li><code>Information</code></li>
 		 * </ul>
 		 *
 		 * @type {ValueState}
@@ -105,7 +119,7 @@ const metadata = {
 		},
 
 		/**
-		 * Defines the name of the <code>ui5-radiobutton</code>.
+		 * Defines the name of the component.
 		 * Radio buttons with the same <code>name</code> will form a radio button group.
 		 *
 		 * <br><br>
@@ -122,7 +136,7 @@ const metadata = {
 		 *
 		 * <br><br>
 		 * <b>Note:</b> When set, a native <code>input</code> HTML element
-		 * will be created inside the <code>ui5-radiobutton</code> so that it can be submitted as
+		 * will be created inside the component so that it can be submitted as
 		 * part of an HTML form.
 		 *
 		 * @type {string}
@@ -134,7 +148,7 @@ const metadata = {
 		},
 
 		/**
-		 * Defines the form value of the <code>ui5-radiobutton</code>.
+		 * Defines the form value of the component.
 		 * When a form with a radio button group is submitted, the group's value
 		 * will be the value of the currently selected radio button.
 		 * <br>
@@ -150,27 +164,83 @@ const metadata = {
 		},
 
 		/**
-		 * Defines whether the <code>ui5-radiobutton</code> text wraps when there is not enough space.
+		 * Defines whether the component text wraps when there is not enough space.
 		 * <br><br>
-		 * <b>Note:</b> By default, the text truncates when there is not enough space.
+		 * Available options are:
+		 * <ul>
+		 * <li><code>None</code> - The text will be truncated with an ellipsis.</li>
+		 * <li><code>Normal</code> - The text will wrap. The words will not be broken based on hyphenation.</li>
+		 * </ul>
 		 *
-		 * @type {boolean}
-		 * @defaultvalue false
+		 * @type {WrappingType}
+		 * @defaultvalue "None"
 		 * @public
 		 */
-		wrap: {
+		wrappingType: {
+			type: WrappingType,
+			defaultValue: WrappingType.None,
+		},
+
+		/**
+		 * Defines the accessible name of the component.
+		 *
+		 * @type {string}
+		 * @defaultvalue ""
+		 * @private
+		 * @since 1.0.0-rc.16
+		 */
+		accessibleName: {
+			type: String,
+		},
+
+		/**
+		 * Defines the IDs of the elements that label the component.
+		 *
+		 * @type {string}
+		 * @defaultvalue ""
+		 * @public
+		 * @since 1.1.0
+		 */
+		accessibleNameRef: {
+			type: String,
+		},
+
+		_tabIndex: {
+			type: String,
+			defaultValue: "-1",
+			noAttribute: true,
+		},
+
+		/**
+		 * Defines the active state (pressed or not) of the component.
+		 * @private
+		 */
+		 active: {
 			type: Boolean,
 		},
 	},
+	slots: /** @lends sap.ui.webcomponents.main.RadioButton.prototype */ {
+		/**
+		 * The slot is used to render native <code>input</code> HTML element within Light DOM to enable form submit,
+		 * when <code>name</code> property is set.
+		 * @type {HTMLElement[]}
+		 * @slot
+		 * @private
+		 */
+		formSupport: {
+			type: HTMLElement,
+		},
+	},
 	events: /** @lends sap.ui.webcomponents.main.RadioButton.prototype */ {
 
 		/**
-		 * Fired when the <code>ui5-radiobutton</code> selected state changes.
+		 * Fired when the component checked state changes.
 		 *
 		 * @event
 		 * @public
+		 * @since 1.0.0-rc.15
 		 */
-		select: {},
+		change: {},
 	},
 };
 
@@ -179,17 +249,17 @@ const metadata = {
  *
  * <h3 class="comment-api-title">Overview</h3>
  *
- * The <code>ui5-radiobutton</code> component enables users to select a single option from a set of options.
- * When a <code>ui5-radiobutton</code> is selected by the user, the
- * <code>select</code> event is fired.
- * When a <code>ui5-radiobutton</code> that is within a group is selected, the one
+ * The <code>ui5-radio-button</code> component enables users to select a single option from a set of options.
+ * When a <code>ui5-radio-button</code> is selected by the user, the
+ * <code>change</code> event is fired.
+ * When a <code>ui5-radio-button</code> that is within a group is selected, the one
  * that was previously selected gets automatically deselected. You can group radio buttons by using the <code>name</code> property.
  * <br>
- * <b>Note:</b> If <code>ui5-radiobutton</code> is not part of a group, it can be selected once, but can not be deselected back.
+ * <b>Note:</b> If <code>ui5-radio-button</code> is not part of a group, it can be selected once, but can not be deselected back.
  *
  * <h3>Keyboard Handling</h3>
  *
- * Once the <code>ui5-radiobutton</code> is on focus, it might be selected by pressing the Space and Enter keys.
+ * Once the <code>ui5-radio-button</code> is on focus, it might be selected by pressing the Space and Enter keys.
  * <br>
  * The Arrow Down/Arrow Up and Arrow Left/Arrow Right keys can be used to change selection between next/previous radio buttons in one group,
  * while TAB and SHIFT + TAB can be used to enter or leave the radio button group.
@@ -204,14 +274,23 @@ const metadata = {
  * @author SAP SE
  * @alias sap.ui.webcomponents.main.RadioButton
  * @extends sap.ui.webcomponents.base.UI5Element
- * @tagname ui5-radiobutton
+ * @tagname ui5-radio-button
  * @public
  */
 class RadioButton extends UI5Element {
 	constructor() {
 		super();
 
-		this.i18nBundle = getI18nBundle("@ui5/webcomponents");
+		this._deactivate = () => {
+			if (activeRadio) {
+				activeRadio.active = false;
+			}
+		};
+
+		if (!isGlobalHandlerAttached) {
+			document.addEventListener("mouseup", this._deactivate);
+			isGlobalHandlerAttached = true;
+		}
 	}
 
 	static get metadata() {
@@ -235,7 +314,7 @@ class RadioButton extends UI5Element {
 	}
 
 	static async onDefine() {
-		await fetchI18nBundle("@ui5/webcomponents");
+		RadioButton.i18nBundle = await getI18nBundle("@ui5/webcomponents");
 	}
 
 	onBeforeRendering() {
@@ -247,6 +326,8 @@ class RadioButton extends UI5Element {
 	syncGroup() {
 		const oldGroup = this._name;
 		const currentGroup = this.name;
+		const oldChecked = this._checked;
+		const currentChecked = this.checked;
 
 		if (currentGroup !== oldGroup) {
 			if (oldGroup) {
@@ -262,15 +343,20 @@ class RadioButton extends UI5Element {
 			RadioButtonGroup.enforceSingleSelection(this, currentGroup);
 		}
 
+		if (this.name && currentChecked !== oldChecked) {
+			RadioButtonGroup.updateTabOrder(this.name);
+		}
+
 		this._name = this.name;
+		this._checked = this.checked;
 	}
 
 	_enableFormSupport() {
 		const FormSupport = getFeature("FormSupport");
 		if (FormSupport) {
 			FormSupport.syncNativeHiddenInput(this, (element, nativeInput) => {
-				nativeInput.disabled = element.disabled || !element.selected;
-				nativeInput.value = element.selected ? element.value : "";
+				nativeInput.disabled = element.disabled || !element.checked;
+				nativeInput.value = element.checked ? element.value : "";
 			});
 		} else if (this.value) {
 			console.warn(`In order for the "value" property to have effect, you should also: import "@ui5/webcomponents/dist/features/InputElementsFormSupport.js";`); // eslint-disable-line
@@ -305,10 +391,12 @@ class RadioButton extends UI5Element {
 
 	_onkeydown(event) {
 		if (isSpace(event)) {
+			this.active = true;
 			return event.preventDefault();
 		}
 
 		if (isEnter(event)) {
+			this.active = true;
 			return this.toggle();
 		}
 
@@ -325,6 +413,21 @@ class RadioButton extends UI5Element {
 		if (isSpace(event)) {
 			this.toggle();
 		}
+
+		this.active = false;
+	}
+
+	_onmousedown() {
+		this.active = true;
+		activeRadio = this; // eslint-disable-line
+	}
+
+	_onmouseup() {
+		this.active = false;
+	}
+
+	_onfocusout() {
+		this.active = false;
 	}
 
 	toggle() {
@@ -333,8 +436,8 @@ class RadioButton extends UI5Element {
 		}
 
 		if (!this.name) {
-			this.selected = !this.selected;
-			this.fireEvent("select");
+			this.checked = !this.checked;
+			this.fireEvent("change");
 			return this;
 		}
 
@@ -343,20 +446,21 @@ class RadioButton extends UI5Element {
 	}
 
 	canToggle() {
-		return !(this.disabled || this.readonly || this.selected);
+		return !(this.disabled || this.readonly || this.checked);
 	}
 
 	valueStateTextMappings() {
-		const i18nBundle = this.i18nBundle;
-
 		return {
-			"Error": i18nBundle.getText(VALUE_STATE_ERROR),
-			"Warning": i18nBundle.getText(VALUE_STATE_WARNING),
+			"Error": RadioButton.i18nBundle.getText(VALUE_STATE_ERROR),
+			"Warning": RadioButton.i18nBundle.getText(VALUE_STATE_WARNING),
+			"Success": RadioButton.i18nBundle.getText(VALUE_STATE_SUCCESS),
+			"Information": RadioButton.i18nBundle.getText(VALUE_STATE_INFORMATION),
 		};
 	}
 
 	get classes() {
 		return {
+			main: {},
 			inner: {
 				"ui5-radio-inner--hoverable": !this.disabled && !this.readonly && isDesktop(),
 			},
@@ -371,8 +475,8 @@ class RadioButton extends UI5Element {
 		return this.disabled ? "true" : undefined;
 	}
 
-	get ariaLabelledBy() {
-		return this.text ? `${this._id}-label` : undefined;
+	get ariaLabelText() {
+		return [getEffectiveAriaLabelText(this), this.text].filter(Boolean).join(" ");
 	}
 
 	get ariaDescribedBy() {
@@ -395,7 +499,7 @@ class RadioButton extends UI5Element {
 		}
 
 		if (this.name) {
-			return this.selected ? "0" : "-1";
+			return this._tabIndex;
 		}
 
 		return tabindex || "0";

package/dist/RadioButtonGroup.js

@@ -7,12 +7,12 @@ class RadioButtonGroup {
 		return this.groups.get(groupName);
 	}
 
-	static getSelectedRadioFromGroup(groupName) {
-		return this.selectedRadios.get(groupName);
+	static getCheckedRadioFromGroup(groupName) {
+		return this.checkedRadios.get(groupName);
 	}
 
 	static removeGroup(groupName) {
-		this.selectedRadios.delete(groupName);
+		this.checkedRadios.delete(groupName);
 		return this.groups.delete(groupName);
 	}
 
@@ -23,6 +23,8 @@ class RadioButtonGroup {
 		} else {
 			this.createGroup(radioBtn, groupName);
 		}
+
+		this.updateTabOrder(groupName);
 	}
 
 	static removeFromGroup(radioBtn, groupName) {
@@ -31,7 +33,7 @@ class RadioButtonGroup {
 		}
 
 		const group = this.getGroup(groupName);
-		const selectedRadio = this.getSelectedRadioFromGroup(groupName);
+		const checkedRadio = this.getCheckedRadioFromGroup(groupName);
 
 		// Remove the radio button from the given group
 		group.forEach((_radioBtn, idx, arr) => {
@@ -40,19 +42,21 @@ class RadioButtonGroup {
 			}
 		});
 
-		if (selectedRadio === radioBtn) {
-			this.selectedRadios.set(groupName, null);
+		if (checkedRadio === radioBtn) {
+			this.checkedRadios.set(groupName, null);
 		}
 
 		// Remove the group if it is empty
 		if (!group.length) {
 			this.removeGroup(groupName);
 		}
+
+		this.updateTabOrder(groupName);
 	}
 
 	static createGroup(radioBtn, groupName) {
-		if (radioBtn.selected) {
-			this.selectedRadios.set(groupName, radioBtn);
+		if (radioBtn.checked) {
+			this.checkedRadios.set(groupName, radioBtn);
 		}
 
 		this.groups.set(groupName, [radioBtn]);
@@ -72,6 +76,23 @@ class RadioButtonGroup {
 		this.updateSelectionInGroup(nextItemToSelect, groupName);
 	}
 
+	static updateTabOrder(groupName) {
+		if (!this.hasGroup(groupName)) {
+			return;
+		}
+
+		const group = this.getGroup(groupName);
+		const hasCheckedRadio = group.some(radioBtn => radioBtn.checked);
+
+		group.filter(radioBtn => !radioBtn.disabled).forEach((radioBtn, idx) => {
+			if (hasCheckedRadio) {
+				radioBtn._tabIndex = radioBtn.checked ? "0" : "-1";
+			} else {
+				radioBtn._tabIndex = idx === 0 ? "0" : "-1";
+			}
+		});
+	}
+
 	static selectPreviousItem(item, groupName) {
 		const group = this.getGroup(groupName),
 			groupLength = group.length,
@@ -88,28 +109,29 @@ class RadioButtonGroup {
 
 	static selectItem(item, groupName) {
 		this.updateSelectionInGroup(item, groupName);
+		this.updateTabOrder(groupName);
 	}
 
 	static updateSelectionInGroup(radioBtnToSelect, groupName) {
-		const selectedRadio = this.getSelectedRadioFromGroup(groupName);
+		const checkedRadio = this.getCheckedRadioFromGroup(groupName);
 
-		this._deselectRadio(selectedRadio);
+		this._deselectRadio(checkedRadio);
 		this._selectRadio(radioBtnToSelect);
-		this.selectedRadios.set(groupName, radioBtnToSelect);
+		this.checkedRadios.set(groupName, radioBtnToSelect);
 	}
 
 	static _deselectRadio(radioBtn) {
 		if (radioBtn) {
-			radioBtn.selected = false;
+			radioBtn.checked = false;
 		}
 	}
 
 	static _selectRadio(radioBtn) {
 		if (radioBtn) {
 			radioBtn.focus();
-			radioBtn.selected = true;
-			radioBtn._selected = true;
-			radioBtn.fireEvent("select");
+			radioBtn.checked = true;
+			radioBtn._checked = true;
+			radioBtn.fireEvent("change");
 		}
 	}
 
@@ -149,18 +171,20 @@ class RadioButtonGroup {
 	}
 
 	static enforceSingleSelection(radioBtn, groupName) {
-		const selectedRadio = this.getSelectedRadioFromGroup(groupName);
-
-		if (radioBtn.selected) {
-			if (!selectedRadio) {
-				this.selectedRadios.set(groupName, radioBtn);
-			} else if (radioBtn !== selectedRadio) {
-				this._deselectRadio(selectedRadio);
-				this.selectedRadios.set(groupName, radioBtn);
+		const checkedRadio = this.getCheckedRadioFromGroup(groupName);
+
+		if (radioBtn.checked) {
+			if (!checkedRadio) {
+				this.checkedRadios.set(groupName, radioBtn);
+			} else if (radioBtn !== checkedRadio) {
+				this._deselectRadio(checkedRadio);
+				this.checkedRadios.set(groupName, radioBtn);
 			}
-		} else if (radioBtn === selectedRadio) {
-			this.selectedRadios.set(groupName, null);
+		} else if (radioBtn === checkedRadio) {
+			this.checkedRadios.set(groupName, null);
 		}
+
+		this.updateTabOrder(groupName);
 	}
 
 	static get groups() {
@@ -170,11 +194,11 @@ class RadioButtonGroup {
 		return this._groups;
 	}
 
-	static get selectedRadios() {
-		if (!this._selectedRadios) {
-			this._selectedRadios = new Map();
+	static get checkedRadios() {
+		if (!this._checkedRadios) {
+			this._checkedRadios = new Map();
 		}
-		return this._selectedRadios;
+		return this._checkedRadios;
 	}
 }