@ui5/webcomponents 0.0.0-97cba4b0b → 0.0.0-99b763015

package/src/Tree.ts

@@ -1,509 +0,0 @@
-import UI5Element from "@ui5/webcomponents-base/dist/UI5Element.js";
-import customElement from "@ui5/webcomponents-base/dist/decorators/customElement.js";
-import property from "@ui5/webcomponents-base/dist/decorators/property.js";
-import slot from "@ui5/webcomponents-base/dist/decorators/slot.js";
-import event from "@ui5/webcomponents-base/dist/decorators/event.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 TreeItemCustom from "./TreeItemCustom.js";
-import TreeList from "./TreeList.js";
-import ListMode from "./types/ListMode.js";
-import type TreeItemBase from "./TreeItemBase.js";
-import type {
-	TreeItemBaseToggleEventDetail,
-	TreeItemBaseStepInEventDetail,
-	TreeItemBaseStepOutEventDetail,
-} from "./TreeItemBase.js";
-import type {
-	ClickEventDetail as ListItemClickEventDetail,
-	DeleteEventDetail as ListItemDeleteEventDetail,
-	SelectionChangeEventDetail as ListSelectionChangeEventDetail,
-} from "./List.js";
-
-// Template
-import TreeTemplate from "./generated/templates/TreeTemplate.lit.js";
-
-// Styles
-import TreeCss from "./generated/themes/Tree.css.js";
-
-type TreeItemEventDetail = {
-	item: TreeItemBase,
-}
-type TreeItemToggleEventDetail = TreeItemEventDetail;
-type TreeItemMouseoverEventDetail = TreeItemEventDetail;
-type TreeItemMouseoutEventDetail = TreeItemEventDetail;
-type TreeItemClickEventDetail = TreeItemEventDetail;
-type TreeItemDeleteEventDetail = TreeItemEventDetail;
-type TreeItemSelectionChangeEventDetail = {
-	selectedItems: Array<TreeItemBase>;
-	previouslySelectedItems: Array<TreeItemBase>;
-	targetItem: TreeItemBase;
-}
-type WalkCallback = (item: TreeItemBase, level: number, index: number) => void;
-
-/**
- * @class
- *
- * <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>
- *
- * 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>
- * <br>
- * <code>import "@ui5/webcomponents/dist/TreeItem.js";</code>
- *
- * @constructor
- * @author SAP SE
- * @alias sap.ui.webc.main.Tree
- * @extends sap.ui.webc.base.UI5Element
- * @tagname ui5-tree
- * @appenddocs sap.ui.webc.main.TreeItem sap.ui.webc.main.TreeItemCustom
- * @public
- * @since 1.0.0-rc.8
- */
-@customElement({
-	tag: "ui5-tree",
-	renderer: litRender,
-	styles: TreeCss,
-	template: TreeTemplate,
-	dependencies: [
-		TreeList,
-		TreeItem,
-		TreeItemCustom,
-	],
-})
-/**
- * Fired when a tree item is expanded or collapsed.
- * <i>Note:</i> You can call <code>preventDefault()</code> on the event object to suppress the event, if needed.
- * 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.webc.main.Tree#item-toggle
- * @param {HTMLElement} item the toggled item.
- * @allowPreventDefault
- * @public
- */
-@event("item-toggle", {
-	detail: {
-		item: { type: HTMLElement },
-	},
-})
-/**
- * Fired when the mouse cursor enters the tree item borders.
- * @event sap.ui.webc.main.Tree#item-mouseover
- * @param {HTMLElement} item the hovered item.
- * @since 1.0.0-rc.16
- * @public
- */
-@event("item-mouseover", {
-	detail: {
-		item: { type: HTMLElement },
-	},
-})
-/**
- * Fired when the mouse cursor leaves the tree item borders.
- * @event sap.ui.webc.main.Tree#item-mouseout
- * @param {HTMLElement} item the hovered item.
- * @since 1.0.0-rc.16
- * @public
- */
-@event("item-mouseout", {
-	detail: {
-		item: { type: HTMLElement },
-	},
-})
-/**
- * Fired when a tree item is activated.
- *
- * @event sap.ui.webc.main.Tree#item-click
- * @allowPreventDefault
- * @param {HTMLElement} item The clicked item.
- * @public
- */
-@event("item-click", {
-	detail: {
-		item: { type: HTMLElement },
-	},
-})
-
-/**
- * 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 component <code>mode</code> property is set to <code>Delete</code>.
- *
- * @event sap.ui.webc.main.Tree#item-delete
- * @param {HTMLElement} item the deleted item.
- * @public
- */
-@event("item-delete", {
-	detail: {
-		item: { type: HTMLElement },
-	},
-})
-
-/**
- * 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.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
- */
-@event("selection-change", {
-	detail: {
-		selectedItems: { type: Array },
-		previouslySelectedItems: { type: Array },
-		targetItem: { type: HTMLElement },
-	},
-})
-class Tree extends UI5Element {
-	/**
-	 * 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>
-	 *
-	 * <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 {sap.ui.webc.main.types.ListMode}
-	 * @name sap.ui.webc.main.Tree.prototype.mode
-	 * @defaultValue "None"
-	 */
-	@property({ type: ListMode, defaultValue: ListMode.None })
-	mode!: ListMode;
-
-	/**
-	 * Defines the text that is displayed when the component contains no items.
-	 *
-	 * @type {string}
-	 * @name sap.ui.webc.main.Tree.prototype.noDataText
-	 * @defaultvalue ""
-	 * @public
-	 */
-	@property()
-	noDataText!: string;
-
-	/**
-	 * Defines the component header text.
-	 * <br><br>
-	 * <b>Note:</b> If the <code>header</code> slot is set, this property is ignored.
-	 *
-	 * @type {string}
-	 * @name sap.ui.webc.main.Tree.prototype.headerText
-	 * @defaultvalue ""
-	 * @public
-	 */
-	@property()
-	headerText!: string;
-
-	/**
-	 * Defines the component footer text.
-	 *
-	 * @type {string}
-	 * @name sap.ui.webc.main.Tree.prototype.footerText
-	 * @defaultvalue ""
-	 * @public
-	 */
-	@property()
-	footerText!: string;
-
-	/**
-	 * Defines the accessible name of the component.
-	 *
-	 * @type {string}
-	 * @name sap.ui.webc.main.Tree.prototype.accessibleName
-	 * @defaultvalue: ""
-	 * @public
-	 * @since 1.8.0
-	 */
-	@property()
-	accessibleName!: string;
-
-	/**
-	 * Defines the IDs of the elements that label the component.
-	 *
-	 * @type {string}
-	 * @name sap.ui.webc.main.Tree.prototype.accessibleNameRef
-	 * @defaultvalue ""
-	 * @public
-	 * @since 1.8.0
-	 */
-	@property()
-	accessibleNameRef!: string;
-
-	/**
-	 * Defines the description for the accessible role of the component.
-	 * @protected
-	 * @type {string}
-	 * @name sap.ui.webc.main.Tree.prototype.accessibleRoleDescription
-	 * @defaultvalue undefined
-	 * @since 1.10.0
-	 */
-	@property({ defaultValue: undefined, noAttribute: true })
-	accessibleRoleDescription?: string;
-
-	/**
-	 * Shows the toggle button at the end, rather than at the beginning of the items
-	 *
-	 * @protected
-	 * @since 1.0.0-rc.8
-	 */
-	@property({ type: Boolean })
-	_toggleButtonEnd!: 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
-	 */
-	@property({ type: Boolean })
-	_minimal!: boolean;
-
-	/**
-	 * 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.webc.main.ITreeItem[]}
-	 * @name sap.ui.webc.main.Tree.prototype.default
-	 * @slot items
-	 * @public
-	 */
-	@slot({ type: HTMLElement, invalidateOnChildChange: true, "default": true })
-	items!: Array<TreeItemBase>;
-
-	/**
-	 * Defines the component header.
-	 * <br><br>
-	 * <b>Note:</b> When the <code>header</code> slot is set, the
-	 * <code>headerText</code> property is ignored.
-	 *
-	 * @type {HTMLElement[]}
-	 * @name sap.ui.webc.main.Tree.prototype.header
-	 * @slot header
-	 * @public
-	 */
-	@slot()
-	header!: Array<HTMLElement>;
-
-	onBeforeRendering() {
-		this._prepareTreeItems();
-	}
-
-	get list() {
-		return this.getDomRef() as TreeList;
-	}
-
-	get _role() {
-		return this._minimal ? "menubar" : "tree";
-	}
-
-	get _label() {
-		return getEffectiveAriaLabelText(this);
-	}
-
-	get _hasHeader() {
-		return !!this.header.length;
-	}
-
-	_onListItemStepIn(e: CustomEvent<TreeItemBaseStepInEventDetail>) {
-		const treeItem = e.detail.item;
-		if (treeItem.items.length > 0) {
-			const firstChild = treeItem.items[0];
-			const firstChildListItem = this._getListItemForTreeItem(firstChild);
-			firstChildListItem && this.list.focusItem(firstChildListItem);
-		}
-	}
-
-	_onListItemStepOut(e: CustomEvent<TreeItemBaseStepOutEventDetail>) {
-		const treeItem = e.detail.item;
-		if (treeItem.parentElement !== this) {
-			const parent = treeItem.parentElement as TreeItemBase;
-			const parentListItem = this._getListItemForTreeItem(parent);
-			parentListItem && this.list.focusItem(parentListItem);
-		}
-	}
-
-	_onListItemToggle(e: CustomEvent<TreeItemBaseToggleEventDetail>) {
-		const treeItem = e.detail.item;
-		const defaultPrevented = !this.fireEvent<TreeItemToggleEventDetail>("item-toggle", { item: treeItem }, true);
-		if (!defaultPrevented) {
-			treeItem.toggle();
-		}
-	}
-
-	_onListItemClick(e: CustomEvent<ListItemClickEventDetail>) {
-		const treeItem = e.detail.item as TreeItemBase;
-
-		if (!this.fireEvent<TreeItemClickEventDetail>("item-click", { item: treeItem }, true)) {
-			e.preventDefault();
-		}
-	}
-
-	_onListItemDelete(e: CustomEvent<ListItemDeleteEventDetail>) {
-		const treeItem = e.detail.item as TreeItemBase;
-		this.fireEvent<TreeItemDeleteEventDetail>("item-delete", { item: treeItem });
-	}
-
-	_onListItemMouseOver(e: MouseEvent) {
-		const target = e.target;
-
-		if (this._isInstanceOfTreeItemBase(target)) {
-			this.fireEvent<TreeItemMouseoverEventDetail>("item-mouseover", { item: target });
-		}
-	}
-
-	_onListItemMouseOut(e: MouseEvent) {
-		const target = e.target;
-
-		if (this._isInstanceOfTreeItemBase(target)) {
-			this.fireEvent<TreeItemMouseoutEventDetail>("item-mouseout", { item: target });
-		}
-	}
-
-	_onListSelectionChange(e: CustomEvent<ListSelectionChangeEventDetail>) {
-		const previouslySelectedItems = e.detail.previouslySelectedItems as Array<TreeItemBase>;
-		const selectedItems = e.detail.selectedItems as Array<TreeItemBase>;
-		const targetItem = e.detail.targetItem as TreeItemBase;
-
-		previouslySelectedItems.forEach(item => {
-			item.selected = false;
-		});
-		selectedItems.forEach(item => {
-			item.selected = true;
-		});
-
-		this.fireEvent<TreeItemSelectionChangeEventDetail>("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.toString());
-
-			item._toggleButtonEnd = this._toggleButtonEnd;
-			item._minimal = this._minimal;
-			item._setsize = ariaSetSize;
-			item._posinset = index + 1;
-		});
-	}
-
-	/**
-	 * Returns the corresponding list item for a given tree item
-	 *
-	 * @param item The tree item
-	 * @protected
-	 */
-	_getListItemForTreeItem(item: TreeItemBase) {
-		return this.getItems().find(listItem => listItem === item);
-	}
-
-	/**
-	 * Returns the a flat array of all tree items
-	 * @protected
-	 * @returns {Array}
-	 */
-	getItems(): Array<TreeItemBase> {
-		return this.list.getItems();
-	}
-
-	/**
-	 * Focus a tree item by its index in the flat array of all tree items
-	 * @protected
-	 * @param index
-	 */
-	focusItemByIndex(index: number) {
-		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 3 arguments: the node, the level and the index
-	 */
-	walk(callback: WalkCallback) {
-		walkTree(this, 1, callback);
-	}
-
-	_isInstanceOfTreeItemBase(object: any): object is TreeItemBase {
-		return "isTreeItem" in object;
-	}
-}
-
-const walkTree = (el: Tree | TreeItemBase, level: number, callback: WalkCallback) => {
-	(el.items).forEach((item, index) => {
-		callback(item, level, index);
-		if (item.items.length > 0) {
-			walkTree(item, level + 1, callback);
-		}
-	});
-};
-
-Tree.define();
-
-export default Tree;
-
-export type {
-	TreeItemToggleEventDetail,
-	TreeItemMouseoverEventDetail,
-	TreeItemMouseoutEventDetail,
-	TreeItemClickEventDetail,
-	TreeItemDeleteEventDetail,
-	TreeItemSelectionChangeEventDetail,
-};

package/src/TreeItem.ts

@@ -1,90 +0,0 @@
-import customElement from "@ui5/webcomponents-base/dist/decorators/customElement.js";
-import property from "@ui5/webcomponents-base/dist/decorators/property.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";
-
-/**
- * @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>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.webc.main.TreeItem
- * @extends sap.ui.webc.main.TreeItemBase
- * @tagname ui5-tree-item
- * @public
- * @implements sap.ui.webc.main.ITreeItem
- * @since 1.0.0-rc.8
- */
-@customElement({
-	tag: "ui5-tree-item",
-	template: TreeItemTemplate,
-	styles: [TreeItemBase.styles, treeItemCss],
-})
-class TreeItem extends TreeItemBase {
-	/**
-	 * Defines the text of the tree item.
-	 *
-	 * @public
-	 * @type {string}
-	 * @name sap.ui.webc.main.TreeItem.prototype.text
-	 * @defaultValue ""
-	 */
-	@property()
-	text!: string;
-
-	/**
-	 * Defines the <code>additionalText</code>, displayed in the end of the tree item.
-	 * @type {string}
-	 * @name sap.ui.webc.main.TreeItem.prototype.additionalText
-	 * @defaultvalue ""
-	 * @public
-	 * @since 1.0.0-rc.15
-	 */
-	@property()
-	additionalText!: 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>"Error"</code>.
-	 * @type {sap.ui.webc.base.types.ValueState}
-	 * @name sap.ui.webc.main.TreeItem.prototype.additionalTextState
-	 * @defaultvalue "None"
-	 * @public
-	 * @since 1.0.0-rc.15
-	 */
-	@property({ type: ValueState, defaultValue: ValueState.None })
-	additionalTextState!: ValueState;
-
-	get _showTitle() {
-		return this.text.length && !this._minimal;
-	}
-}
-
-TreeItem.define();
-
-export default TreeItem;