@ui5/webcomponents 0.0.0-323968e1b → 0.0.0-4180fe799

package/src/Token.js

@@ -0,0 +1,219 @@
+import UI5Element from "@ui5/webcomponents-base/dist/UI5Element.js";
+import litRender from "@ui5/webcomponents-base/dist/renderer/LitRenderer.js";
+import { getTheme } from "@ui5/webcomponents-base/dist/config/Theme.js";
+import {
+	isBackSpace,
+	isSpace,
+	isDelete,
+} from "@ui5/webcomponents-base/dist/Keys.js";
+import "@ui5/webcomponents-icons/dist/decline.js";
+import "@ui5/webcomponents-icons/dist/sys-cancel.js";
+import { getI18nBundle } from "@ui5/webcomponents-base/dist/i18nBundle.js";
+import { TOKEN_ARIA_DELETABLE } from "./generated/i18n/i18n-defaults.js";
+
+import Icon from "./Icon.js";
+import TokenTemplate from "./generated/templates/TokenTemplate.lit.js";
+
+// Styles
+import styles from "./generated/themes/Token.css.js";
+
+/**
+ * @public
+ */
+const metadata = {
+	tag: "ui5-token",
+	languageAware: true,
+	managedSlots: true,
+	properties: /** @lends sap.ui.webcomponents.main.Token.prototype */ {
+
+		/**
+		 * Defines the text of the token.
+		 *
+		 * @type {string}
+		 * @defaultvalue ""
+		 * @public
+		 */
+		text: { type: String },
+
+		/**
+		 * Defines whether the component is read-only.
+		 * <br><br>
+		 * <b>Note:</b> A read-only component can not be deleted or selected,
+		 * but still provides visual feedback upon user interaction.
+		 *
+		 * @type {boolean}
+		 * @public
+		 */
+		readonly: { type: Boolean },
+
+		/**
+		 * Set by the tokenizer when a token is in the "more" area (overflowing)
+		 * @type {boolean}
+		 * @private
+		 */
+		overflows: { type: Boolean },
+
+		/**
+		 * Defines whether the component is selected or not.
+		 *
+		 * @type {boolean}
+		 * @public
+		 */
+		selected: { type: Boolean },
+
+		/**
+		 * Defines whether the component is focused or not.
+		 *
+		 * @type {boolean}
+		 * @private
+		 */
+		focused: { type: Boolean },
+
+		/**
+		 * Defines the tabIndex of the component.
+		 * @type {string}
+		 * @private
+		 */
+		_tabIndex: { type: String, defaultValue: "-1", noAttribute: true },
+	},
+
+	slots: /** @lends  sap.ui.webcomponents.main.Token.prototype */ {
+
+		/**
+		 * Defines the close icon for the token. If nothing is provided to this slot, the default close icon will be used.
+		 * Accepts <code>ui5-icon</code>.
+		 *
+		 * @type {sap.ui.webcomponents.main.IIcon}
+		 * @slot
+		 * @public
+		 * @since 1.0.0-rc.9
+		 */
+		closeIcon: {
+			type: HTMLElement,
+		},
+	},
+
+	events: /** @lends sap.ui.webcomponents.main.Token.prototype */ {
+
+		/**
+		 * Fired when the backspace, delete or close icon of the token is pressed
+		 *
+		 * @event
+		 * @param {boolean} backSpace indicates whether token is deleted by backspace key
+		 * @param {boolean} delete indicates whether token is deleted by delete key
+		 * @private
+		 */
+		"delete": {
+			detail: {
+				"backSpace": { type: Boolean },
+				"delete": { type: Boolean },
+			},
+		},
+
+		/**
+		 * Fired when the the component is selected by user interaction with mouse or by clicking space.
+		 *
+		 * @event
+		 * @public
+		 */
+		select: {},
+	},
+};
+
+/**
+ * @class
+ *
+ * <h3 class="comment-api-title">Overview</h3>
+ *
+ * Tokens are small items of information (similar to tags) that mainly serve to visualize previously selected items.
+ *
+ * <h3>ES6 Module Import</h3>
+ *
+ * <code>import "@ui5/webcomponents/dist/Token.js";</code>
+ * @constructor
+ * @author SAP SE
+ * @alias sap.ui.webcomponents.main.Token
+ * @extends sap.ui.webcomponents.base.UI5Element
+ * @tagname ui5-token
+ * @since 1.0.0-rc.9
+ * @implements sap.ui.webcomponents.main.IToken
+ * @public
+ */
+class Token extends UI5Element {
+	static get metadata() {
+		return metadata;
+	}
+
+	static get render() {
+		return litRender;
+	}
+
+	static get template() {
+		return TokenTemplate;
+	}
+
+	static get styles() {
+		return styles;
+	}
+
+	_handleSelect() {
+		this.selected = !this.selected;
+		this.fireEvent("select");
+	}
+
+	_focusin() {
+		this.focused = true;
+	}
+
+	_focusout() {
+		this.focused = !this.focused;
+	}
+
+	 _delete() {
+		this.fireEvent("delete");
+	 }
+
+	 _keydown(event) {
+		const isBS = isBackSpace(event);
+		const isD = isDelete(event);
+
+		if (!this.readonly && (isBS || isD)) {
+			event.preventDefault();
+
+			this.fireEvent("delete", {
+				backSpace: isBS,
+				"delete": isD,
+			});
+		}
+
+		if (isSpace(event)) {
+			event.preventDefault();
+
+			this._handleSelect();
+		}
+	}
+
+	get tokenDeletableText() {
+		return Token.i18nBundle.getText(TOKEN_ARIA_DELETABLE);
+	}
+
+	get iconURI() {
+		if (getTheme().includes("sap_belize")) {
+			return "sys-cancel";
+		}
+
+		return "decline";
+	}
+
+	static get dependencies() {
+		return [Icon];
+	}
+
+	static async onDefine() {
+		Token.i18nBundle = await getI18nBundle("@ui5/webcomponents");
+	}
+}
+
+Token.define();
+
+export default Token;

package/src/Tokenizer.hbs

@@ -0,0 +1,27 @@
+<div
+	dir="{{effectiveDir}}"
+	class="{{classes.wrapper}}"
+>
+	<span id="{{_id}}-hiddenText" class="ui5-hidden-text">{{tokenizerLabel}}</span>
+
+	<div
+		class="{{classes.content}}"
+		@ui5-delete="{{_tokenDelete}}"
+		@click="{{_click}}"
+		@mousedown="{{_onmousedown}}"
+		@keydown="{{_onkeydown}}"
+		role="listbox"
+		aria-labelledby="{{_id}}-hiddenText"
+	>
+		{{#each tokens}}
+			<slot name="{{this._individualSlot}}"></slot>
+		{{/each}}
+	</div>
+
+	{{#if showNMore}}
+		<span
+			@click="{{_openOverflowPopover}}"
+			class="ui5-tokenizer-more-text"
+		>{{_nMoreText}}</span>
+	{{/if}}
+</div>

package/src/Tokenizer.js

@@ -0,0 +1,414 @@
+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 ItemNavigation from "@ui5/webcomponents-base/dist/delegate/ItemNavigation.js";
+import ScrollEnablement from "@ui5/webcomponents-base/dist/delegate/ScrollEnablement.js";
+import Integer from "@ui5/webcomponents-base/dist/types/Integer.js";
+import { getI18nBundle } from "@ui5/webcomponents-base/dist/i18nBundle.js";
+import { isSpace } from "@ui5/webcomponents-base/dist/Keys.js";
+import { isPhone } from "@ui5/webcomponents-base/dist/Device.js";
+import ValueState from "@ui5/webcomponents-base/dist/types/ValueState.js";
+import ResponsivePopover from "./ResponsivePopover.js";
+import List from "./List.js";
+import StandardListItem from "./StandardListItem.js";
+import TokenizerTemplate from "./generated/templates/TokenizerTemplate.lit.js";
+import TokenizerPopoverTemplate from "./generated/templates/TokenizerPopoverTemplate.lit.js";
+import {
+	MULTIINPUT_SHOW_MORE_TOKENS,
+	TOKENIZER_ARIA_LABEL,
+	TOKENIZER_POPOVER_REMOVE,
+	TOKENIZER_ARIA_CONTAIN_TOKEN,
+	TOKENIZER_ARIA_CONTAIN_ONE_TOKEN,
+	TOKENIZER_ARIA_CONTAIN_SEVERAL_TOKENS,
+} from "./generated/i18n/i18n-defaults.js";
+
+// Styles
+import styles from "./generated/themes/Tokenizer.css.js";
+import ResponsivePopoverCommonCss from "./generated/themes/ResponsivePopoverCommon.css.js";
+import ValueStateMessageCss from "./generated/themes/ValueStateMessage.css.js";
+
+// reuse suggestions focus styling for NMore popup
+import SuggestionsCss from "./generated/themes/Suggestions.css.js";
+
+/**
+ * @public
+ */
+const metadata = {
+	tag: "ui5-tokenizer",
+	languageAware: true,
+	managedSlots: true,
+	slots: /** @lends sap.ui.webcomponents.main.Tokenizer.prototype */ {
+		"default": {
+			propertyName: "tokens",
+			type: HTMLElement,
+			individualSlots: true,
+		},
+		"valueStateMessage": {
+			propertyName: "valueStateMessage",
+			type: HTMLElement,
+		},
+	},
+	properties: /** @lends sap.ui.webcomponents.main.Tokenizer.prototype */ {
+		showMore: { type: Boolean },
+
+		disabled: { type: Boolean },
+
+		/**
+		 * Indicates if the tokenizer should show all tokens or n more label instead
+		 *
+		 * @private
+		 */
+		expanded: { type: Boolean },
+
+		morePopoverOpener: { type: Object },
+
+		popoverMinWidth: {
+			type: Integer,
+		},
+
+		/**
+		 * Indicates the value state of the related input component.
+		 *
+		 * @type {ValueState}
+		 * @defaultvalue "None"
+		 * @private
+		 */
+		valueState: {
+			type: ValueState,
+			defaultValue: ValueState.None,
+		},
+
+		_nMoreCount: { type: Integer },
+	},
+	events: /** @lends sap.ui.webcomponents.main.Tokenizer.prototype */ {
+		"token-delete": {
+			detail: {
+				ref: { type: HTMLElement },
+			},
+		},
+
+		"show-more-items-press": {
+			detail: {
+				ref: { type: HTMLElement },
+			},
+		},
+	},
+};
+
+/**
+ * @class
+ *
+ * <h3 class="comment-api-title">Overview</h3>
+ *
+ * A container for tokens.
+ *
+ * @constructor
+ * @author SAP SE
+ * @alias sap.ui.webcomponents.main.Tokenizer
+ * @extends UI5Element
+ * @tagname ui5-tokenizer
+ * @usestextcontent
+ * @private
+ */
+class Tokenizer extends UI5Element {
+	static get metadata() {
+		return metadata;
+	}
+
+	static get render() {
+		return litRender;
+	}
+
+	static get template() {
+		return TokenizerTemplate;
+	}
+
+	static get styles() {
+		return styles;
+	}
+
+	static get staticAreaStyles() {
+		return [ResponsivePopoverCommonCss, ValueStateMessageCss, SuggestionsCss];
+	}
+
+	static get staticAreaTemplate() {
+		return TokenizerPopoverTemplate;
+	}
+
+	_handleResize() {
+		this._nMoreCount = this.overflownTokens.length;
+	}
+
+	constructor() {
+		super();
+
+		this._resizeHandler = this._handleResize.bind(this);
+
+		this._itemNav = new ItemNavigation(this, {
+			currentIndex: "-1",
+			getItemsCallback: this._getVisibleTokens.bind(this),
+		});
+
+		this._scrollEnablement = new ScrollEnablement(this);
+	}
+
+	async onBeforeRendering() {
+		if (this.showPopover && !this._getTokens().length) {
+			const popover = await this.getPopover();
+			popover.close();
+		}
+
+		this._nMoreCount = this.overflownTokens.length;
+	}
+
+	onEnterDOM() {
+		ResizeHandler.register(this.shadowRoot.querySelector(".ui5-tokenizer--content"), this._resizeHandler);
+	}
+
+	onExitDOM() {
+		ResizeHandler.deregister(this.shadowRoot.querySelector(".ui5-tokenizer--content"), this._resizeHandler);
+	}
+
+	async _openOverflowPopover() {
+		if (this.showPopover) {
+			const popover = await this.getPopover();
+
+			popover.showAt(this.morePopoverOpener || this);
+		}
+
+		this.fireEvent("show-more-items-press");
+	}
+
+	_getTokens() {
+		return this.getSlottedNodes("tokens");
+	}
+
+	get _tokens() {
+		return this.getSlottedNodes("tokens");
+	}
+
+	get showPopover() {
+		return Object.keys(this.morePopoverOpener).length;
+	}
+
+	_getVisibleTokens() {
+		if (this.disabled) {
+			return [];
+		}
+
+		return this._tokens.filter((token, index) => {
+			return index < (this._tokens.length - this._nMoreCount);
+		});
+	}
+
+	onAfterRendering() {
+		this._scrollEnablement.scrollContainer = this.expanded ? this.contentDom : this;
+	}
+
+	_tokenDelete(event) {
+		let nextTokenIndex; // The index of the next token that needs to be focused next due to the deletion
+		const deletedTokenIndex = this._getVisibleTokens().indexOf(event.target); // The index of the token that just got deleted
+
+		if (event.detail && event.detail.backSpace) { // on backspace key select the previous item (unless deleting the first)
+			nextTokenIndex = deletedTokenIndex === 0 ? deletedTokenIndex + 1 : deletedTokenIndex - 1;
+		} else { // on delete key or mouse click on the "x" select the next item (unless deleting the last)
+			nextTokenIndex = deletedTokenIndex === this._getVisibleTokens().length - 1 ? deletedTokenIndex - 1 : deletedTokenIndex + 1;
+		}
+		const nextToken = this._getVisibleTokens()[nextTokenIndex]; // if the last item was deleted this will be undefined
+
+		if (nextToken && !isPhone()) {
+			this._itemNav.setCurrentItem(nextToken); // update the item navigation with the new token or undefined, if the last was deleted
+
+			setTimeout(() => {
+				nextToken.focus();
+			}, 0);
+		}
+
+		this.fireEvent("token-delete", { ref: event.target });
+	}
+
+	itemDelete(event) {
+		const token = event.detail.item.tokenRef;
+
+		this.fireEvent("token-delete", { ref: token });
+	}
+
+	_onkeydown(event) {
+		if (isSpace(event)) {
+			event.preventDefault();
+
+			this._handleTokenSelection(event);
+		}
+	}
+
+	_click(event) {
+		this._handleTokenSelection(event);
+	}
+
+	_onmousedown(event) {
+		this._itemNav.setCurrentItem(event.target);
+	}
+
+	_handleTokenSelection(event) {
+		if (event.target.localName === "ui5-token") {
+			this._tokens.forEach(token => {
+				if (token !== event.target) {
+					token.selected = false;
+				}
+			});
+		}
+	}
+
+	/**
+	 * Scrolls the container of the tokens to its beginning.
+	 * This method is used by MultiInput and MultiComboBox.
+	 * @private
+	 */
+	scrollToStart() {
+		this.contentDom.scrollLeft = 0;
+	}
+
+	async closeMorePopover() {
+		const popover = await this.getPopover();
+
+		popover.close();
+	}
+
+	get _nMoreText() {
+		return Tokenizer.i18nBundle.getText(MULTIINPUT_SHOW_MORE_TOKENS, this._nMoreCount);
+	}
+
+	get showNMore() {
+		return !this.expanded && this.showMore && this.overflownTokens.length;
+	}
+
+	get contentDom() {
+		return this.shadowRoot.querySelector(".ui5-tokenizer--content");
+	}
+
+	get tokenizerLabel() {
+		return Tokenizer.i18nBundle.getText(TOKENIZER_ARIA_LABEL);
+	}
+
+	get morePopoverTitle() {
+		return Tokenizer.i18nBundle.getText(TOKENIZER_POPOVER_REMOVE);
+	}
+
+	get overflownTokens() {
+		if (!this.contentDom) {
+			return [];
+		}
+
+		return this._getTokens().filter(token => {
+			const isRTL = this.effectiveDir === "rtl";
+			const elementEnd = isRTL ? "left" : "right";
+			const parentRect = this.contentDom.getBoundingClientRect();
+			const tokenRect = token.getBoundingClientRect();
+			const tokenEnd = tokenRect[elementEnd];
+			const parentEnd = parentRect[elementEnd];
+
+			token.overflows = isRTL ? ((tokenEnd < parentEnd) && !this.expanded) : ((tokenEnd > parentEnd) && !this.expanded);
+
+			return token.overflows;
+		});
+	}
+
+	get hasValueState() {
+		return this.valueState === ValueState.None || this.valueState === ValueState.Success;
+	}
+
+	get valueStateMessageText() {
+		return this.getSlottedNodes("valueStateMessage").map(el => el.cloneNode(true));
+	}
+
+	get _isPhone() {
+		return isPhone();
+	}
+
+	get classes() {
+		return {
+			wrapper: {
+				"ui5-tokenizer-root": true,
+				"ui5-tokenizer-nmore--wrapper": this.showMore,
+				"ui5-tokenizer-no-padding": !this._getTokens().length,
+			},
+			content: {
+				"ui5-tokenizer--content": true,
+				"ui5-tokenizer-nmore--content": this.showMore,
+			},
+			popoverValueState: {
+				"ui5-valuestatemessage-root": true,
+				"ui5-responsive-popover-header": this.showPopover,
+				"ui5-valuestatemessage--success": this.valueState === ValueState.Success,
+				"ui5-valuestatemessage--error": this.valueState === ValueState.Error,
+				"ui5-valuestatemessage--warning": this.valueState === ValueState.Warning,
+				"ui5-valuestatemessage--information": this.valueState === ValueState.Information,
+			},
+		};
+	}
+
+	get styles() {
+		return {
+			popover: {
+				"min-width": `${this.popoverMinWidth}px`,
+			},
+			popoverValueStateMessage: {
+				"width": isPhone() ? "100%" : `${this.popoverMinWidth}px`,
+				"min-height": "2rem",
+			},
+			popoverHeader: {
+				"min-height": "2rem",
+			},
+			popoverHeaderTitle: {
+				"justify-content": "left",
+			},
+		};
+	}
+
+	_tokensCountText() {
+		const iTokenCount = this._getTokens().length;
+
+		if (iTokenCount === 0) {
+			return Tokenizer.i18nBundle.getText(TOKENIZER_ARIA_CONTAIN_TOKEN);
+		}
+
+		if (iTokenCount === 1) {
+			return Tokenizer.i18nBundle.getText(TOKENIZER_ARIA_CONTAIN_ONE_TOKEN);
+		}
+
+		return Tokenizer.i18nBundle.getText(TOKENIZER_ARIA_CONTAIN_SEVERAL_TOKENS, iTokenCount);
+	}
+
+	/**
+	 * @protected
+	 */
+	_focusLastToken() {
+		if (this.tokens.length === 0) {
+			return;
+		}
+
+		const lastToken = this.tokens[this.tokens.length - 1];
+		lastToken.focus();
+		this._itemNav.setCurrentItem(lastToken);
+	}
+
+	static get dependencies() {
+		return [
+			ResponsivePopover,
+			List,
+			StandardListItem,
+		];
+	}
+
+	static async onDefine() {
+		Tokenizer.i18nBundle = await getI18nBundle("@ui5/webcomponents");
+	}
+
+	async getPopover() {
+		return (await this.getStaticAreaItemDomRef()).querySelector("[ui5-responsive-popover]");
+	}
+}
+
+Tokenizer.define();
+
+export default Tokenizer;

package/src/TokenizerPopover.hbs

@@ -0,0 +1,50 @@
+<ui5-responsive-popover
+	tokenizer-popover="true"
+	style={{styles.popover}}
+	header-text={{morePopoverTitle}}
+	?content-only-on-desktop="{{hasValueState}}"
+	hide-arrow
+	placement-type="Bottom"
+	horizontal-align="Left"
+>
+	{{#unless hasValueState}}
+		<div slot="header" class="ui5-responsive-popover-header" style="{{styles.popoverHeader}}">
+			{{#if _isPhone}}
+				<div class="row" style="{{styles.popoverHeaderTitle}}">
+					<ui5-title level="H5" class="ui5-responsive-popover-header-text">Remove</ui5-title>
+					<ui5-button
+						class="ui5-responsive-popover-close-btn"
+						icon="decline"
+						design="Transparent"
+						@click="{{closeMorePopover}}"
+					>
+					</ui5-button>
+				</div>
+			{{/if}}
+			<div class="{{classes.popoverValueState}}" style="{{styles.popoverValueStateMessage}}">
+				{{#each valueStateMessageText}}
+					{{this}}
+				{{/each}}
+			</div>
+		</div>
+	{{/unless}}
+	<ui5-list
+		class="ui5-tokenizer-list"
+		mode="Delete"
+		@ui5-item-delete={{itemDelete}}
+	>
+		{{#each _tokens}}
+			<ui5-li .tokenRef={{this}}>
+				{{this.text}}
+			</ui5-li>
+		{{/each}}
+	</ui5-list>
+	{{#if _isPhone}}
+		<div slot="footer" class="ui5-responsive-popover-footer">
+			<ui5-button
+				design="Transparent"
+				@click="{{closeMorePopover}}"
+			>OK</ui5-button>
+		</div>
+	{{/if}}
+</ui5-responsive-popover>