@ui5/webcomponents 1.0.0-rc.6 → 1.0.0

package/dist/SuggestionGroupItem.js

@@ -0,0 +1,64 @@
+import UI5Element from "@ui5/webcomponents-base/dist/UI5Element.js";
+import GroupHeaderListItem from "./GroupHeaderListItem.js";
+
+/**
+ * @public
+ */
+const metadata = {
+	tag: "ui5-suggestion-group-item",
+	properties: /** @lends  sap.ui.webcomponents.main.SuggestionGroupItem.prototype */ {
+		/**
+		 * Defines the text of the <code>ui5-suggestion-group-item</code>.
+		 *
+		 * @type {string}
+		 * @defaultvalue ""
+		 * @public
+		 */
+		text: {
+			type: String,
+		},
+	},
+	slots: /** @lends  sap.ui.webcomponents.main.SuggestionGroupItem.prototype */ {
+	},
+	events: /** @lends  sap.ui.webcomponents.main.SuggestionGroupItem.prototype */ {
+	},
+};
+
+/**
+ * @class
+ * The <code>ui5-suggestion-group-item</code> is type of suggestion item,
+ * that can be used to split the <code>ui5-input</code> suggestions into groups.
+ *
+ * @constructor
+ * @author SAP SE
+ * @alias sap.ui.webcomponents.main.SuggestionGroupItem
+ * @extends UI5Element
+ * @tagname ui5-suggestion-group-item
+ * @implements sap.ui.webcomponents.main.IInputSuggestionItem
+ * @public
+ * @since 1.0.0-rc.15
+ */
+class SuggestionItem extends UI5Element {
+	static get metadata() {
+		return metadata;
+	}
+
+	static get dependencies() {
+		return [
+			GroupHeaderListItem,
+		];
+	}
+
+	/**
+	 * Indicates the "grouping" nature of the component
+	 * to avoid tag name checks tag name to diferenciate from the standard suggestion item.
+	 * @protected
+	 */
+	get groupItem() {
+		return true;
+	}
+}
+
+SuggestionItem.define();
+
+export default SuggestionItem;

package/dist/SuggestionItem.js

@@ -1,8 +1,8 @@
 import UI5Element from "@ui5/webcomponents-base/dist/UI5Element.js";
 
 import ValueState from "@ui5/webcomponents-base/dist/types/ValueState.js";
-import StandardListItem from "./StandardListItem.js";
-import GroupHeaderListItem from "./GroupHeaderListItem.js";
+import SuggestionListItem from "./SuggestionListItem.js";
+import ListItemType from "./types/ListItemType.js";
 
 /**
  * @public
@@ -11,7 +11,7 @@ const metadata = {
 	tag: "ui5-suggestion-item",
 	properties: /** @lends  sap.ui.webcomponents.main.SuggestionItem.prototype */ {
 		/**
-		 * Defines the text of the <code>ui5-suggestion-item</code>.
+		 * Defines the text of the component.
 		 *
 		 * @type {string}
 		 * @defaultvalue ""
@@ -21,6 +21,23 @@ const metadata = {
 			type: String,
 		},
 
+		/**
+		 * Defines the visual indication and behavior of the item.
+		 * Available options are <code>Active</code> (by default), <code>Inactive</code> and <code>Detail</code>.
+		 * <br><br>
+		 * <b>Note:</b> When set to <code>Active</code>, the item will provide visual response upon press and hover,
+		 * while when <code>Inactive</code> or <code>Detail</code> - will not.
+		 *
+		 * @type {ListItemType}
+		 * @defaultvalue "Active"
+		 * @public
+		 * @since 1.0.0-rc.8
+		*/
+		type: {
+			type: ListItemType,
+			defaultValue: ListItemType.Active,
+		},
+
 		/**
 		 * Defines the description displayed right under the item text, if such is present.
 		 * @type {string}
@@ -35,7 +52,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}
@@ -71,42 +88,32 @@ const metadata = {
 		},
 
 		/**
-		 * Defines the <code>info</code>, displayed in the end of the item.
+		 * Defines the <code>additionalText</code>, displayed in the end of the item.
 		 * @type {string}
+		 * @since 1.0.0-rc.15
 		 * @public
 		 */
-		info: {
+		additionalText: {
 			type: String,
 		},
 
 		/**
-		 * Defines the state of the <code>info</code>.
+		 * Defines the state of the <code>additionalText</code>.
 		 * <br><br>
-		 * Available options are: <code>"None"</code> (by default), <code>"Success"</code>, <code>"Warning"</code> and <code>"Erorr"</code>.
-		 * @type {string}
+		 * Available options are: <code>"None"</code> (by default), <code>"Success"</code>, <code>"Information"</code>, <code>"Warning"</code> and <code>"Erorr"</code>.
+		 * @type {ValueState}
+		 * @defaultvalue "None"
+		 * @since 1.0.0-rc.15
 		 * @public
 		 */
-		infoState: {
+		additionalTextState: {
 			type: ValueState,
 			defaultValue: ValueState.None,
 		},
-
-		/**
-		 * Defines the item to be displayed as a group item.
-		 * <br><br>
-		 * <b>Note:</b>
-		 * When set, the other properties, such as <code>image</code>, <code>icon</code>, <code>description</code>, etc. will be omitted
-		 * and only the <code>text</code> will be displayed.
-		 * @type {string}
-		 * @public
-		 */
-		group: {
-			type: Boolean,
-		},
 	},
-	slots: {
+	slots: /** @lends  sap.ui.webcomponents.main.SuggestionItem.prototype */ {
 	},
-	events: {
+	events: /** @lends  sap.ui.webcomponents.main.SuggestionItem.prototype */ {
 	},
 };
 
@@ -118,6 +125,8 @@ const metadata = {
  * @author SAP SE
  * @alias sap.ui.webcomponents.main.SuggestionItem
  * @extends UI5Element
+ * @tagname ui5-suggestion-item
+ * @implements sap.ui.webcomponents.main.IInputSuggestionItem
  * @public
  */
 class SuggestionItem extends UI5Element {
@@ -125,11 +134,10 @@ class SuggestionItem extends UI5Element {
 		return metadata;
 	}
 
-	static async onDefine() {
-		await Promise.all([
-			StandardListItem.define(),
-			GroupHeaderListItem.define(),
-		]);
+	static get dependencies() {
+		return [
+			SuggestionListItem,
+		];
 	}
 }
 

package/dist/SuggestionListItem.js

@@ -0,0 +1,76 @@
+import StandardListItem from "./StandardListItem.js";
+import SuggestionListItemTemplate from "./generated/templates/SuggestionListItemTemplate.lit.js";
+
+/**
+ * @public
+ */
+const metadata = {
+	tag: "ui5-li-suggestion-item",
+	managedSlots: true,
+	slots: /** @lends sap.ui.webcomponents.main.SuggestionListItem.prototype */ {
+		/**
+		 * Defines a description that can contain HTML.
+		 * <b>Note:</b> If not specified, the <code>description</code> property will be used.
+		 * <br>
+		 * @type {HTMLElement}
+		 * @since 1.0.0-rc.8
+		 * @slot
+		 * @public
+		 */
+		richDescription: {
+			type: HTMLElement,
+		},
+		"default": {
+			propertyName: "titleText",
+		},
+	},
+};
+
+/**
+ * @class
+ * The <code>ui5-li-suggestion-item</code> represents the suggestion item in the <code>ui5-input</code>
+ * suggestion popover.
+ *
+ * <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-suggestion-item</code> exposes the following CSS Shadow Parts:
+ * <ul>
+ * <li>title - Used to style the title of the suggestion list item</li>
+ * <li>description - Used to style the description of the suggestion list item</li>
+ * <li>info - Used to style the info of the suggestion list item</li>
+ * </ul>
+ *
+ * @constructor
+ * @author SAP SE
+ * @alias sap.ui.webcomponents.main.SuggestionListItem
+ * @extends StandardListItem
+ * @tagname ui5-li-suggestion-item
+ */
+class SuggestionListItem extends StandardListItem {
+	static get metadata() {
+		return metadata;
+	}
+
+	static get template() {
+		return SuggestionListItemTemplate;
+	}
+
+	onBeforeRendering(...params) {
+		super.onBeforeRendering(...params);
+		this.hasTitle = !!this.titleText.length;
+	}
+
+	get effectiveTitle() {
+		return this.titleText.filter(node => node.nodeType !== Node.COMMENT_NODE).map(el => el.textContent).join("");
+	}
+
+	get hasDescription() {
+		return this.richDescription.length || this.description;
+	}
+}
+
+SuggestionListItem.define();
+
+export default SuggestionListItem;

package/dist/Switch.js

@@ -2,11 +2,12 @@ import UI5Element from "@ui5/webcomponents-base/dist/UI5Element.js";
 import litRender from "@ui5/webcomponents-base/dist/renderer/LitRenderer.js";
 import { isSpace, isEnter } from "@ui5/webcomponents-base/dist/Keys.js";
 import { isDesktop } from "@ui5/webcomponents-base/dist/Device.js";
-import { getRTL } from "@ui5/webcomponents-base/dist/config/RTL.js";
-import { fetchI18nBundle, getI18nBundle } from "@ui5/webcomponents-base/dist/i18nBundle.js";
-import "@ui5/webcomponents-icons/dist/icons/accept.js";
-import "@ui5/webcomponents-icons/dist/icons/decline.js";
+import { getI18nBundle } from "@ui5/webcomponents-base/dist/i18nBundle.js";
+import "@ui5/webcomponents-icons/dist/accept.js";
+import "@ui5/webcomponents-icons/dist/decline.js";
+import "@ui5/webcomponents-icons/dist/less.js";
 import Icon from "./Icon.js";
+import SwitchDesign from "./types/SwitchDesign.js";
 
 import {
 	SWITCH_ON,
@@ -16,7 +17,6 @@ import {
 // Template
 import SwitchTemplate from "./generated/templates/SwitchTemplate.lit.js";
 
-
 // Styles
 import switchCss from "./generated/themes/Switch.css.js";
 
@@ -25,15 +25,29 @@ import switchCss from "./generated/themes/Switch.css.js";
  */
 const metadata = {
 	tag: "ui5-switch",
+	languageAware: true,
 	properties: /** @lends sap.ui.webcomponents.main.Switch.prototype */ {
 
 		/**
-		 * Defines if the <code>ui5-switch</code> is checked.
+		 * Defines the component design.
 		 * <br><br>
-		 * <b>Note:</b> The property can be changed with user interaction,
-		 * either by cliking/tapping on the <code>ui5-switch</code>, or by
-		 * pressing the <code>Enter</code> or <code>Space</code> key.
+		 * <b>Note:</b> If <code>Graphical</code> type is set,
+		 * positive and negative icons will replace the <code>textOn</code> and <code>textOff</code>.
 		 *
+		 * @public
+		 * @type {SwitchDesign}
+		 * @defaultValue "Textual"
+		 */
+		design: {
+			type: SwitchDesign,
+			defaultValue: SwitchDesign.Textual,
+		},
+
+		/**
+		 * Defines if the component is checked.
+		 * <br><br>
+		 * <b>Note:</b> The property can be changed with user interaction,
+		 * either by cliking the component, or by pressing the <code>Enter</code> or <code>Space</code> key.
 		 * @type {boolean}
 		 * @defaultvalue false
 		 * @public
@@ -43,9 +57,9 @@ const metadata = {
 		},
 
 		/**
-		 * Defines whether the <code>ui5-switch</code> is disabled.
+		 * Defines whether the component is disabled.
 		 * <br><br>
-		 * <b>Note:</b> A disabled <code>ui5-switch</code> is noninteractive.
+		 * <b>Note:</b> A disabled component is noninteractive.
 		 *
 		 * @type {boolean}
 		 * @defaultvalue false
@@ -56,10 +70,11 @@ const metadata = {
 		},
 
 		/**
-		 * Defines the text of the <code>ui5-switch</code> when switched on.
+		 * Defines the text, displayed when the component is checked.
 		 *
 		 * <br><br>
 		 * <b>Note:</b> We recommend using short texts, up to 3 letters (larger texts would be cut off).
+		 * <b>Note:</b> This property will have no effect if the theme is set to <code>sap_horizon</code>.
 		 * @type {string}
 		 * @defaultvalue ""
 		 * @public
@@ -69,9 +84,10 @@ const metadata = {
 		},
 
 		/**
-		 * Defines the text of the <code>ui5-switch</code> when switched off.
+		 * Defines the text, displayed when the component is not checked.
 		 * <br><br>
 		 * <b>Note:</b> We recommend using short texts, up to 3 letters (larger texts would be cut off).
+		 * <b>Note:</b> This property will have no effect if the theme is set to <code>sap_horizon</code>.
 		 * @type {string}
 		 * @defaultvalue ""
 		 * @public
@@ -79,24 +95,11 @@ const metadata = {
 		textOff: {
 			type: String,
 		},
-
-		/**
-		 * Defines the <code>ui5-switch</code> type.
-		 * <br><br>
-		 * <b>Note:</b> If <code>graphical</code> type is set,
-		 * positive and negative icons will replace the <code>textOn</code> and <code>textOff</code>.
-		 * @type {string}
-		 * @defaultvalue false
-		 * @public
-		 */
-		graphical: {
-			type: Boolean,
-		},
 	},
 	events: /** @lends sap.ui.webcomponents.main.Switch.prototype */ {
 
 		/**
-		 * Fired when the <code>ui5-switch</code> checked state changes.
+		 * Fired when the component checked state changes.
 		 *
 		 * @public
 		 * @event
@@ -114,13 +117,25 @@ const metadata = {
  * The component can display texts, that will be switched, based on the component state, via the <code>textOn</code> and <code>textOff</code> properties,
  * but texts longer than 3 letters will be cutted off.
  * <br>
- * However, users are able to customize the width of <code>ui5-switch</code> with pure CSS (&lt;ui5-switch style="width: 200px">), and set widths, depending on the texts they would use.
+ * However, users are able to customize the width of <code>ui5-switch</code> with pure CSS (<code>&lt;ui5-switch style="width: 200px"></code>), and set widths, depending on the texts they would use.
  * <br>
  * Note: the component would not automatically stretch to fit the whole text width.
  *
  * <h3>Keyboard Handling</h3>
  * The state can be changed by pressing the Space and Enter keys.
  *
+ * <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-switch</code> exposes the following CSS Shadow Parts:
+ * <ul>
+ * <li>slider - Used to style the track, where the handle is being slid</li>
+ * <li>text-on - Used to style the <code>textOn</code> property text</li>
+ * <li>text-off - Used to style the <code>textOff</code> property text</li>
+ * <li>handle - Used to style the handle of the switch</li>
+ * </ul>
+ *
  * <h3>ES6 Module Import</h3>
  *
  * <code>import "@ui5/webcomponents/dist/Switch";</code>
@@ -150,10 +165,8 @@ class Switch extends UI5Element {
 		return SwitchTemplate;
 	}
 
-	constructor() {
-		super();
-
-		this.i18nBundle = getI18nBundle("@ui5/webcomponents");
+	get sapNextIcon() {
+		return this.checked ? "accept" : "less";
 	}
 
 	_onclick(event) {
@@ -185,6 +198,14 @@ class Switch extends UI5Element {
 		}
 	}
 
+	get graphical() {
+		return this.design === SwitchDesign.Graphical;
+	}
+
+	get hasNoLabel() {
+		return !(this.graphical || this.textOn || this.textOff);
+	}
+
 	get _textOn() {
 		return this.graphical ? "" : this.textOn;
 	}
@@ -215,27 +236,24 @@ class Switch extends UI5Element {
 		return this.disabled ? "true" : undefined;
 	}
 
-	get rtl() {
-		return getRTL() ? "rtl" : undefined;
-	}
-
 	get accessibilityOnText() {
-		return this._textOn || this.i18nBundle.getText(SWITCH_ON);
+		return this._textOn || Switch.i18nBundle.getText(SWITCH_ON);
 	}
 
 	get accessibilityOffText() {
-		return this._textOff || this.i18nBundle.getText(SWITCH_OFF);
+		return this._textOff || Switch.i18nBundle.getText(SWITCH_OFF);
 	}
 
 	get hiddenText() {
 		return this.checked ? this.accessibilityOnText : this.accessibilityOffText;
 	}
 
+	static get dependencies() {
+		return [Icon];
+	}
+
 	static async onDefine() {
-		await Promise.all([
-			Icon.define(),
-			fetchI18nBundle("@ui5/webcomponents"),
-		]);
+		Switch.i18nBundle = await getI18nBundle("@ui5/webcomponents");
 	}
 }