@ui5/webcomponents 0.0.0-e463d2345 → 0.0.0-e58530409

package/src/Tab.js

@@ -0,0 +1,429 @@
+import UI5Element from "@ui5/webcomponents-base/dist/UI5Element.js";
+import litRender from "@ui5/webcomponents-base/dist/renderer/LitRenderer.js";
+import executeTemplate from "@ui5/webcomponents-base/dist/renderer/executeTemplate.js";
+import "@ui5/webcomponents-icons/dist/error.js";
+import "@ui5/webcomponents-icons/dist/alert.js";
+import "@ui5/webcomponents-icons/dist/sys-enter-2.js";
+import SemanticColor from "./types/SemanticColor.js";
+import ListItemType from "./types/ListItemType.js";
+import TabContainer from "./TabContainer.js";
+import Icon from "./Icon.js";
+import Button from "./Button.js";
+import CustomListItem from "./CustomListItem.js";
+
+// Templates
+import TabTemplate from "./generated/templates/TabTemplate.lit.js";
+import TabInStripTemplate from "./generated/templates/TabInStripTemplate.lit.js";
+import TabInOverflowTemplate from "./generated/templates/TabInOverflowTemplate.lit.js";
+
+// Styles
+import css from "./generated/themes/Tab.css.js";
+import stripCss from "./generated/themes/TabInStrip.css.js";
+import overflowCss from "./generated/themes/TabInOverflow.css.js";
+
+/**
+ * @public
+ */
+const metadata = {
+	tag: "ui5-tab",
+	managedSlots: true,
+	languageAware: true,
+	slots: /** @lends sap.ui.webcomponents.main.Tab.prototype */ {
+
+		/**
+		 * Holds the content associated with this tab.
+		 *
+		 * @type {Node[]}
+		 * @public
+		 * @slot
+		 */
+		"default": {
+			type: Node,
+			propertyName: "content",
+			invalidateOnChildChange: {
+				properties: true,
+				slots: false,
+			},
+		},
+
+		/**
+		 * Defines hierarchies with nested sub tabs.
+		 * <br><br>
+		 * <b>Note:</b> Use <code>ui5-tab</code> and <code>ui5-tab-separator</code> for the intended design.
+		 *
+		 * @type {sap.ui.webcomponents.main.ITab[]}
+		 * @public
+		 * @slot subTabs
+		 */
+		subTabs: {
+			type: HTMLElement,
+			individualSlots: true,
+			invalidateOnChildChange: {
+				properties: true,
+				slots: false,
+			},
+		},
+	},
+	properties: /** @lends sap.ui.webcomponents.main.Tab.prototype */ {
+
+		/**
+		 * The text to be displayed for the item.
+		 * @type {string}
+		 * @defaultvalue ""
+		 * @public
+		 */
+		text: {
+			type: String,
+		},
+
+		/**
+		 * Enabled items can be selected.
+		 * @type {boolean}
+		 * @defaultvalue false
+		 * @public
+		 */
+		disabled: {
+			type: Boolean,
+		},
+
+		/**
+		 * Represents the "additionalText" text, which is displayed in the tab.
+		 * @type {string}
+		 * @defaultvalue ""
+		 * @public
+		 */
+		additionalText: {
+			type: String,
+		},
+
+		/**
+		 * Defines the icon source URI to be displayed as graphical element within the component.
+		 * The SAP-icons font provides numerous built-in icons.
+		 * 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 component's design color.
+		 * <br><br>
+		 * The design is applied to:
+		 * <ul>
+		 * <li>the component icon</li>
+		 * <li>the <code>text</code> when the component overflows</li>
+		 * <li>the tab selection line</li>
+		 * </ul>
+		 *
+		 * <br><br>
+		 * Available designs are: <code>"Default"</code>, <code>"Neutral"</code>, <code>"Positive"</code>, <code>"Critical"</code> and <code>"Negative"</code>.
+		 *
+		 * <br><br>
+		 * <b>Note:</b> The design depends on the current theme.
+		 * @type {SemanticColor}
+		 * @defaultvalue "Default"
+		 * @public
+		 */
+		design: {
+			type: SemanticColor,
+			defaultValue: SemanticColor.Default,
+		},
+
+		/**
+		 * Specifies if the component is selected.
+		 *
+		 * @type {boolean}
+		 * @defaultvalue false
+		 * @public
+		 */
+		selected: {
+			type: Boolean,
+		},
+
+		_tabIndex: {
+			type: String,
+			defaultValue: "-1",
+			noAttribute: true,
+		},
+
+		_selected: {
+			type: Boolean,
+		},
+
+		_realTab: {
+			type: Object,
+		},
+
+		_isTopLevelTab: {
+			type: Boolean,
+		},
+	},
+	events: /** @lends sap.ui.webcomponents.main.Tab.prototype */ {
+	},
+};
+
+/**
+ * @class
+ * The <code>ui5-tab</code> represents a selectable item inside a <code>ui5-tabcontainer</code>.
+ * It defines both the item in the tab strip (top part of the <code>ui5-tabcontainer</code>) and the
+ * content that is presented to the user once the tab is selected.
+ *
+ * @constructor
+ * @author SAP SE
+ * @alias sap.ui.webcomponents.main.Tab
+ * @extends UI5Element
+ * @tagname ui5-tab
+ * @implements sap.ui.webcomponents.main.ITab
+ * @public
+ */
+class Tab extends UI5Element {
+	static get metadata() {
+		return metadata;
+	}
+
+	static get render() {
+		return litRender;
+	}
+
+	static get template() {
+		return TabTemplate;
+	}
+
+	static get stripTemplate() {
+		return TabInStripTemplate;
+	}
+
+	static get overflowTemplate() {
+		return TabInOverflowTemplate;
+	}
+
+	static get styles() {
+		return css;
+	}
+
+	static get dependencies() {
+		return [
+			Icon,
+			Button,
+			CustomListItem,
+		];
+	}
+
+	get displayText() {
+		let text = this.text;
+
+		if (this._isInline && this.additionalText) {
+			text += ` (${this.additionalText})`;
+		}
+
+		return text;
+	}
+
+	get isSeparator() {
+		return false;
+	}
+
+	get stripPresentation() {
+		return executeTemplate(this.constructor.stripTemplate, this);
+	}
+
+	get overflowPresentation() {
+		return executeTemplate(this.constructor.overflowTemplate, this);
+	}
+
+	get stableDomRef() {
+		return this.getAttribute("stable-dom-ref") || `${this._id}-stable-dom-ref`;
+	}
+
+	get requiresExpandButton() {
+		return this.subTabs.length > 0 && this._isTopLevelTab && this._hasOwnContent;
+	}
+
+	get isSingleClickArea() {
+		return this.subTabs.length > 0 && this._isTopLevelTab && !this._hasOwnContent;
+	}
+
+	get isOnSelectedTabPath() {
+		return this._realTab === this || this.tabs.some(subTab => subTab.isOnSelectedTabPath);
+	}
+
+	get _effectiveSlotName() {
+		return this.isOnSelectedTabPath ? this._individualSlot : `disabled-${this._individualSlot}`;
+	}
+
+	get _defaultSlotName() {
+		return this._realTab === this ? "" : "disabled-slot";
+	}
+
+	get _hasOwnContent() {
+		return this.content.some(node => (node.nodeType !== Node.COMMENT_NODE
+				&& (node.nodeType !== Node.TEXT_NODE || node.nodeValue.trim().length !== 0)));
+	}
+
+	/**
+	 * Returns the DOM reference of the tab that is placed in the header.
+	 * <b>Note:</b> If you need a DOM ref to the tab content please use the <code>getDomRef</code> method.
+	 *
+	 * @function
+	 * @public
+	 * @since 1.0.0-rc.16
+	 */
+	getTabInStripDomRef() {
+		return this._tabInStripDomRef;
+	}
+
+	getFocusDomRef() {
+		let focusedDomRef = super.getFocusDomRef();
+
+		if (this._getTabContainerHeaderItemCallback) {
+			focusedDomRef = this._getTabContainerHeaderItemCallback();
+		}
+
+		return focusedDomRef;
+	}
+
+	get isMixedModeTab() {
+		return !this.icon && this._mixedMode;
+	}
+
+	get isTextOnlyTab() {
+		return !this.icon && !this._mixedMode;
+	}
+
+	get isIconTab() {
+		return !!this.icon;
+	}
+
+	get effectiveDisabled() {
+		return this.disabled || undefined;
+	}
+
+	get effectiveSelected() {
+		const subItemSelected = this.tabs.some(elem => elem.effectiveSelected);
+		return this.selected || this._selected || subItemSelected;
+	}
+
+	get effectiveHidden() {
+		return !this.effectiveSelected;
+	}
+
+	get tabs() {
+		return this.subTabs.filter(tab => !tab.isSeparator);
+	}
+
+	get ariaLabelledBy() {
+		const labels = [];
+
+		if (this.text) {
+			labels.push(`${this._id}-text`);
+		}
+
+		if (this.additionalText) {
+			labels.push(`${this._id}-additionalText`);
+		}
+
+		if (this.icon) {
+			labels.push(`${this._id}-icon`);
+		}
+
+		return labels.join(" ");
+	}
+
+	get stripClasses() {
+		const classes = ["ui5-tab-strip-item"];
+
+		if (this.effectiveSelected) {
+			classes.push("ui5-tab-strip-item--selected");
+		}
+
+		if (this.disabled) {
+			classes.push("ui5-tab-strip-item--disabled");
+		}
+
+		if (this._isInline) {
+			classes.push("ui5-tab-strip-item--inline");
+		}
+
+		if (this.additionalText) {
+			classes.push("ui5-tab-strip-item--withAddionalText");
+		}
+
+		if (!this.icon && !this._mixedMode) {
+			classes.push("ui5-tab-strip-item--textOnly");
+		}
+
+		if (this.icon) {
+			classes.push("ui5-tab-strip-item--withIcon");
+		}
+
+		if (!this.icon && this._mixedMode) {
+			classes.push("ui5-tab-strip-item--mixedMode");
+		}
+
+		if (this.design !== SemanticColor.Default) {
+			classes.push(`ui5-tab-strip-item--${this.design.toLowerCase()}`);
+		}
+
+		if (this.isSingleClickArea) {
+			classes.push(`ui5-tab-strip-item--singleClickArea`);
+		}
+
+		return classes.join(" ");
+	}
+
+	get semanticIconName() {
+		switch (this.design) {
+		case SemanticColor.Positive:
+			return "sys-enter-2";
+		case SemanticColor.Negative:
+			return "error";
+		case SemanticColor.Critical:
+			return "alert";
+		default:
+			return null;
+		}
+	}
+
+	get semanticIconClasses() {
+		const classes = ["ui5-tab-semantic-icon"];
+
+		if (this.design !== SemanticColor.Default && this.design !== SemanticColor.Neutral) {
+			classes.push(`ui5-tab-semantic-icon--${this.design.toLowerCase()}`);
+		}
+
+		return classes.join(" ");
+	}
+
+	get overflowClasses() {
+		const classes = ["ui5-tab-overflow-item"];
+
+		if (this.design !== SemanticColor.Default && this.design !== SemanticColor.Neutral) {
+			classes.push(`ui5-tab-overflow-item--${this.design.toLowerCase()}`);
+		}
+
+		if (this.effectiveDisabled) {
+			classes.push("ui5-tab-overflow-item--disabled");
+		}
+
+		if (this.selected) {
+			classes.push("ui5-tab-overflow-item--selectedSubTab");
+		}
+
+		return classes.join(" ");
+	}
+
+	get overflowState() {
+		return (this.disabled || this.isSingleClickArea) ? ListItemType.Inactive : ListItemType.Active;
+	}
+}
+
+Tab.define();
+
+TabContainer.registerTabStyles(stripCss);
+TabContainer.registerStaticAreaTabStyles(overflowCss);
+
+export default Tab;

package/src/TabContainer.hbs

@@ -0,0 +1,78 @@
+<div class="{{classes.root}}">
+	{{#if tabsAtTheBottom}}
+		{{> contentArea}}
+	{{/if}}
+	<div class="{{classes.header}}" id="{{_id}}-header">
+		<div
+			class="ui5-tc__overflow ui5-tc__overflow--start"
+			@click="{{_onOverflowClick}}"
+			@keydown="{{_onOverflowKeyDown}}"
+			hidden
+		>
+			{{#if startOverflowButton.length}}
+				<slot name="startOverflowButton"></slot>
+			{{else}}
+				<ui5-button
+					icon="{{overflowMenuIcon}}"
+					data-ui5-stable="overflow-start"
+					tabindex="-1"
+					tooltip="{{overflowMenuTitle}}"
+					aria-haspopup="true"
+					icon-end>{{this._startOverflowText}}</ui5-button>
+			{{/if}}
+		</div>
+
+		<div
+			id="{{_id}}-tabStrip"
+			class="{{classes.tabStrip}}"
+			role="tablist"
+			@click="{{_onTabStripClick}}"
+			@keydown="{{_onTabStripKeyDown}}"
+			@keyup="{{_onTabStripKeyUp}}"
+		>
+			{{#each items}}
+				{{this.stripPresentation}}
+			{{/each}}
+		</div>
+
+		<div
+			class="ui5-tc__overflow ui5-tc__overflow--end"
+			@click="{{_onOverflowClick}}"
+			@keydown="{{_onOverflowKeyDown}}"
+			hidden
+		>
+			{{#if overflowButton.length}}
+				<slot name="overflowButton"></slot>
+			{{else}}
+				<ui5-button
+					icon="{{overflowMenuIcon}}"
+					data-ui5-stable="overflow-end"
+					tabindex="-1"
+					tooltip="{{overflowMenuTitle}}"
+					aria-haspopup="true"
+					icon-end>{{this._endOverflowText}}</ui5-button>
+			{{/if}}
+		</div>
+	</div>
+
+	{{#unless tabsAtTheBottom}}
+		{{> contentArea}}
+	{{/unless}}
+
+</div>
+
+{{#*inline "contentArea"}}
+	<div class="{{classes.content}}" part="content">
+		<div
+			class="ui5-tc__contentItem"
+			id="ui5-tc-content"
+			?hidden="{{this._selectedTab.effectiveHidden}}"
+			role="tabpanel"
+			aria-labelledby="{{this._selectedTab._id}}"
+		>
+			{{#each items}}
+				<slot name="{{this._effectiveSlotName}}"></slot>
+			{{/each}}
+		</div>
+	</div>
+{{/inline}}