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

package/src/TabContainer.js

@@ -0,0 +1,679 @@
+import UI5Element from "@ui5/webcomponents-base/dist/UI5Element.js";
+import litRender from "@ui5/webcomponents-base/dist/renderer/LitRenderer.js";
+import ResizeHandler from "@ui5/webcomponents-base/dist/delegate/ResizeHandler.js";
+import ScrollEnablement from "@ui5/webcomponents-base/dist/delegate/ScrollEnablement.js";
+import slideDown from "@ui5/webcomponents-base/dist/animations/slideDown.js";
+import slideUp from "@ui5/webcomponents-base/dist/animations/slideUp.js";
+import AnimationMode from "@ui5/webcomponents-base/dist/types/AnimationMode.js";
+import { getAnimationMode } from "@ui5/webcomponents-base/dist/config/AnimationMode.js";
+import ItemNavigation from "@ui5/webcomponents-base/dist/delegate/ItemNavigation.js";
+import { isSpace, isEnter } from "@ui5/webcomponents-base/dist/Keys.js";
+import MediaRange from "@ui5/webcomponents-base/dist/MediaRange.js";
+import { getI18nBundle } from "@ui5/webcomponents-base/dist/i18nBundle.js";
+import "@ui5/webcomponents-icons/dist/slim-arrow-up.js";
+import "@ui5/webcomponents-icons/dist/slim-arrow-down.js";
+import "@ui5/webcomponents-icons/dist/slim-arrow-left.js";
+import "@ui5/webcomponents-icons/dist/slim-arrow-right.js";
+import { TABCONTAINER_PREVIOUS_ICON_ACC_NAME, TABCONTAINER_NEXT_ICON_ACC_NAME, TABCONTAINER_OVERFLOW_MENU_TITLE } from "./generated/i18n/i18n-defaults.js";
+import Button from "./Button.js";
+import Icon from "./Icon.js";
+import List from "./List.js";
+import ResponsivePopover from "./ResponsivePopover.js";
+import TabContainerTabsPlacement from "./types/TabContainerTabsPlacement.js";
+
+// Templates
+import TabContainerTemplate from "./generated/templates/TabContainerTemplate.lit.js";
+import TabContainerPopoverTemplate from "./generated/templates/TabContainerPopoverTemplate.lit.js";
+
+// Styles
+import tabContainerCss from "./generated/themes/TabContainer.css.js";
+import ResponsivePopoverCommonCss from "./generated/themes/ResponsivePopoverCommon.css.js";
+import TabLayout from "./types/TabLayout.js";
+
+const SCROLL_STEP = 128;
+
+const tabStyles = [];
+const staticAreaTabStyles = [];
+
+/**
+ * @public
+ */
+const metadata = {
+	tag: "ui5-tabcontainer",
+	languageAware: true,
+	managedSlots: true,
+	slots: /** @lends  sap.ui.webcomponents.main.TabContainer.prototype */ {
+		/**
+		 * Defines the 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 items
+		 */
+		"default": {
+			propertyName: "items",
+			type: HTMLElement,
+			individualSlots: true,
+			invalidateOnChildChange: {
+				properties: true,
+				slots: false,
+			},
+		},
+
+		/**
+		 * Defines the button which will open the overflow menu. If nothing is provided to this slot, the default button will be used.
+		 *
+		 * @type {sap.ui.webcomponents.main.IButton}
+		 * @public
+		 * @slot
+		 * @since 1.0.0-rc.9
+		 */
+		overflowButton: {
+			type: HTMLElement,
+		},
+	},
+	properties: /** @lends  sap.ui.webcomponents.main.TabContainer.prototype */ {
+		/**
+		 * Defines whether the tabs are in a fixed state that is not
+		 * expandable/collapsible by user interaction.
+		 *
+		 * @type {boolean}
+		 * @defaultvalue false
+		 * @public
+		 */
+		fixed: {
+			type: Boolean,
+		},
+
+		/**
+		 * Defines whether the tab content is collapsed.
+		 *
+		 * @type {boolean}
+		 * @defaultvalue false
+		 * @public
+		 */
+		collapsed: {
+			type: Boolean,
+		},
+
+		/**
+		 * Defines the placement of the tab strip (tab buttons area) relative to the actual tabs' content.
+		 * <br><br>
+		 * <b>Note:</b> By default the tab strip is displayed above the tabs' content area and this is the recommended
+		 * layout for most scenarios. Set to <code>Bottom</code> only when the component is at the
+		 * bottom of the page and you want the tab strip to act as a menu.
+		 *
+		 * <br><br>
+		 * Available options are:
+		 * <ul>
+		 * <li><code>Top</code></li>
+		 * <li><code>Bottom</code></li>
+		 * </ul>
+		 *
+		 * @type {TabContainerTabsPlacement}
+		 * @defaultvalue "Top"
+		 * @since 1.0.0-rc.7
+		 * @private
+		 */
+		tabsPlacement: {
+			type: TabContainerTabsPlacement,
+			defaultValue: TabContainerTabsPlacement.Top,
+		},
+
+		/**
+		 * Defines whether the overflow select list is displayed.
+		 * <br><br>
+		 * The overflow select list represents a list, where all tab filters are displayed
+		 * so that it's easier for the user to select a specific tab filter.
+		 *
+		 * @type {boolean}
+		 * @defaultvalue false
+		 * @public
+		 */
+		showOverflow: {
+			type: Boolean,
+		},
+
+		/**
+		 * Defines the alignment of the content and the <code>additionalText</code> of a tab.
+		 *
+		 * <br><br>
+		 * <b>Note:</b>
+		 * The content and the <code>additionalText</code> would be displayed vertically by defualt,
+		 * but when set to <code>Inline</code>, they would be displayed horizontally.
+		 *
+		 * <br><br>
+		 * Available options are:
+		 * <ul>
+		 * <li><code>Standard</code></li>
+		 * <li><code>Inline</code></li>
+		 * </ul>
+		 *
+		 * @type {TabLayout}
+		 * @defaultvalue "Standard"
+		 * @public
+		 */
+		tabLayout: {
+			type: String,
+			defaultValue: TabLayout.Standard,
+		},
+
+		/**
+		 * Defines the current media query size.
+		 *
+		 * @type {string}
+		 * @private
+		 */
+		mediaRange: {
+			type: String,
+		},
+
+		_selectedTab: {
+			type: Object,
+		},
+
+		_scrollable: {
+			type: Boolean,
+			noAttribute: true,
+		},
+
+		_scrollableBack: {
+			type: Boolean,
+			noAttribute: true,
+		},
+
+		_scrollableForward: {
+			type: Boolean,
+			noAttribute: true,
+		},
+
+		_animationRunning: {
+			type: Boolean,
+			noAttribute: true,
+		},
+
+		_contentCollapsed: {
+			type: Boolean,
+			noAttribute: true,
+		},
+	},
+	events: /** @lends  sap.ui.webcomponents.main.TabContainer.prototype */ {
+
+		/**
+		 * Fired when a tab is selected.
+		 *
+		 * @event sap.ui.webcomponents.main.TabContainer#tab-select
+		 * @param {HTMLElement} tab The selected <code>tab</code>.
+		 * @param {Integer} tabIndex The selected <code>tab</code> index.
+		 * @public
+		 */
+		"tab-select": {
+			detail: {
+				tab: { type: HTMLElement },
+				tabIndex: { type: Number },
+			},
+		},
+	},
+};
+
+/**
+ * @class
+ *
+ * <h3 class="comment-api-title">Overview</h3>
+ *
+ * The <code>ui5-tabcontainer</code> represents a collection of tabs with associated content.
+ * Navigation through the tabs changes the content display of the currently active content area.
+ * A tab can be labeled with text only, or icons with text.
+ *
+ * <h3>Structure</h3>
+ *
+ * The <code>ui5-tabcontainer</code> can hold two types of entities:
+ * <ul>
+ * <li><code>ui5-tab</code> - contains all the information on an item (text and icon)</li>
+ * <li><code>ui5-tab-separator</code> - used to separate tabs with a vertical line</li>
+ * </ul>
+ *
+ * <h3>ES6 Module Import</h3>
+ *
+ * <code>import "@ui5/webcomponents/dist/TabContainer";</code>
+ * <br>
+ * <code>import "@ui5/webcomponents/dist/Tab";</code> (for <code>ui5-tab</code>)
+ * <br>
+ * <code>import "@ui5/webcomponents/dist/TabSeparator";</code> (for <code>ui5-tab-separator</code>)
+ *
+ * @constructor
+ * @author SAP SE
+ * @alias sap.ui.webcomponents.main.TabContainer
+ * @extends sap.ui.webcomponents.base.UI5Element
+ * @appenddocs Tab TabSeparator
+ * @tagname ui5-tabcontainer
+ * @public
+ */
+class TabContainer extends UI5Element {
+	static get metadata() {
+		return metadata;
+	}
+
+	static get styles() {
+		return [tabStyles, tabContainerCss];
+	}
+
+	static get staticAreaStyles() {
+		return [ResponsivePopoverCommonCss, staticAreaTabStyles];
+	}
+
+	static get render() {
+		return litRender;
+	}
+
+	static get template() {
+		return TabContainerTemplate;
+	}
+
+	static get staticAreaTemplate() {
+		return TabContainerPopoverTemplate;
+	}
+
+	static registerTabStyles(styles) {
+		tabStyles.push(styles);
+	}
+
+	static registerStaticAreaTabStyles(styles) {
+		staticAreaTabStyles.push(styles);
+	}
+
+	constructor() {
+		super();
+
+		this._handleResize = this._handleResize.bind(this);
+
+		// Init ScrollEnablement
+		this._scrollEnablement = new ScrollEnablement(this);
+		this._scrollEnablement.attachEvent("scroll", this._updateScrolling.bind(this));
+
+		// Init ItemNavigation
+		this._itemNavigation = new ItemNavigation(this, {
+			getItemsCallback: () => this._getTabs(),
+		});
+	}
+
+	onBeforeRendering() {
+		// Set external properties to items
+		this.items.filter(item => !item.isSeparator).forEach((item, index, arr) => {
+			item._isInline = this.tabLayout === TabLayout.Inline;
+			item._mixedMode = this.mixedMode;
+			item._posinset = index + 1;
+			item._setsize = arr.length;
+			item._getTabContainerHeaderItemCallback = _ => {
+				return this.getDomRef().querySelector(`#${item._id}`);
+			};
+			item._itemSelectCallback = this._onItemSelect.bind(this);
+			item._getRealDomRef = () => this.getDomRef().querySelector(`*[data-ui5-stable=${item.stableDomRef}]`);
+		});
+
+		if (!this._animationRunning) {
+			this._contentCollapsed = this.collapsed;
+		}
+	}
+
+	onAfterRendering() {
+		this._scrollEnablement.scrollContainer = this._getHeaderScrollContainer();
+		this._updateScrolling();
+
+		this.items.forEach(item => {
+			item._getTabInStripDomRef = this.getDomRef().querySelector(`*[data-ui5-stable="${item.stableDomRef}"]`);
+		});
+	}
+
+	onEnterDOM() {
+		ResizeHandler.register(this._getHeader(), this._handleResize);
+	}
+
+	onExitDOM() {
+		ResizeHandler.deregister(this._getHeader(), this._handleResize);
+	}
+
+	_onTablistFocusin(event) {
+		const target = event.target;
+
+		if (!this._scrollable || !target.classList.contains("ui5-tab-strip-item")) {
+			return;
+		}
+
+		const headerScrollContainer = this._getHeaderScrollContainer();
+		const leftArrowWidth = this.shadowRoot.querySelector(".ui5-tc__headerArrowLeft").offsetWidth;
+		const rightArrowWidth = this.shadowRoot.querySelector(".ui5-tc__headerArrowRight").offsetWidth;
+
+		if (this._scrollableBack && (target.offsetLeft - leftArrowWidth < headerScrollContainer.scrollLeft)) {
+			this._scrollEnablement.move(target.offsetLeft - leftArrowWidth - headerScrollContainer.scrollLeft, 0, true);
+			this._updateScrolling();
+		} else if (this._scrollableForward && (target.offsetLeft + target.offsetWidth > headerScrollContainer.scrollLeft + headerScrollContainer.offsetWidth - rightArrowWidth)) {
+			this._scrollEnablement.move(target.offsetLeft + target.offsetWidth - headerScrollContainer.scrollLeft - headerScrollContainer.offsetWidth + rightArrowWidth, 0, true);
+			this._updateScrolling();
+		}
+	}
+
+	_onHeaderClick(event) {
+		const tab = getTab(event.target);
+		if (!tab) {
+			return;
+		}
+
+		this._onHeaderItemSelect(tab);
+	}
+
+	_onHeaderKeyDown(event) {
+		const tab = getTab(event.target);
+		if (!tab) {
+			return;
+		}
+
+		if (isEnter(event)) {
+			this._onHeaderItemSelect(tab);
+		}
+
+		// Prevent Scrolling
+		if (isSpace(event)) {
+			event.preventDefault();
+		}
+	}
+
+	_onHeaderKeyUp(event) {
+		const tab = getTab(event.target);
+		if (!tab) {
+			return;
+		}
+
+		if (isSpace(event)) {
+			this._onHeaderItemSelect(tab);
+		}
+	}
+
+	_onHeaderItemSelect(tab) {
+		if (!tab.hasAttribute("disabled")) {
+			this._onItemSelect(tab);
+		}
+	}
+
+	_onOverflowListItemSelect(event) {
+		this._onItemSelect(event.detail.item);
+		this.responsivePopover.close();
+		this.shadowRoot.querySelector(`#${event.detail.item.id}`).focus();
+	}
+
+	_onItemSelect(target) {
+		const selectedIndex = findIndex(this.items, item => item._id === target.id);
+		const selectedTabIndex = findIndex(this._getTabs(), item => item._id === target.id);
+		const selectedTab = this.items[selectedIndex];
+
+		// update selected items
+		this.items.forEach((item, index) => {
+			if (!item.isSeparator) {
+				const selected = selectedIndex === index;
+				item.selected = selected;
+
+				if (selected) {
+					this._itemNavigation.setCurrentItem(item);
+				}
+			}
+		}, this);
+
+		if (this.fixed) {
+			this.selectTab(selectedTab, selectedTabIndex);
+			return;
+		}
+
+		if (!this.animate) {
+			this.toggle(selectedTab);
+			this.selectTab(selectedTab, selectedTabIndex);
+			return;
+		}
+
+		this.toggleAnimated(selectedTab);
+		this.selectTab(selectedTab, selectedTabIndex);
+	}
+
+	async toggleAnimated(selectedTab) {
+		const content = this.shadowRoot.querySelector(".ui5-tc__content");
+		let animationPromise = null;
+
+		this._animationRunning = true;
+
+		if (selectedTab === this._selectedTab) {
+			// click on already selected tab - animate both directions
+			this.collapsed = !this.collapsed;
+			animationPromise = this.collapsed ? this.slideContentUp(content) : this.slideContentDown(content);
+		} else {
+			// click on new tab - animate if the content is currently collapsed
+			animationPromise = this.collapsed ? this.slideContentDown(content) : Promise.resolve();
+			this.collapsed = false;
+		}
+
+		await animationPromise;
+		this._contentCollapsed = this.collapsed;
+		this._animationRunning = false;
+	}
+
+	toggle(selectedTab) {
+		if (selectedTab === this._selectedTab) {
+			this.collapsed = !this.collapsed;
+		} else {
+			this.collapsed = false;
+		}
+	}
+
+	selectTab(selectedTab, selectedTabIndex) {
+		// select the tab
+		this._selectedTab = selectedTab;
+		this.fireEvent("tab-select", {
+			tab: selectedTab,
+			tabIndex: selectedTabIndex,
+		});
+	}
+
+	slideContentDown(element) {
+		return slideDown({ element }).promise();
+	}
+
+	slideContentUp(element) {
+		return slideUp({ element }).promise();
+	}
+
+	async _onOverflowButtonClick(event) {
+		const button = this.overflowButton[0] || this.getDomRef().querySelector(".ui-tc__overflowButton > [ui5-button]");
+
+		if (event.target !== button) {
+			return;
+		}
+
+		this.responsivePopover = await this._respPopover();
+		if (this.responsivePopover.opened) {
+			this.responsivePopover.close();
+		} else {
+			this.responsivePopover.showAt(button);
+		}
+	}
+
+	_onHeaderBackArrowClick() {
+		this._scrollEnablement.move(-SCROLL_STEP, 0).promise()
+			.then(_ => this._updateScrolling());
+	}
+
+	_onHeaderForwardArrowClick() {
+		this._scrollEnablement.move(SCROLL_STEP, 0).promise()
+			.then(_ => this._updateScrolling());
+	}
+
+	_handleResize() {
+		this._updateScrolling();
+		this._updateMediaRange();
+	}
+
+	async _closeRespPopover() {
+		this.responsivePopover = await this._respPopover();
+		this.responsivePopover.close();
+	}
+
+	_updateScrolling() {
+		const headerScrollContainer = this._getHeaderScrollContainer();
+
+		this._scrollable = headerScrollContainer.offsetWidth < headerScrollContainer.scrollWidth;
+		this._scrollableBack = headerScrollContainer.scrollLeft > 0;
+		this._scrollableForward = Math.ceil(headerScrollContainer.scrollLeft) < headerScrollContainer.scrollWidth - headerScrollContainer.offsetWidth;
+
+		if (!this._scrollable) {
+			this._closeRespPopover();
+		}
+	}
+
+	_updateMediaRange() {
+		this.mediaRange = MediaRange.getCurrentRange(MediaRange.RANGESETS.RANGE_4STEPS, this.getDomRef().offsetWidth);
+	}
+
+	_getHeader() {
+		return this.shadowRoot.querySelector(`#${this._id}-header`);
+	}
+
+	_getTabs() {
+		return this.items.filter(item => !item.isSeparator);
+	}
+
+	_getHeaderScrollContainer() {
+		return this.shadowRoot.querySelector(`#${this._id}-headerScrollContainer`);
+	}
+
+	async _respPopover() {
+		const staticAreaItem = await this.getStaticAreaItemDomRef();
+		return staticAreaItem.querySelector(`#${this._id}-overflowMenu`);
+	}
+
+	get shouldShowOverflow() {
+		return this.showOverflow && this._scrollable;
+	}
+
+	get classes() {
+		return {
+			root: {
+				"ui5-tc-root": true,
+				"ui5-tc--textOnly": this.textOnly,
+				"ui5-tc--withAdditonalText": this.withAdditonalText,
+				"ui5-tc--standardTabLayout": this.standardTabLayout,
+			},
+			header: {
+				"ui5-tc__header": true,
+				"ui5-tc__header--scrollable": this._scrollable,
+			},
+			headerInnerContainer: {
+				"ui5-tc__headerInnerContainer": true,
+			},
+			headerScrollContainer: {
+				"ui-tc__headerScrollContainer": true,
+			},
+			headerList: {
+				"ui5-tc__headerList": true,
+			},
+			separator: {
+				"ui5-tc__separator": true,
+			},
+			headerBackArrow: {
+				"ui5-tc__headerArrow": true,
+				"ui5-tc__headerArrowLeft": true,
+				"ui5-tc__headerArrow--visible": this._scrollableBack,
+			},
+			headerForwardArrow: {
+				"ui5-tc__headerArrow": true,
+				"ui5-tc__headerArrowRight": true,
+				"ui5-tc__headerArrow--visible": this._scrollableForward,
+			},
+			content: {
+				"ui5-tc__content": true,
+				"ui5-tc__content--collapsed": this._contentCollapsed,
+			},
+		};
+	}
+
+	get mixedMode() {
+		return this.items.some(item => item.icon) && this.items.some(item => item.text);
+	}
+
+	get textOnly() {
+		return this.items.every(item => !item.icon);
+	}
+
+	get withAdditonalText() {
+		return this.items.some(item => !!item.additionalText);
+	}
+
+	get standardTabLayout() {
+		return this.tabLayout === TabLayout.Standard;
+	}
+
+	get previousIconACCName() {
+		return TabContainer.i18nBundle.getText(TABCONTAINER_PREVIOUS_ICON_ACC_NAME);
+	}
+
+	get nextIconACCName() {
+		return TabContainer.i18nBundle.getText(TABCONTAINER_NEXT_ICON_ACC_NAME);
+	}
+
+	get overflowMenuTitle() {
+		return TabContainer.i18nBundle.getText(TABCONTAINER_OVERFLOW_MENU_TITLE);
+	}
+
+	get tabsAtTheBottom() {
+		return this.tabsPlacement === TabContainerTabsPlacement.Bottom;
+	}
+
+	get overflowMenuIcon() {
+		return this.tabsAtTheBottom ? "slim-arrow-up" : "slim-arrow-down";
+	}
+
+	get animate() {
+		return getAnimationMode() !== AnimationMode.None;
+	}
+
+	static get dependencies() {
+		return [
+			Button,
+			Icon,
+			List,
+			ResponsivePopover,
+		];
+	}
+
+	static async onDefine() {
+		TabContainer.i18nBundle = await getI18nBundle("@ui5/webcomponents");
+	}
+}
+
+const isTabLi = el => el.localName === "li" && el.getAttribute("role") === "tab";
+
+const getTab = el => {
+	while (el) {
+		if (isTabLi(el)) {
+			return el;
+		}
+
+		el = el.parentElement;
+	}
+
+	return false;
+};
+
+const findIndex = (arr, predicate) => {
+	for (let i = 0; i < arr.length; i++) {
+		const result = predicate(arr[i]);
+
+		if (result) {
+			return i;
+		}
+	}
+
+	return -1;
+};
+
+TabContainer.define();
+
+export default TabContainer;

package/src/TabContainerPopover.hbs

@@ -0,0 +1,24 @@
+<ui5-responsive-popover
+	id="{{_id}}-overflowMenu"
+	horizontal-align="Right"
+	placement-type="Bottom"
+	content-only-on-desktop
+	with-padding
+	hide-arrow
+	_hide-header
+	class="ui5-tab-container-responsive-popover"
+>
+	<ui5-list @ui5-item-press="{{_onOverflowListItemSelect}}">
+		{{#each items}}
+			{{#unless this.isSeparator}}
+				{{this.overflowPresentation}}
+			{{/unless}}
+		{{/each}}
+	</ui5-list>
+	<div slot="footer" class="ui5-responsive-popover-footer">
+		<ui5-button
+			design="Transparent"
+			@click="{{_closeRespPopover}}"
+		>Cancel</ui5-button>
+	</div>
+</ui5-responsive-popover>

package/src/TabInOverflow.hbs

@@ -0,0 +1,22 @@
+<ui5-li-custom
+	id="{{this._id}}"
+	class="{{this.overflowClasses}}"
+	type="{{this.overflowState}}"
+	?selected="{{this.effectiveSelected}}"
+	?disabled="{{this.effectiveDisabled}}"
+	aria-disabled="{{this.effectiveDisabled}}"
+	aria-selected="{{this.effectiveSelected}}"
+	aria-labelledby="{{this.ariaLabelledBy}}"
+>
+	<div class="ui5-tab-overflow-itemContent">
+		{{#if this.icon}}
+			<ui5-icon name="{{this.icon}}"></ui5-icon>
+		{{/if}}
+
+		{{this.text}}
+
+		{{#if this.additionalText}}
+			({{this.additionalText}})
+		{{/if}}
+	</div>
+</ui5-li-custom>