@ui5/webcomponents 0.0.0-453158269 → 0.0.0-49cef2d02

package/src/Tree.js

@@ -1,8 +1,9 @@
 import UI5Element from "@ui5/webcomponents-base/dist/UI5Element.js";
 import litRender from "@ui5/webcomponents-base/dist/renderer/LitRenderer.js";
+import { getEffectiveAriaLabelText } from "@ui5/webcomponents-base/dist/util/AriaLabelHelper.js";
 import TreeItem from "./TreeItem.js";
-import List from "./List.js";
-import TreeListItem from "./TreeListItem.js";
+import TreeItemCustom from "./TreeItemCustom.js";
+import TreeList from "./TreeList.js";
 import ListMode from "./types/ListMode.js";
 
 // Template
@@ -16,7 +17,7 @@ import TreeCss from "./generated/themes/Tree.css.js";
  */
 const metadata = {
 	tag: "ui5-tree",
-	properties: /** @lends sap.ui.webcomponents.main.Tree.prototype */ {
+	properties: /** @lends sap.ui.webc.main.Tree.prototype */ {
 		/**
 		 * Defines the mode of the component. Since the tree uses a <code>ui5-list</code> to display its structure,
 		 * the tree modes are exactly the same as the list modes, and are all applicable.
@@ -34,7 +35,7 @@ const metadata = {
 		 * </ul>
 		 *
 		 * @public
-		 * @type {ListMode}
+		 * @type {sap.ui.webc.main.types.ListMode}
 		 * @defaultValue "None"
 		 */
 		mode: {
@@ -77,6 +78,45 @@ const metadata = {
 			type: String,
 		},
 
+		/**
+		 * Defines the accessible name of the component.
+		 *
+		 * @type {string}
+		 * @defaultvalue: ""
+		 * @public
+		 * @since 1.8.0
+		 */
+		 accessibleName: {
+			type: String,
+		},
+
+		/**
+		 * Defines the IDs of the elements that label the component.
+		 *
+		 * @type {string}
+		 * @defaultvalue ""
+		 * @public
+		 * @since 1.8.0
+		 */
+		accessibleNameRef: {
+			type: String,
+			defaultValue: "",
+		},
+
+		/**
+		 * Defines the description for the accessible role of the component.
+		 * @protected
+		 * @type {string}
+		 * @defaultvalue undefined
+		 * @since 1.10.0
+		 */
+
+		 accessibleRoleDescription: {
+			type: String,
+			defaultValue: undefined,
+			noAttribute: true,
+		},
+
 		/**
 		 * An array, containing a flat structure of list items to render
 		 *
@@ -108,14 +148,14 @@ const metadata = {
 		},
 	},
 	managedSlots: true,
-	slots: /** @lends sap.ui.webcomponents.main.Tree.prototype */ {
+	slots: /** @lends sap.ui.webc.main.Tree.prototype */ {
 
 		/**
 		 * Defines the items of the component. Tree items may have other tree items as children.
 		 * <br><br>
 		 * <b>Note:</b> Use <code>ui5-tree-item</code> for the intended design.
 		 *
-		 * @type {sap.ui.webcomponents.main.ITreeItem[]}
+		 * @type {sap.ui.webc.main.ITreeItem[]}
 		 * @slot items
 		 * @public
 		 */
@@ -139,7 +179,7 @@ const metadata = {
 			type: HTMLElement,
 		},
 	},
-	events: /** @lends sap.ui.webcomponents.main.Tree.prototype */ {
+	events: /** @lends sap.ui.webc.main.Tree.prototype */ {
 
 		/**
 		 * Fired when a tree item is expanded or collapsed.
@@ -147,7 +187,7 @@ const metadata = {
 		 * This may be handy for example if you want to dynamically load tree items upon the user expanding a node.
 		 * Even if you prevented the event's default behavior, you can always manually call <code>toggle()</code> on a tree item.
 		 *
-		 * @event sap.ui.webcomponents.main.Tree#item-toggle
+		 * @event sap.ui.webc.main.Tree#item-toggle
 		 * @param {HTMLElement} item the toggled item.
 		 * @allowPreventDefault
 		 * @public
@@ -160,7 +200,7 @@ const metadata = {
 
 		/**
 		 * Fired when the mouse cursor enters the tree item borders.
-		 * @event sap.ui.webcomponents.main.Tree#item-mouseover
+		 * @event sap.ui.webc.main.Tree#item-mouseover
 		 * @param {HTMLElement} item the hovered item.
 		 * @since 1.0.0-rc.16
 		 * @public
@@ -173,7 +213,7 @@ const metadata = {
 
 		/**
 		 * Fired when the mouse cursor leaves the tree item borders.
-		 * @event sap.ui.webcomponents.main.Tree#item-mouseout
+		 * @event sap.ui.webc.main.Tree#item-mouseout
 		 * @param {HTMLElement} item the hovered item.
 		 * @since 1.0.0-rc.16
 		 * @public
@@ -187,7 +227,7 @@ const metadata = {
 		/**
 		 * Fired when a tree item is activated.
 		 *
-		 * @event sap.ui.webcomponents.main.Tree#item-click
+		 * @event sap.ui.webc.main.Tree#item-click
 		 * @allowPreventDefault
 		 * @param {HTMLElement} item The clicked item.
 		 * @public
@@ -204,7 +244,7 @@ const metadata = {
 		 * <b>Note:</b> A Delete button is displayed on each item,
 		 * when the component <code>mode</code> property is set to <code>Delete</code>.
 		 *
-		 * @event sap.ui.webcomponents.main.Tree#item-delete
+		 * @event sap.ui.webc.main.Tree#item-delete
 		 * @param {HTMLElement} item the deleted item.
 		 * @public
 		 */
@@ -218,15 +258,17 @@ const metadata = {
 		 * Fired when selection is changed by user interaction
 		 * in <code>SingleSelect</code>, <code>SingleSelectBegin</code>, <code>SingleSelectEnd</code> and <code>MultiSelect</code> modes.
 		 *
-		 * @event sap.ui.webcomponents.main.Tree#selection-change
+		 * @event sap.ui.webc.main.Tree#selection-change
 		 * @param {Array} selectedItems An array of the selected items.
 		 * @param {Array} previouslySelectedItems An array of the previously selected items.
+		 * @param {HTMLElement} targetItem The item triggering the event.
 		 * @public
 		 */
 		"selection-change": {
 			detail: {
 				selectedItems: { type: Array },
 				previouslySelectedItems: { type: Array },
+				targetItem: { type: HTMLElement },
 			},
 		},
 	},
@@ -278,8 +320,8 @@ const metadata = {
  *
  * @constructor
  * @author SAP SE
- * @alias sap.ui.webcomponents.main.Tree
- * @extends UI5Element
+ * @alias sap.ui.webc.main.Tree
+ * @extends sap.ui.webc.base.UI5Element
  * @tagname ui5-tree
  * @appenddocs TreeItem
  * @public
@@ -304,15 +346,14 @@ class Tree extends UI5Element {
 
 	static get dependencies() {
 		return [
-			List,
-			TreeListItem,
+			TreeList,
 			TreeItem,
+			TreeItemCustom,
 		];
 	}
 
 	onBeforeRendering() {
-		this._listItems = [];
-		buildTree(this, 1, this._listItems);
+		this._prepareTreeItems();
 	}
 
 	get list() {
@@ -320,32 +361,33 @@ class Tree extends UI5Element {
 	}
 
 	get _role() {
-		return "tree";
+		return this._minimal ? "menubar" : "tree";
+	}
+
+	get _label() {
+		return getEffectiveAriaLabelText(this);
 	}
 
 	_onListItemStepIn(event) {
-		const listItem = event.detail.item;
-		const treeItem = listItem.treeItem;
+		const treeItem = event.detail.item;
 		if (treeItem.items.length > 0) {
 			const firstChild = treeItem.items[0];
-			const firstChildListItem = this.list.getSlottedNodes("items").find(li => li.treeItem === firstChild);
+			const firstChildListItem = this._getListItemForTreeItem(firstChild);
 			firstChildListItem && this.list.focusItem(firstChildListItem);
 		}
 	}
 
 	_onListItemStepOut(event) {
-		const listItem = event.detail.item;
-		const treeItem = listItem.treeItem;
+		const treeItem = event.detail.item;
 		if (treeItem.parentElement !== this) {
 			const parent = treeItem.parentElement;
-			const parentListItem = this.list.getSlottedNodes("items").find(li => li.treeItem === parent);
+			const parentListItem = this._getListItemForTreeItem(parent);
 			parentListItem && this.list.focusItem(parentListItem);
 		}
 	}
 
 	_onListItemToggle(event) {
-		const listItem = event.detail.item;
-		const treeItem = listItem.treeItem;
+		const treeItem = event.detail.item;
 		const defaultPrevented = !this.fireEvent("item-toggle", { item: treeItem }, true);
 		if (!defaultPrevented) {
 			treeItem.toggle();
@@ -353,8 +395,7 @@ class Tree extends UI5Element {
 	}
 
 	_onListItemClick(event) {
-		const listItem = event.detail.item;
-		const treeItem = listItem.treeItem;
+		const treeItem = event.detail.item;
 
 		if (!this.fireEvent("item-click", { item: treeItem }, true)) {
 			event.preventDefault();
@@ -362,26 +403,30 @@ class Tree extends UI5Element {
 	}
 
 	_onListItemDelete(event) {
-		const listItem = event.detail.item;
-		const treeItem = listItem.treeItem;
+		const treeItem = event.detail.item;
 		this.fireEvent("item-delete", { item: treeItem });
 	}
 
 	_onListItemMouseOver(event) {
-		const treeItem = event.target.treeItem;
+		const target = event.target;
 
-		this.fireEvent("item-mouseover", { item: treeItem });
+		if (target.isTreeItem) {
+			this.fireEvent("item-mouseover", { item: target });
+		}
 	}
 
 	_onListItemMouseOut(event) {
-		const treeItem = event.target.treeItem;
+		const target = event.target;
 
-		this.fireEvent("item-mouseout", { item: treeItem });
+		if (target.isTreeItem) {
+			this.fireEvent("item-mouseout", { item: target });
+		}
 	}
 
 	_onListSelectionChange(event) {
-		const previouslySelectedItems = event.detail.previouslySelectedItems.map(item => item.treeItem);
-		const selectedItems = event.detail.selectedItems.map(item => item.treeItem);
+		const previouslySelectedItems = event.detail.previouslySelectedItems;
+		const selectedItems = event.detail.selectedItems;
+		const targetItem = event.detail.targetItem;
 
 		previouslySelectedItems.forEach(item => {
 			item.selected = false;
@@ -393,6 +438,22 @@ class Tree extends UI5Element {
 		this.fireEvent("selection-change", {
 			previouslySelectedItems,
 			selectedItems,
+			targetItem,
+		});
+	}
+
+	_prepareTreeItems() {
+		// set level to tree items
+		this.walk((item, level, index) => {
+			const parent = item.parentNode;
+			const ariaSetSize = (parent && parent.children.length) || this.items.length;
+
+			item.setAttribute("level", level);
+
+			item._toggleButtonEnd = this._toggleButtonEnd;
+			item._minimal = this._minimal;
+			item._setsize = ariaSetSize;
+			item._posinset = index + 1;
 		});
 	}
 
@@ -403,14 +464,33 @@ class Tree extends UI5Element {
 	 * @protected
 	 */
 	_getListItemForTreeItem(item) {
-		return this.list.items.find(listItem => listItem.treeItem === item);
+		return this.getItems().find(listItem => listItem === item);
+	}
+
+	/**
+	 * Returns the a flat array of all tree items
+	 * @protected
+	 * @returns {Array}
+	 */
+	getItems() {
+		return this.list.getItems();
+	}
+
+	/**
+	 * Focus a tree item by its index in the flat array of all tree items
+	 * @protected
+	 * @param index
+	 */
+	focusItemByIndex(index) {
+		const item = this.getItems()[index];
+		item && this.list.focusItem(item);
 	}
 
 	/**
 	 * Perform Depth-First-Search walk on the tree and run a callback on each node
 	 *
 	 * @public
-	 * @param {function} callback function to execute on each node of the tree with 2 arguments: the node and the level
+	 * @param {function} callback function to execute on each node of the tree with 3 arguments: the node, the level and the index
 	 */
 	walk(callback) {
 		walkTree(this, 1, callback);
@@ -418,30 +498,14 @@ class Tree extends UI5Element {
 }
 
 const walkTree = (el, level, callback) => {
-	el.items.forEach(item => {
-		callback(item, level);
+	el.items.forEach((item, index) => {
+		callback(item, level, index);
 		if (item.items.length > 0) {
 			walkTree(item, level + 1, callback);
 		}
 	});
 };
 
-const buildTree = (el, level, result) => {
-	el.items.forEach((item, index) => {
-		const listItem = {
-			treeItem: item,
-			size: el.items.length,
-			posinset: index + 1,
-			level,
-		};
-
-		result.push(listItem);
-		if (item.expanded && item.items.length > 0) {
-			buildTree(item, level + 1, result);
-		}
-	});
-};
-
 Tree.define();
 
 export default Tree;

package/src/TreeItem.hbs

@@ -0,0 +1,13 @@
+{{>include "./TreeItemBase.hbs"}}
+
+{{#*inline "listItemContent"}}
+	<div class="ui5-li-tree-text-wrapper">
+		{{#if _showTitle}}
+			<div part="title" class="ui5-li-title">{{text}}</div>
+		{{/if}}
+
+		{{#if additionalText}}
+			<span part="additional-text" class="ui5-li-additional-text">{{additionalText}}</span>
+		{{/if}}
+	</div>
+{{/inline}}

package/src/TreeItem.js

@@ -1,12 +1,17 @@
-import UI5Element from "@ui5/webcomponents-base/dist/UI5Element.js";
 import ValueState from "@ui5/webcomponents-base/dist/types/ValueState.js";
+import TreeItemBase from "./TreeItemBase.js";
+// Template
+import TreeItemTemplate from "./generated/templates/TreeItemTemplate.lit.js";
+
+// Styles
+import treeItemCss from "./generated/themes/TreeItem.css.js";
 
 /**
  * @public
  */
 const metadata = {
 	tag: "ui5-tree-item",
-	properties: /** @lends sap.ui.webcomponents.main.TreeItem.prototype */ {
+	properties: /** @lends sap.ui.webc.main.TreeItem.prototype */ {
 
 		/**
 		 * Defines the text of the tree item.
@@ -19,76 +24,6 @@ const metadata = {
 			type: String,
 		},
 
-		/**
-		 * Defines whether the tree node is expanded or collapsed. Only has visual effect for tree nodes with children.
-		 *
-		 * @type {boolean}
-		 * @defaultvalue false
-		 * @public
-		 */
-		expanded: {
-			type: Boolean,
-		},
-		/**
-		* Defines whether the selection of a tree node is displayed as partially selected.
-		* <br><br>
-		* <b>Note:</b> The indeterminate state can be set only programatically and can’t be achieved by user
-		* interaction, meaning that the resulting visual state depends on the values of the <code>indeterminate</code>
-		* and <code>selected</code> properties:
-		* <ul>
-		* <li> If a tree node has both <code>selected</code> and <code>indeterminate</code> set to <code>true</code>, it is displayed as partially selected.
-		* <li> If a tree node has <code>selected</code> set to <code>true</code> and <code>indeterminate</code> set to <code>false</code>, it is displayed as selected.
-		* <li> If a tree node has <code>selected</code> set to <code>false</code>, it is displayed as not selected regardless of the value of the <code>indeterminate</code> property.
-		* </ul>
-		* <br>
-		* <b>Note:</b> This property takes effect only when the <code>ui5-tree</code> is in <code>MultiSelect</code> mode.
-		* @type {boolean}
-		* @defaultvalue false
-		* @public
-		* @since 1.1.0
-		*/
-		indeterminate: {
-			type: Boolean,
-		},
-
-		/**
-		 * Defines whether the tree node has children, even if currently no other tree nodes are slotted inside.
-		 * <br>
-		 * <i>Note:</i> This property is useful for showing big tree structures where not all nodes are initially loaded due to performance reasons.
-		 * Set this to <code>true</code> for nodes you intend to load lazily, when the user clicks the expand button.
-		 * It is not necessary to set this property otherwise. If a tree item has children, the expand button will be displayed anyway.
-		 *
-		 * @type {boolean}
-		 * @defaultvalue false
-		 * @public
-		 */
-		hasChildren: {
-			type: Boolean,
-		},
-
-		/**
-		 * Defines whether the tree node is selected by the user. Only has effect if the <code>ui5-tree</code> is in one of the
-		 * following modes: in <code>SingleSelect</code>, <code>SingleSelectBegin</code>, <code>SingleSelectEnd</code> and <code>MultiSelect</code>.
-		 *
-		 * @type {boolean}
-		 * @defaultvalue false
-		 * @public
-		 */
-		selected: {
-			type: Boolean,
-		},
-
-		/**
-		 * If set, an icon will be displayed before the text, representing the tree item.
-		 *
-		 * @public
-		 * @type {string}
-		 * @defaultValue ""
-		 */
-		icon: {
-			type: String,
-		},
-
 		/**
 		 * Defines the <code>additionalText</code>, displayed in the end of the tree item.
 		 * @type {string}
@@ -102,8 +37,8 @@ const metadata = {
 		/**
 		 * Defines the state of the <code>additionalText</code>.
 		 * <br>
-		 * Available options are: <code>"None"</code> (by default), <code>"Success"</code>, <code>"Warning"</code>, <code>"Information"</code> and <code>"Erorr"</code>.
-		 * @type {ValueState}
+		 * Available options are: <code>"None"</code> (by default), <code>"Success"</code>, <code>"Warning"</code>, <code>"Information"</code> and <code>"Error"</code>.
+		 * @type {sap.ui.webc.base.types.ValueState}
 		 * @defaultvalue "None"
 		 * @public
 		 * @since 1.0.0-rc.15
@@ -112,75 +47,55 @@ const metadata = {
 			type: ValueState,
 			defaultValue: ValueState.None,
 		},
-
-		/**
-		 * Defines the tooltip of the component.
-		 * @type {string}
-		 * @defaultvalue ""
-		 * @private
-		 * @since 1.0.0-rc.15
-		 */
-		title: {
-			type: String,
-		},
-	},
-	managedSlots: true,
-	slots: /** @lends sap.ui.webcomponents.main.TreeItem.prototype */ {
-
-		/**
-		 * Defines the items of this component.
-		 *
-		 * @type {sap.ui.webcomponents.main.ITreeItem[]}
-		 * @slot items
-		 * @public
-		 */
-		"default": {
-			propertyName: "items",
-			type: HTMLElement,
-			invalidateOnChildChange: true,
-		},
 	},
 };
 
 /**
  * @class
- *
  * <h3 class="comment-api-title">Overview</h3>
+ * The <code>ui5-tree-item</code> represents a node in a tree structure, shown as a <code>ui5-list</code>.
+ * <br>
  * This is the item to use inside a <code>ui5-tree</code>.
  * You can represent an arbitrary tree structure by recursively nesting tree items.
  *
- * <h3>Usage</h3>
- * <code>ui5-tree-item</code> is an abstract element, representing a node in a <code>ui5-tree</code>. The tree itself is rendered as a list,
- * and each <code>ui5-tree-item</code> is represented by a list item(<code>ui5-li-tree</code>) in that list. Therefore, you should only use
- * <code>ui5-tree-item</code> directly in your apps. The <code>ui5-li-tree</code> list item is internal for the list, and not intended for public use.
+ * <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-tree-item</code> exposes the following CSS Shadow Parts:
+ * <ul>
+ * <li>title - Used to style the title of the tree list item</li>
+ * <li>additionalText - Used to style the additionalText of the tree list item</li>
+ * <li>icon - Used to style the icon of the tree list item</li>
+ * </ul>
  *
  * <h3>ES6 Module Import</h3>
  * <code>import "@ui5/webcomponents/dist/TreeItem.js";</code>
  *
  * @constructor
  * @author SAP SE
- * @alias sap.ui.webcomponents.main.TreeItem
- * @extends UI5Element
+ * @alias sap.ui.webc.main.TreeItem
+ * @extends sap.ui.webc.main.TreeItemBase
  * @tagname ui5-tree-item
  * @public
- * @implements sap.ui.webcomponents.main.ITreeItem
+ * @implements sap.ui.webc.main.ITreeItem
  * @since 1.0.0-rc.8
  */
-class TreeItem extends UI5Element {
-	static get metadata() {
-		return metadata;
+class TreeItem extends TreeItemBase {
+	static get template() {
+		return TreeItemTemplate;
+	}
+
+	static get styles() {
+		return [...super.styles, treeItemCss];
 	}
 
-	get requiresToggleButton() {
-		return this.hasChildren || this.items.length > 0;
+	static get metadata() {
+		return metadata;
 	}
 
-	/**
-	 * Call this method to manually switch the <code>expanded</code> state of a tree item.
-	 * @public
-	 */
-	toggle() {
-		this.expanded = !this.expanded;
+	get _showTitle() {
+		return this.text.length && !this._minimal;
 	}
 }
 

package/src/{TreeListItem.hbs → TreeItemBase.hbs}

@@ -1,4 +1,8 @@
-{{>include "./ListItem.hbs"}}
+<div>
+	{{>include "./ListItem.hbs"}}
+
+	{{> listItemPostContent}}
+</div>
 
 {{#*inline "listItemPreContent"}}
 	<div
@@ -19,15 +23,6 @@
 {{/inline}}
 
 {{#*inline "listItemContent"}}
-	<div class="ui5-li-tree-text-wrapper">
-		{{#if _showTitle}}
-			<div part="title" class="ui5-li-title"><slot></slot></div>
-		{{/if}}
-
-		{{#if additionalText}}
-			<span part="additional-text" class="ui5-li-additional-text">{{additionalText}}</span>
-		{{/if}}
-	</div>
 {{/inline}}
 
 {{#*inline "imageBegin"}}{{/inline}}
@@ -48,3 +43,15 @@
 		></ui5-icon>
 	{{/if}}
 {{/inline}}
+
+{{#*inline "listItemPostContent"}}
+	{{#if expanded}}
+		<ul
+			role="group"
+			id="{{_id}}-subtree"
+			class="ui5-tree-li-subtree"
+		>
+			<slot></slot>
+		</ul>
+	{{/if}}
+{{/inline}}