@ui5/webcomponents 0.0.0-0fcda382e → 0.0.0-1929d08ff

package/dist/SplitButton.js

@@ -0,0 +1,426 @@
+import UI5Element from "@ui5/webcomponents-base/dist/UI5Element.js";
+import {
+	isEscape,
+	isSpace,
+	isEnter,
+	isDown,
+	isUp,
+	isDownAlt,
+	isUpAlt,
+	isF4,
+	isShift,
+} from "@ui5/webcomponents-base/dist/Keys.js";
+import { getI18nBundle } from "@ui5/webcomponents-base/dist/i18nBundle.js";
+import litRender from "@ui5/webcomponents-base/dist/renderer/LitRenderer.js";
+import SplitButtonTemplate from "./generated/templates/SplitButtonTemplate.lit.js";
+import ButtonDesign from "./types/ButtonDesign.js";
+
+import {
+	SPLIT_BUTTON_DESCRIPTION,
+	SPLIT_BUTTON_KEYBOARD_HINT,
+} from "./generated/i18n/i18n-defaults.js";
+
+// Styles
+import SplitButtonCss from "./generated/themes/SplitButton.css.js";
+
+/**
+ * @public
+ */
+const metadata = {
+	tag: "ui5-split-button",
+	managedSlots: true,
+	properties: /** @lends sap.ui.webcomponents.main.SplitButton.prototype */ {
+		/**
+		 * Defines the icon to be displayed as graphical element within the component.
+		 * The SAP-icons font provides numerous options.
+		 * <br><br>
+		 * Example:
+		 *
+		 * See all the available icons in the <ui5-link target="_blank" href="https://openui5.hana.ondemand.com/test-resources/sap/m/demokit/iconExplorer/webapp/index.html" class="api-table-content-cell-link">Icon Explorer</ui5-link>.
+		 *
+		 * @type {string}
+		 * @defaultvalue ""
+		 * @public
+		 */
+		icon: {
+			type: String,
+		},
+
+		/**
+		 * Defines the icon to be displayed in active state as graphical element within the component.
+		 *
+		 * @type {string}
+		 * @defaultvalue ""
+		 * @public
+		 */
+		activeIcon: {
+			type: String,
+		},
+
+		/**
+		 * Defines the component design.
+		 *
+		 * <br><br>
+		 * <b>The available values are:</b>
+		 *
+		 * <ul>
+		 * <li><code>Default</code></li>
+		 * <li><code>Emphasized</code></li>
+		 * <li><code>Positive</code></li>
+		 * <li><code>Negative</code></li>
+		 * <li><code>Transparent</code></li>
+		 * <li><code>Attention</code></li>
+		 * </ul>
+		 *
+		 * @type {ButtonDesign}
+		 * @defaultvalue "Default"
+		 * @public
+		 */
+		design: {
+			type: ButtonDesign,
+			defaultValue: ButtonDesign.Default,
+		},
+
+		/**
+		 * Defines whether the component is disabled.
+		 * A disabled component can't be pressed or
+		 * focused, and it is not in the tab chain.
+		 *
+		 * @type {boolean}
+		 * @defaultvalue false
+		 * @public
+		 */
+		disabled: {
+			type: Boolean,
+		},
+
+		/**
+		 * Defines the accessible aria name of the component.
+		 *
+		 * @type {string}
+		 * @defaultvalue: ""
+		 * @public
+		 */
+		 accessibleName: {
+			type: String,
+			defaultValue: undefined,
+		},
+
+		/**
+		 * Indicates if the elements is on focus
+		 * @type {boolean}
+		 * @defaultvalue false
+		 * @private
+		 */
+		 focused: {
+			type: Boolean,
+		},
+
+		/**
+		 * Accessibility-related properties for inner elements of the Split Button
+		 *
+		 * @type {Object}
+		 * @private
+		 */
+		_splitButtonAccInfo: {
+			type: Object,
+		},
+
+		/**
+		 * Defines the tabIndex of the component.
+		 * @type {string}
+		 * @defaultvalue ""
+		 * @private
+		 */
+		_tabIndex: {
+			type: String,
+			defaultValue: "0",
+			noAttribute: true,
+		},
+
+		/**
+		 * Indicates if there is Space key pressed
+		 * @type {boolean}
+		 * @defaultvalue false
+		 * @private
+		 */
+		_spacePressed: {
+			type: Boolean,
+			noAttribute: true,
+		},
+
+		/**
+		 * Indicates if there is SHIFT or ESCAPE key pressed
+		 * @type {boolean}
+		 * @defaultvalue false
+		 * @private
+		 */
+		_shiftOrEscapePressed: {
+			type: Boolean,
+			noAttribute: true,
+		},
+
+		/**
+		 * Defines the active state of the text button
+		 * @type {boolean}
+		 * @defaultvalue false
+		 * @private
+		 */
+		 _textButtonActive: {
+			type: Boolean,
+			noAttribute: true,
+		},
+
+		/**
+		 * Defines the icon of the text button
+		 * @type {string}
+		 * @defaultvalue ""
+		 * @private
+		 */
+		 _textButtonIcon: {
+			type: String,
+			noAttribute: true,
+		},
+
+		/**
+		 * Defines the active state of the arrow button
+		 * @type {boolean}
+		 * @defaultvalue false
+		 * @private
+		 */
+		 _arrowButtonActive: {
+			type: Boolean,
+			noAttribute: true,
+		},
+	},
+	slots: /** @lends sap.ui.webcomponents.main.SplitButton.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,
+			propertyName: "text",
+		},
+	},
+	events: /** @lends sap.ui.webcomponents.main.SplitButton.prototype */ {
+		/**
+		 * Fired when the user clicks on the default action.
+		 * @event
+		 * @public
+		 */
+		"click": {},
+
+		/**
+		 * Fired when the user clicks on the arrow action.
+		 * @event sap.ui.webcomponents.main.SplitButton#arrow-click
+		 * @public
+		 */
+		"arrow-click": {},
+	 },
+};
+
+/**
+ * @class
+ *
+ * <h3 class="comment-api-title">Overview</h3>
+ *
+ * <code>ui5-split-button</code> enables users to trigger actions. It is constructed of two separate actions -
+ * default action and arrow action that can be activated by clicking or tapping, or by
+ * pressing certain keyboard keys - <code>Space</code> or <code>Enter</code> for default action,
+ * and <code>Arrow Down</code> or <code>Arrow Up</code> for arrow action.
+ *
+ * <h3>Usage</h3>
+ *
+ * <code>ui5-split-button</code> consists two separate buttons:
+ * <ul>
+ * <li>for the first one (default action) you can define some <code>text</code> or an <code>icon</code>, or both.
+ * Also, it is possible to define different icon for active state of this button - <code>activeIcon</code>.</li>
+ * <li>the second one (arrow action) contains only <code>slim-arrow-down</code> icon.</li>
+ * </ul>
+ * You can choose a <code>design</code> from a set of predefined types (the same as for ui5-button) that offer
+ * different styling to correspond to the triggered action. Both text and arrow actions have the same design.
+ * <br><br>
+ * You can set the <code>ui5-split-button</code> as enabled or disabled. Both parts of an enabled
+ * <code>ui5-split-button</code> can be pressed by clicking or tapping it, or by certain keys, which changes
+ * the style to provide visual feedback to the user that it is pressed or hovered over with
+ * the mouse cursor. A disabled <code>ui5-split-button</code> appears inactive and any of the two buttons
+ * cannot be pressed.
+ *
+ * <h3>Keyboard Handling</h3>
+ * <ul>
+ * <li><code>Space</code> or <code>Enter</code> - triggers the default action</li>
+ * <li><code>Shift</code> or <code>Escape</code> - if <code>Space</code> is pressed, releases the default action button without triggering the click event.</li>
+ * <li><code>Arrow Down</code>, <code>Arrow Up</code>, <code>Alt</code>+<code>Arrow Down</code>, <code>Alt</code>+<code>Arrow Up</code>, or <code>F4</code> - triggers the arrow action
+ * There are separate events that are fired on activating of <code>ui5-split-button</code> parts:
+ * <ul>
+ * <li><code>click</code> for the first button (default action)</li>
+ * <li><code>arrow-click</code> for the second button (arrow action)</li>
+ * </ul>
+ * </ul>
+ *
+ * <h3>ES6 Module Import</h3>
+ *
+ * <code>import "@ui5/webcomponents/dist/SplitButton.js";</code>
+ *
+ * @constructor
+ * @author SAP SE
+ * @alias sap.ui.webcomponents.main.SplitButton
+ * @extends UI5Element
+ * @tagname ui5-split-button
+ * @public
+ * @since 1.1.0
+ */
+class SplitButton extends UI5Element {
+	static get metadata() {
+		return metadata;
+	}
+
+	static get render() {
+		return litRender;
+	}
+
+	static get styles() {
+		return SplitButtonCss;
+	}
+
+	static get template() {
+		return SplitButtonTemplate;
+	}
+
+	static async onDefine() {
+		SplitButton.i18nBundle = await getI18nBundle("@ui5/webcomponents");
+	}
+
+	onBeforeRendering() {
+		this._textButtonIcon = this.textButton && this.activeIcon !== "" && (this._textButtonActive) && !this._shiftOrEscapePressed ? this.activeIcon : this.icon;
+		if (this.disabled) {
+			this._tabIndex = "-1";
+		}
+	}
+
+	_onFocusOut(event) {
+		if (this.disabled || event.isMarked) {
+			return;
+		}
+		this._shiftOrEscapePressed = false;
+		this.focused = false;
+		this._setTabIndexValue();
+	}
+
+	_onFocusIn(event) {
+		if (this.disabled || event.isMarked) {
+			return;
+		}
+		this._shiftOrEscapePressed = false;
+		this.focused = true;
+	}
+
+	_onKeyDown(event) {
+		if (isDown(event) || isUp(event) || isDownAlt(event) || isUpAlt(event) || isF4(event)) {
+			event.preventDefault();
+			this._arrowButtonActive = true;
+			this._fireArrowClick();
+		} else if (isSpace(event) || isEnter(event)) {
+			event.preventDefault();
+			this._textButtonActive = true;
+			if (isEnter(event)) {
+				this._fireClick();
+			} else {
+				this._spacePressed = true;
+			}
+		}
+		if (this._spacePressed && (isEscape(event) || isShift(event))) {
+			this._shiftOrEscapePressed = true;
+			this._textButtonActive = false;
+		}
+
+		this._setTabIndexValue();
+	}
+
+	_onKeyUp(event) {
+		if (isDown(event) || isUp(event) || isDownAlt(event) || isUpAlt(event) || isF4(event)) {
+			this._arrowButtonActive = false;
+		} else if (isSpace(event) || isEnter(event)) {
+			this._textButtonActive = false;
+			if (isSpace(event)) {
+				event.preventDefault();
+				event.stopPropagation();
+				this._fireClick();
+				this._spacePressed = false;
+			}
+		}
+
+		this._setTabIndexValue();
+	}
+
+	_fireClick(event) {
+		event && event.stopPropagation();
+		if (!this._shiftOrEscapePressed) {
+			this.fireEvent("click");
+		}
+		this._shiftOrEscapePressed = false;
+	}
+
+	_fireArrowClick(event) {
+		event && event.stopPropagation();
+		this.fireEvent("arrow-click");
+	}
+
+	_textButtonRelease() {
+		this._textButtonActive = false;
+		this._textButtonIcon = this.textButton && this.activeIcon !== "" && (this._textButtonActive) && !this._shiftOrEscapePressed ? this.activeIcon : this.icon;
+		this._setTabIndexValue();
+	}
+
+	_textButtonPress() {
+		this._textButtonActive = true;
+		this.focused = false;
+		this._setTabIndexValue();
+	}
+
+	_setTabIndexValue() {
+		const textButton = this.textButton,
+			arrowButton = this.arrowButton,
+			buttonsAction = (textButton && (textButton.focused || textButton.active))
+						 || (arrowButton && (arrowButton.focused || arrowButton.active));
+
+		this._tabIndex = this.disabled || buttonsAction ? "-1" : "0";
+	}
+
+	get textButtonAccText() {
+		return this.textContent;
+	}
+
+	get textButton() {
+		return this.getDomRef() && this.getDomRef().querySelector(".ui5-split-text-button");
+	}
+
+	get arrowButton() {
+		return this.getDomRef() && this.getDomRef().querySelector(".ui5-split-arrow-button");
+	}
+
+	get accessibilityInfo() {
+		return {
+			// affects arrow button
+			ariaExpanded: this._splitButtonAccInfo && this._splitButtonAccInfo.ariaExpanded,
+			ariaHaspopup: this._splitButtonAccInfo && this._splitButtonAccInfo.ariaHaspopup,
+			// affects root element
+			description: SplitButton.i18nBundle.getText(SPLIT_BUTTON_DESCRIPTION),
+			keyboardHint: SplitButton.i18nBundle.getText(SPLIT_BUTTON_KEYBOARD_HINT),
+		};
+	}
+
+	get ariaLabelText() {
+		return [SplitButton.i18nBundle.getText(SPLIT_BUTTON_DESCRIPTION), SplitButton.i18nBundle.getText(SPLIT_BUTTON_KEYBOARD_HINT)].join(" ");
+	}
+}
+
+SplitButton.define();
+
+export default SplitButton;

package/dist/StandardListItem.js

@@ -1,6 +1,7 @@
 import ValueState from "@ui5/webcomponents-base/dist/types/ValueState.js";
 import ListItem from "./ListItem.js";
 import Icon from "./Icon.js";
+import Avatar from "./Avatar.js";
 import StandardListItemTemplate from "./generated/templates/StandardListItemTemplate.lit.js";
 
 /**
@@ -25,7 +26,7 @@ const metadata = {
 		 * Defines the <code>icon</code> source URI.
 		 * <br><br>
 		 * <b>Note:</b>
-		 * SAP-icons font provides numerous buil-in icons. To find all the available icons, see the
+		 * SAP-icons font provides numerous built-in icons. To find all the available icons, see the
 		 * <ui5-link target="_blank" href="https://openui5.hana.ondemand.com/test-resources/sap/m/demokit/iconExplorer/webapp/index.html" class="api-table-content-cell-link">Icon Explorer</ui5-link>.
 		 *
 		 * @type {string}
@@ -61,29 +62,42 @@ const metadata = {
 		},
 
 		/**
-		 * Defines the <code>info</code>, displayed in the end of the list item.
+		 * Defines the <code>additionalText</code>, displayed in the end of the list item.
 		 * @type {string}
 		 * @public
-		 * @since 0.13.0
+		 * @since 1.0.0-rc.15
 		 */
-		info: {
+		additionalText: {
 			type: String,
 		},
 
 		/**
-		 * Defines the state of the <code>info</code>.
+		 * Defines the state of the <code>additionalText</code>.
 		 * <br>
-		 * Available options are: <code>"None"</code> (by default), <code>"Success"</code>, <code>"Warning"</code> and <code>"Erorr"</code>.
+		 * Available options are: <code>"None"</code> (by default), <code>"Success"</code>, <code>"Warning"</code>, <code>"Information"</code> and <code>"Erorr"</code>.
 		 * @type {ValueState}
-         * @defaultvalue "None"
+		 * @defaultvalue "None"
 		 * @public
-		 * @since 0.13.0
+		 * @since 1.0.0-rc.15
 		 */
-		infoState: {
+		additionalTextState: {
 			type: ValueState,
 			defaultValue: ValueState.None,
 		},
 
+		/**
+		 * Defines the text alternative of the component.
+		 * Note: If not provided a default text alternative will be set, if present.
+		 *
+		 * @type {string}
+		 * @defaultvalue ""
+		 * @public
+		 * @since 1.0.0-rc.15
+		 */
+		accessibleName: {
+			type: String,
+		},
+
 		/**
 		 * Indicates if the list item has text content.
 		 * @type {boolean}
@@ -95,9 +109,9 @@ const metadata = {
 	},
 	slots: /** @lends sap.ui.webcomponents.main.StandardListItem.prototype */ {
 		/**
-		 * Defines the text of the <code>ui5-li</code>.
+		 * Defines the text of the component.
 		 * <br><br>
-		 * <b>Note:</b> Аlthough this slot accepts HTML Elements, it is strongly recommended that you only use text in order to preserve the intended design.
+		 * <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
@@ -117,11 +131,24 @@ const metadata = {
  * providing the most common use cases such as <code>text</code>,
  * <code>image</code> and <code>icon</code>.
  *
+ * <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-li</code> exposes the following CSS Shadow Parts:
+ * <ul>
+ * <li>title - Used to style the title of the list item</li>
+ * <li>description - Used to style the description of the list item</li>
+ * <li>additional-text - Used to style the additionalText of the list item</li>
+ * <li>icon - Used to style the icon of the list item</li>
+ * </ul>
+ *
  * @constructor
  * @author SAP SE
  * @alias sap.ui.webcomponents.main.StandardListItem
  * @extends ListItem
  * @tagname ui5-li
+ * @implements sap.ui.webcomponents.main.IListItem
  * @public
  */
 class StandardListItem extends ListItem {
@@ -150,8 +177,12 @@ class StandardListItem extends ListItem {
 		return (this.icon && this.iconEnd);
 	}
 
-	static async onDefine() {
-		await Icon.define();
+	static get dependencies() {
+		return [
+			...ListItem.dependencies,
+			Icon,
+			Avatar,
+		];
 	}
 }