@ui5/webcomponents 0.0.0-934b4df24 → 0.0.0-a3eca7ade

package/dist/Tree.js

@@ -18,11 +18,20 @@ const metadata = {
 	tag: "ui5-tree",
 	properties: /** @lends sap.ui.webcomponents.main.Tree.prototype */ {
 		/**
-		 * Defines the mode of the <code>ui5-tree</code>. Since the tree uses a <code>ui5-list</code> to display its structure,
+		 * 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.
+		 *
 		 * <br><br>
-		 * <b>Note:</b> Available options are <code>None</code>, <code>SingleSelect</code>, <code>SingleSelectBegin</code>,
-		 * <code>SingleSelectEnd</code>, <code>MultiSelect</code>, and <code>Delete</code>.
+		 * <b>Note:</b>
+		 *
+		 * <ul>
+		 * <li><code>None</code></li>
+		 * <li><code>SingleSelect</code></li>
+		 * <li><code>SingleSelectBegin</code></li>
+		 * <li><code>SingleSelectEnd</code></li>
+		 * <li><code>MultiSelect</code></li>
+		 * <li><code>Delete</code></li>
+		 * </ul>
 		 *
 		 * @public
 		 * @type {ListMode}
@@ -34,7 +43,7 @@ const metadata = {
 		},
 
 		/**
-		 * Defines the text that is displayed when the <code>ui5-tree</code> contains no items.
+		 * Defines the text that is displayed when the component contains no items.
 		 *
 		 * @type {string}
 		 * @defaultvalue ""
@@ -45,7 +54,7 @@ const metadata = {
 		},
 
 		/**
-		 * Defines the <code>ui5-tree</code> header text.
+		 * Defines the component header text.
 		 * <br><br>
 		 * <b>Note:</b> If the <code>header</code> slot is set, this property is ignored.
 		 *
@@ -58,7 +67,7 @@ const metadata = {
 		},
 
 		/**
-		 * Defines the <code>ui5-tree</code> footer text.
+		 * Defines the component footer text.
 		 *
 		 * @type {string}
 		 * @defaultvalue ""
@@ -77,26 +86,47 @@ const metadata = {
 			type: Object,
 			multiple: true,
 		},
+
+		/**
+		 * Shows the toggle button at the end, rather than at the beginning of the items
+		 *
+		 * @protected
+		 * @since 1.0.0-rc.8
+		 */
+		_toggleButtonEnd: {
+			type: Boolean,
+		},
+
+		/**
+		 * Represents the tree in a very minimal state - icons only with no text and no toggle buttons
+		 *
+		 * @protected
+		 * @since 1.0.0-rc.8
+		 */
+		_minimal: {
+			type: Boolean,
+		},
 	},
 	managedSlots: true,
 	slots: /** @lends sap.ui.webcomponents.main.Tree.prototype */ {
 
 		/**
-		 * Defines the items of the <code>ui5-tree</code>. Tree items may have other tree items as children.
+		 * 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 {HTMLElement[]}
-		 * @slot
+		 * @type {sap.ui.webcomponents.main.ITreeItem[]}
+		 * @slot items
 		 * @public
 		 */
 		"default": {
 			type: HTMLElement,
 			propertyName: "items",
+			invalidateOnChildChange: true,
 		},
 
 		/**
-		 * Defines the <code>ui5-tree</code> header.
+		 * Defines the component header.
 		 * <br><br>
 		 * <b>Note:</b> When the <code>header</code> slot is set, the
 		 * <code>headerText</code> property is ignored.
@@ -117,11 +147,38 @@ 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
+		 * @event sap.ui.webcomponents.main.Tree#item-toggle
 		 * @param {HTMLElement} item the toggled item.
+		 * @allowPreventDefault
+		 * @public
+		 */
+		"item-toggle": {
+			detail: {
+				item: { type: HTMLElement },
+			},
+		},
+
+		/**
+		 * Fired when the mouse cursor enters the tree item borders.
+		 * @event sap.ui.webcomponents.main.Tree#item-mouseover
+		 * @param {HTMLElement} item the hovered item.
+		 * @since 1.0.0-rc.16
+		 * @public
+		 */
+		"item-mouseover": {
+			detail: {
+				item: { type: HTMLElement },
+			},
+		},
+
+		/**
+		 * Fired when the mouse cursor leaves the tree item borders.
+		 * @event sap.ui.webcomponents.main.Tree#item-mouseout
+		 * @param {HTMLElement} item the hovered item.
+		 * @since 1.0.0-rc.16
 		 * @public
 		 */
-		itemToggle: {
+		"item-mouseout": {
 			detail: {
 				item: { type: HTMLElement },
 			},
@@ -130,11 +187,12 @@ const metadata = {
 		/**
 		 * Fired when a tree item is activated.
 		 *
-		 * @event
-		 * @param {HTMLElement} item the clicked item.
+		 * @event sap.ui.webcomponents.main.Tree#item-click
+		 * @allowPreventDefault
+		 * @param {HTMLElement} item The clicked item.
 		 * @public
 		 */
-		itemClick: {
+		"item-click": {
 			detail: {
 				item: { type: HTMLElement },
 			},
@@ -144,12 +202,13 @@ const metadata = {
 		 * Fired when the Delete button of any tree item is pressed.
 		 * <br><br>
 		 * <b>Note:</b> A Delete button is displayed on each item,
-		 * when the <code>ui5-tree</code> <code>mode</code> property is set to <code>Delete</code>.
-		 * @event
+		 * when the component <code>mode</code> property is set to <code>Delete</code>.
+		 *
+		 * @event sap.ui.webcomponents.main.Tree#item-delete
 		 * @param {HTMLElement} item the deleted item.
 		 * @public
 		 */
-		itemDelete: {
+		"item-delete": {
 			detail: {
 				item: { type: HTMLElement },
 			},
@@ -159,12 +218,12 @@ 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
+		 * @event sap.ui.webcomponents.main.Tree#selection-change
 		 * @param {Array} selectedItems An array of the selected items.
 		 * @param {Array} previouslySelectedItems An array of the previously selected items.
 		 * @public
 		 */
-		selectionChange: {
+		"selection-change": {
 			detail: {
 				selectedItems: { type: Array },
 				previouslySelectedItems: { type: Array },
@@ -179,17 +238,43 @@ const metadata = {
  * <h3 class="comment-api-title">Overview</h3>
  * The <code>ui5-tree</code> component provides a tree structure for displaying data in a hierarchy.
  *
+ * <h3>Usage</h3>
+ *
+ * <h4>When to use:</h4>
+ * <ul>
+ * <li>To display hierarchically structured items.</li>
+ * <li>To select one or more items out of a set of hierarchically structured items.</li>
+ * </ul>
+ *
+ * <h4>When not to use:</h4>
+ * <ul>
+ * <li>To display items not hierarchically strcutured. In this case, use the List component.</li>
+ * <li>To select one item from a very small number of non-hierarchical items. Select or ComboBox might be more appropriate.</li>
+ * <li>The hierarchy turns out to have only two levels. In this case, use List with group items.</li>
+ * </ul>
+ *
  * <h3>Keyboard Handling</h3>
- * <code>ui5-tree</code> provides advanced keyboard handling. You can use the up/down arrow keys to navigate to the previous/next item in the list,
- * representing the tree, regardless of nesting, but also the left/right arrow keys to drill down and go up the tree. If you press the right arrow
- * on a tree node, it will expand, if not expanded. If you press the right arrow key once more, the first child of this node will be selected.
- * If you press the left arrow on a tree node, it will collapse, if expanded. If you press the left arrow key once more, the parent node of this
- * tree node will be selected.
+ *
+ * The <code>ui5-tree</code> provides advanced keyboard handling.
+ * The user can use the following keyboard shortcuts in order to navigate trough the tree:
+ * <ul>
+ * <li>[UP/DOWN] - Navigates up and down the tree items that are currently visible.</li>
+ * <li>[RIGHT] - Drills down the tree by expanding the tree nodes.</li>
+ * <li>[LEFT] - Goes up the tree and collapses the tree nodes.</li>
+ * </ul>
+ * <br>
+ *
+ * The user can use the following keyboard shortcuts to perform selection,
+ * when the <code>mode</code> property is in use:
+ * <ul>
+ * <li>[SPACE] - Selects the currently focused item upon keyup.</li>
+ * <li>[ENTER]  - Selects the currently focused item upon keydown.</li>
+ * </ul>
  *
  * <h3>ES6 Module Import</h3>
- * <code>import @ui5/webcomponents/dist/Tree.js";</code>
+ * <code>import "@ui5/webcomponents/dist/Tree.js";</code>
  * <br>
- * <code>import @ui5/webcomponents/dist/TreeItem.js";</code> (for its respective item element)
+ * <code>import "@ui5/webcomponents/dist/TreeItem.js";</code>
  *
  * @constructor
  * @author SAP SE
@@ -217,17 +302,12 @@ class Tree extends UI5Element {
 		return TreeTemplate;
 	}
 
-	static async onDefine() {
-		await Promise.all([
-			List.define(),
-			TreeListItem.define(),
-			TreeItem.define(),
-		]);
-	}
-
-	constructor() {
-		super();
-		this._observer = new MutationObserver(this.onTreeStructureChange.bind(this));
+	static get dependencies() {
+		return [
+			List,
+			TreeListItem,
+			TreeItem,
+		];
 	}
 
 	onBeforeRendering() {
@@ -235,22 +315,6 @@ class Tree extends UI5Element {
 		buildTree(this, 1, this._listItems);
 	}
 
-	onEnterDOM() {
-		this._observer.observe(this, { attributes: true, childList: true, subtree: true });
-	}
-
-	onExitDOM() {
-		this._observer.disconnect();
-	}
-
-	onTreeStructureChange() {
-		// setTimeout is needed for IE11 so that it does not interfere with ItemNavigation.js and its await on RenderScheduler.
-		// Otherwise this invalidation happens too soon and the ItemNavigation is blocked on waiting the tree to finish
-		setTimeout(() => {
-			this._listItems = []; // trigger onBeforeRendering by modifying the tracked property and force tree re-build
-		}, 0);
-	}
-
 	get list() {
 		return this.getDomRef();
 	}
@@ -263,8 +327,8 @@ class Tree extends UI5Element {
 		const listItem = event.detail.item;
 		const treeItem = listItem.treeItem;
 		if (treeItem.items.length > 0) {
-			const firstChildId = treeItem.items[0]._id;
-			const firstChildListItem = this.list.getSlottedNodes("items").find(item => item._id === firstChildId);
+			const firstChild = treeItem.items[0];
+			const firstChildListItem = this.list.getSlottedNodes("items").find(li => li.treeItem === firstChild);
 			firstChildListItem && this.list.focusItem(firstChildListItem);
 		}
 	}
@@ -273,8 +337,8 @@ class Tree extends UI5Element {
 		const listItem = event.detail.item;
 		const treeItem = listItem.treeItem;
 		if (treeItem.parentElement !== this) {
-			const parentId = treeItem.parentElement._id;
-			const parentListItem = this.list.getSlottedNodes("items").find(item => item._id === parentId);
+			const parent = treeItem.parentElement;
+			const parentListItem = this.list.getSlottedNodes("items").find(li => li.treeItem === parent);
 			parentListItem && this.list.focusItem(parentListItem);
 		}
 	}
@@ -282,7 +346,7 @@ class Tree extends UI5Element {
 	_onListItemToggle(event) {
 		const listItem = event.detail.item;
 		const treeItem = listItem.treeItem;
-		const defaultPrevented = !this.fireEvent("itemToggle", { item: treeItem }, true);
+		const defaultPrevented = !this.fireEvent("item-toggle", { item: treeItem }, true);
 		if (!defaultPrevented) {
 			treeItem.toggle();
 		}
@@ -291,13 +355,28 @@ class Tree extends UI5Element {
 	_onListItemClick(event) {
 		const listItem = event.detail.item;
 		const treeItem = listItem.treeItem;
-		this.fireEvent("itemClick", { item: treeItem });
+
+		if (!this.fireEvent("item-click", { item: treeItem }, true)) {
+			event.preventDefault();
+		}
 	}
 
 	_onListItemDelete(event) {
 		const listItem = event.detail.item;
 		const treeItem = listItem.treeItem;
-		this.fireEvent("itemDelete", { item: treeItem });
+		this.fireEvent("item-delete", { item: treeItem });
+	}
+
+	_onListItemMouseOver(event) {
+		const treeItem = event.target.treeItem;
+
+		this.fireEvent("item-mouseover", { item: treeItem });
+	}
+
+	_onListItemMouseOut(event) {
+		const treeItem = event.target.treeItem;
+
+		this.fireEvent("item-mouseout", { item: treeItem });
 	}
 
 	_onListSelectionChange(event) {
@@ -311,12 +390,22 @@ class Tree extends UI5Element {
 			item.selected = true;
 		});
 
-		this.fireEvent("selectionChange", {
+		this.fireEvent("selection-change", {
 			previouslySelectedItems,
 			selectedItems,
 		});
 	}
 
+	/**
+	 * Returns the corresponding list item for a given tree item
+	 *
+	 * @param item The tree item
+	 * @protected
+	 */
+	_getListItemForTreeItem(item) {
+		return this.list.items.find(listItem => listItem.treeItem === item);
+	}
+
 	/**
 	 * Perform Depth-First-Search walk on the tree and run a callback on each node
 	 *
@@ -338,9 +427,11 @@ const walkTree = (el, level, callback) => {
 };
 
 const buildTree = (el, level, result) => {
-	el.items.forEach(item => {
+	el.items.forEach((item, index) => {
 		const listItem = {
 			treeItem: item,
+			size: el.items.length,
+			posinset: index + 1,
 			level,
 		};
 

package/dist/TreeItem.js

@@ -1,4 +1,5 @@
 import UI5Element from "@ui5/webcomponents-base/dist/UI5Element.js";
+import ValueState from "@ui5/webcomponents-base/dist/types/ValueState.js";
 
 /**
  * @public
@@ -11,7 +12,7 @@ const metadata = {
 		 * Defines the text of the tree item.
 		 *
 		 * @public
-		 * @type {String}
+		 * @type {string}
 		 * @defaultValue ""
 		 */
 		text: {
@@ -28,6 +29,27 @@ const metadata = {
 		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.
@@ -60,24 +82,62 @@ const metadata = {
 		 * If set, an icon will be displayed before the text, representing the tree item.
 		 *
 		 * @public
-		 * @type {String}
+		 * @type {string}
 		 * @defaultValue ""
 		 */
 		icon: {
 			type: String,
 		},
+
+		/**
+		 * Defines the <code>additionalText</code>, displayed in the end of the tree item.
+		 * @type {string}
+		 * @public
+		 * @since 1.0.0-rc.15
+		 */
+		additionalText: {
+			type: String,
+		},
+
+		/**
+		 * 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}
+		 * @defaultvalue "None"
+		 * @public
+		 * @since 1.0.0-rc.15
+		 */
+		additionalTextState: {
+			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 <code>ui5-tree-item</code>.
+		 * Defines the items of this component.
 		 *
-		 * @type {HTMLElement[]}
-		 * @slot
+		 * @type {sap.ui.webcomponents.main.ITreeItem[]}
+		 * @slot items
 		 * @public
 		 */
 		"default": {
+			propertyName: "items",
 			type: HTMLElement,
+			invalidateOnChildChange: true,
 		},
 	},
 };
@@ -95,7 +155,7 @@ const metadata = {
  * <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>ES6 Module Import</h3>
- * <code>import @ui5/webcomponents/dist/TreeItem.js";</code>
+ * <code>import "@ui5/webcomponents/dist/TreeItem.js";</code>
  *
  * @constructor
  * @author SAP SE
@@ -103,6 +163,7 @@ const metadata = {
  * @extends UI5Element
  * @tagname ui5-tree-item
  * @public
+ * @implements sap.ui.webcomponents.main.ITreeItem
  * @since 1.0.0-rc.8
  */
 class TreeItem extends UI5Element {
@@ -110,17 +171,12 @@ class TreeItem extends UI5Element {
 		return metadata;
 	}
 
-	get items() {
-		return [...this.children];
-	}
-
 	get requiresToggleButton() {
 		return this.hasChildren || this.items.length > 0;
 	}
 
 	/**
 	 * Call this method to manually switch the <code>expanded</code> state of a tree item.
-	 *
 	 * @public
 	 */
 	toggle() {