@ui5/webcomponents 0.0.0-8db0ce01a → 0.0.0-a3eca7ade

package/src/features/InputSuggestions.js

@@ -1,10 +1,14 @@
 import { registerFeature } from "@ui5/webcomponents-base/dist/FeaturesRegistry.js";
 import { getI18nBundle } from "@ui5/webcomponents-base/dist/i18nBundle.js";
-
+import encodeXML from "@ui5/webcomponents-base/dist/sap/base/security/encodeXML.js";
+import generateHighlightedMarkup from "@ui5/webcomponents-base/dist/util/generateHighlightedMarkup.js";
 import List from "../List.js";
 import ResponsivePopover from "../ResponsivePopover.js";
 import SuggestionItem from "../SuggestionItem.js";
+import SuggestionGroupItem from "../SuggestionGroupItem.js";
 import Button from "../Button.js";
+import Icon from "../Icon.js";
+import Popover from "../Popover.js";
 import GroupHeaderListItem from "../GroupHeaderListItem.js";
 import SuggestionListItem from "../SuggestionListItem.js";
 
@@ -39,12 +43,12 @@ class Suggestions {
 		this.fnOnSuggestionItemMouseOver = this.onItemMouseOver.bind(this);
 		this.fnOnSuggestionItemMouseOut = this.onItemMouseOut.bind(this);
 
+		this._getSuggestionPopover();
+
 		// An integer value to store the currently selected item position,
 		// that changes due to user interaction.
 		this.selectedItemIndex = null;
 
-		this.i18nBundle = getI18nBundle("@ui5/webcomponents");
-
 		this.accInfo = {};
 	}
 
@@ -64,9 +68,9 @@ class Suggestions {
 				image: suggestion.image || undefined,
 				icon: suggestion.icon || undefined,
 				type: suggestion.type || undefined,
-				info: suggestion.info || undefined,
-				infoState: suggestion.infoState,
-				group: suggestion.group,
+				additionalText: suggestion.additionalText || undefined,
+				additionalTextState: suggestion.additionalTextState,
+				groupItem: suggestion.groupItem,
 				key: idx,
 			});
 		});
@@ -96,10 +100,82 @@ class Suggestions {
 	}
 
 	onEnter(event) {
+		if (this._isGroupOrInactiveItem) {
+			event.preventDefault();
+			return false;
+		}
+
 		if (this._isItemOnTarget()) {
 			this.onItemSelected(null, true /* keyboardUsed */);
 			return true;
 		}
+
+		return false;
+	}
+
+	onPageUp(event) {
+		event.preventDefault();
+
+		const isItemIndexValid = this.selectedItemIndex - 10 > -1;
+
+		if (this._hasValueState && !isItemIndexValid) {
+			this._focusValueState();
+			return true;
+		}
+
+		this._moveItemSelection(this.selectedItemIndex,
+			isItemIndexValid ? this.selectedItemIndex -= 10 : this.selectedItemIndex = 0);
+		return true;
+	}
+
+	onPageDown(event) {
+		event.preventDefault();
+
+		const items = this._getItems();
+		const lastItemIndex = items.length - 1;
+		const isItemIndexValid = this.selectedItemIndex + 10 <= lastItemIndex;
+
+		if (this._hasValueState && !items) {
+			this._focusValueState();
+			return true;
+		}
+
+		this._moveItemSelection(this.selectedItemIndex,
+			isItemIndexValid ? this.selectedItemIndex += 10 : this.selectedItemIndex = lastItemIndex);
+		return true;
+	}
+
+	onHome(event) {
+		event.preventDefault();
+
+		if (this._hasValueState) {
+			this._focusValueState();
+			return true;
+		}
+
+		this._moveItemSelection(this.selectedItemIndex, this.selectedItemIndex = 0);
+		return true;
+	}
+
+	onEnd(event) {
+		event.preventDefault();
+
+		const lastItemIndex = this._getItems().length - 1;
+
+		if (this._hasValueState && !lastItemIndex) {
+			this._focusValueState();
+			return true;
+		}
+
+		this._moveItemSelection(this.selectedItemIndex, this.selectedItemIndex = lastItemIndex);
+		return true;
+	}
+
+	onTab(event) {
+		if (this._isItemOnTarget()) {
+			this.onItemSelected(null, true);
+			return true;
+		}
 		return false;
 	}
 
@@ -119,17 +195,22 @@ class Suggestions {
 	}
 
 	async open() {
-		this.responsivePopover = await this._respPopover();
+		this._getComponent().open = true;
 		this._beforeOpen();
 
-		if (this._getItems().length) {
-			this.responsivePopover.open(this._getComponent());
-		}
+		this.responsivePopover.showAt(this._getComponent());
 	}
 
 	async close(preventFocusRestore = false) {
-		this.responsivePopover = await this._respPopover();
+		const selectedItem = this._getItems() && this._getItems()[this.selectedItemIndex];
+
+		this._getComponent().open = false;
+		this.responsivePopover = await this._getSuggestionPopover();
 		this.responsivePopover.close(false, false, preventFocusRestore);
+
+		if (selectedItem && selectedItem.focused) {
+			selectedItem.focused = false;
+		}
 	}
 
 	updateSelectedItemPosition(pos) {
@@ -163,17 +244,14 @@ class Suggestions {
 
 		// If the item is "Inactive", prevent selection with SPACE or ENTER
 		// to have consistency with the way "Inactive" items behave in the ui5-list
-		if (item.type === "Inactive") {
-			return;
-		}
-
-		if (item.group) {
+		if (item.type === "Inactive" || item.group) {
 			return;
 		}
 
 		this._getComponent().onItemSelected(this._getRealItems()[this.selectedItemIndex], keyboardUsed);
 		item.selected = false;
-		this.close();
+		item.focused = false;
+		this._getComponent().open = false;
 	}
 
 	onItemPreviewed(item) {
@@ -182,7 +260,7 @@ class Suggestions {
 
 	/* Private methods */
 	onItemPress(oEvent) {
-		this.onItemSelected(oEvent.detail.item, false /* keyboardUsed */);
+		this.onItemSelected(oEvent.detail.selectedItems[0], false /* keyboardUsed */);
 	}
 
 	_beforeOpen() {
@@ -192,8 +270,8 @@ class Suggestions {
 
 	async _attachItemsListeners() {
 		const list = await this._getList();
-		list.removeEventListener("ui5-item-press", this.fnOnSuggestionItemPress);
-		list.addEventListener("ui5-item-press", this.fnOnSuggestionItemPress);
+		list.removeEventListener("ui5-selection-change", this.fnOnSuggestionItemPress);
+		list.addEventListener("ui5-selection-change", this.fnOnSuggestionItemPress);
 		list.removeEventListener("ui5-item-focused", this.fnOnSuggestionItemFocus);
 		list.addEventListener("ui5-item-focused", this.fnOnSuggestionItemFocus);
 		list.removeEventListener("mouseover", this.fnOnSuggestionItemMouseOver);
@@ -208,12 +286,12 @@ class Suggestions {
 		}
 
 		if (!this.attachedAfterOpened) {
-			this._respPopover.addEventListener("ui5-after-open", this._onOpen.bind(this));
+			this._getSuggestionPopover.addEventListener("ui5-after-open", this._onOpen.bind(this));
 			this.attachedAfterOpened = true;
 		}
 
 		if (!this.attachedAfterClose) {
-			this._respPopover.addEventListener("ui5-after-close", this._onClose.bind(this));
+			this._getSuggestionPopover.addEventListener("ui5-after-close", this._onClose.bind(this));
 			this.attachedAfterClose = true;
 		}
 	}
@@ -234,7 +312,17 @@ class Suggestions {
 	}
 
 	_isItemOnTarget() {
-		return this.isOpened() && this.selectedItemIndex !== null;
+		return this.isOpened() && this.selectedItemIndex !== null && this.selectedItemIndex !== -1 && !this._isGroupOrInactiveItem;
+	}
+
+	get _isGroupOrInactiveItem() {
+		const items = this._getItems();
+
+		if (!items || !items[this.selectedItemIndex]) {
+			return false;
+		}
+
+		return (items[this.selectedItemIndex].group || items[this.selectedItemIndex].type === "Inactive");
 	}
 
 	isOpened() {
@@ -257,22 +345,61 @@ class Suggestions {
 		const itemsCount = this._getItems().length;
 		const previousSelectedIdx = this.selectedItemIndex;
 
-		if ((this.selectedItemIndex === null) || (++this.selectedItemIndex > itemsCount - 1)) {
-			this.selectedItemIndex = 0;
+		if (this._hasValueState && previousSelectedIdx === null && !this.component._isValueStateFocused) {
+			this._focusValueState();
+			return;
+		}
+
+		if ((previousSelectedIdx === null && !this._hasValueState) || this.component._isValueStateFocused) {
+			this._clearValueStateFocus();
+			--this.selectedItemIndex;
 		}
 
-		this._moveItemSelection(previousSelectedIdx, this.selectedItemIndex);
+		if (previousSelectedIdx !== null && previousSelectedIdx + 1 > itemsCount - 1) {
+			return;
+		}
+
+		this._moveItemSelection(previousSelectedIdx, ++this.selectedItemIndex);
 	}
 
 	_selectPreviousItem() {
-		const itemsCount = this._getItems().length;
+		const items = this._getItems();
 		const previousSelectedIdx = this.selectedItemIndex;
 
-		if ((this.selectedItemIndex === null) || (--this.selectedItemIndex < 0)) {
-			this.selectedItemIndex = itemsCount - 1;
+		if (this._hasValueState && previousSelectedIdx === 0 && !this.component._isValueStateFocused) {
+			this.component.hasSuggestionItemSelected = false;
+			this.component._isValueStateFocused = true;
+			this.selectedItemIndex = null;
+
+			items[0].focused = false;
+			items[0].selected = false;
+
+			return;
+		}
+
+		if (this.component._isValueStateFocused) {
+			this.component.focused = true;
+			this.component._isValueStateFocused = false;
+			this.selectedItemIndex = null;
+
+			return;
+		}
+
+		if (previousSelectedIdx === -1 || previousSelectedIdx === null) {
+			return;
 		}
 
-		this._moveItemSelection(previousSelectedIdx, this.selectedItemIndex);
+		if (previousSelectedIdx - 1 < 0) {
+			items[previousSelectedIdx].selected = false;
+			items[previousSelectedIdx].focused = false;
+
+			this.component.focused = true;
+			this.component.hasSuggestionItemSelected = false;
+			this.selectedItemIndex -= 1;
+			return;
+		}
+
+		this._moveItemSelection(previousSelectedIdx, --this.selectedItemIndex);
 	}
 
 	_moveItemSelection(previousIdx, nextIdx) {
@@ -280,6 +407,13 @@ class Suggestions {
 		const currentItem = items[nextIdx];
 		const previousItem = items[previousIdx];
 
+		if (!currentItem) {
+			return;
+		}
+
+		this.component.focused = false;
+		this._clearValueStateFocus();
+
 		this.accInfo = {
 			currentPos: nextIdx + 1,
 			listSize: items.length,
@@ -288,16 +422,22 @@ class Suggestions {
 
 		if (previousItem) {
 			previousItem.selected = false;
+			previousItem.focused = false;
 		}
 
 		if (currentItem) {
-			currentItem.selected = true;
+			currentItem.focused = true;
+
+			if (currentItem.type === "Active") {
+				currentItem.selected = true;
+			}
 
 			if (this.handleFocus) {
 				currentItem.focus();
 			}
 		}
 
+		this.component.hasSuggestionItemSelected = true;
 		this.onItemPreviewed(currentItem);
 
 		if (!this._isItemIntoView(currentItem)) {
@@ -309,9 +449,18 @@ class Suggestions {
 		const items = this._getItems();
 		items.forEach(item => {
 			item.selected = false;
+			item.focused = false;
 		});
 	}
 
+	_clearItemFocus() {
+		const focusedItem = this._getItems().find(item => item.focused);
+
+		if (focusedItem) {
+			focusedItem.focused = false;
+		}
+	}
+
 	_isItemIntoView(item) {
 		const rectItem = item.getDomRef().getBoundingClientRect();
 		const rectInput = this._getComponent().getDomRef().getBoundingClientRect();
@@ -328,7 +477,7 @@ class Suggestions {
 
 	async _getScrollContainer() {
 		if (!this._scrollContainer) {
-			await this._respPopover();
+			await this._getSuggestionPopover();
 			this._scrollContainer = this.responsivePopover.shadowRoot.querySelector(".ui5-popup-content");
 		}
 
@@ -336,7 +485,7 @@ class Suggestions {
 	}
 
 	_getItems() {
-		return [...this.responsivePopover.querySelector("[ui5-list]").children];
+		return !!this.responsivePopover && [...this.responsivePopover.querySelector("[ui5-list]").children];
 	}
 
 	_getComponent() {
@@ -344,7 +493,7 @@ class Suggestions {
 	}
 
 	async _getList() {
-		this.responsivePopover = await this._respPopover();
+		this.responsivePopover = await this._getSuggestionPopover();
 		return this.responsivePopover.querySelector("[ui5-list]");
 	}
 
@@ -357,7 +506,7 @@ class Suggestions {
 		return this._getComponent().getSlottedNodes(this.slotName);
 	}
 
-	async _respPopover() {
+	async _getSuggestionPopover() {
 		if (this.responsivePopover) {
 			return this.responsivePopover;
 		}
@@ -368,9 +517,8 @@ class Suggestions {
 	}
 
 	get itemSelectionAnnounce() {
-		const i18nBundle = this.i18nBundle,
-			itemPositionText = i18nBundle.getText(LIST_ITEM_POSITION, [this.accInfo.currentPos], [this.accInfo.listSize]),
-			itemSelectionText = i18nBundle.getText(LIST_ITEM_SELECTED);
+		const itemPositionText = Suggestions.i18nBundle.getText(LIST_ITEM_POSITION, this.accInfo.currentPos, this.accInfo.listSize),
+			itemSelectionText = Suggestions.i18nBundle.getText(LIST_ITEM_SELECTED);
 
 		return `${itemPositionText} ${this.accInfo.itemText} ${itemSelectionText}`;
 	}
@@ -386,43 +534,60 @@ class Suggestions {
 	}
 
 	getHighlightedText(suggestion, input) {
-		let text = suggestion.text || suggestion.textContent;
-		text = this.sanitizeText(text);
-
+		const text = suggestion.text || suggestion.textContent;
 		return this.hightlightInput(text, input);
 	}
 
 	getHighlightedDesc(suggestion, input) {
-		let text = suggestion.description;
-		text = this.sanitizeText(text);
-
+		const text = suggestion.description || "";
 		return this.hightlightInput(text, input);
 	}
 
 	hightlightInput(text, input) {
-		if (!text) {
-			return text;
-		}
-
-		const inputEscaped = input.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
-		const regEx = new RegExp(inputEscaped, "ig");
-		return text.replace(regEx, match => `<b>${match}</b>`);
+		return generateHighlightedMarkup(text, input);
 	}
 
 	sanitizeText(text) {
-		return text && text.replace("<", "&lt");
+		return encodeXML(text);
+	}
+
+	get _hasValueState() {
+		return this.component.hasValueStateMessage;
+	}
+
+	_focusValueState() {
+		const items = this._getItems();
+
+		this.component._isValueStateFocused = true;
+		this.component.focused = false;
+		this.component.hasSuggestionItemSelected = false;
+		this.selectedItemIndex = null;
+
+		items && this._scrollItemIntoView(items[0]);
+		this._deselectItems();
+	}
+
+	_clearValueStateFocus() {
+		this.component._isValueStateFocused = false;
 	}
 
 	static get dependencies() {
 		return [
 			SuggestionItem,
+			SuggestionGroupItem,
 			ResponsivePopover,
 			List,
 			SuggestionListItem,
 			GroupHeaderListItem,
 			Button,
+			Icon,
+			Popover,
 		];
 	}
+
+	static async init() {
+		Suggestions.i18nBundle = await getI18nBundle("@ui5/webcomponents");
+	}
 }
 
 Suggestions.SCROLL_STEP = 60;

package/src/i18n/messagebundle.properties

@@ -16,9 +16,33 @@ ARIA_ROLEDESCRIPTION_INTERACTIVE_CARD_HEADER=Interactive Card Header
 #XACT: ARIA announcement for the Avatar default tooltip
 AVATAR_TOOLTIP=Avatar
 
+#XACT: ARIA announcement for the Avatar default tooltip
+AVATAR_GROUP_DISPLAYED_HIDDEN_LABEL={0} displayed, {1} hidden.
+
+#XACT: ARIA announcement for the Avatar default tooltip
+AVATAR_GROUP_SHOW_COMPLETE_LIST_LABEL=Activate for complete list.
+
+#XACT: ARIA announcement for the AvatarGroup type Individual aria-label attribute
+AVATAR_GROUP_ARIA_LABEL_INDIVIDUAL=Individual avatars.
+
+#XACT: ARIA announcement for the AvatarGroup type Group aria-label attribute
+AVATAR_GROUP_ARIA_LABEL_GROUP=Conjoined avatars.
+
+#XACT: ARIA announcement for the navigation in AvatarGroup
+AVATAR_GROUP_MOVE=Press ARROW keys to move.
+
 #XACT: ARIA announcement for the badge
 BADGE_DESCRIPTION=Badge
 
+#XACT: ARIA announcement for the breadcrumbs
+BREADCRUMBS_ARIA_LABEL=Breadcrumb Trail
+
+#XACT: ARIA announcement for the breadcrumbs overflow button
+BREADCRUMBS_OVERFLOW_ARIA_LABEL=More
+
+#XFLD: Breadcrumbs popover cancel button
+BREADCRUMBS_CANCEL_BUTTON=Cancel
+
 #XTOL: text that could be show if BusyIndicator is active
 BUSY_INDICATOR_TITLE=Please wait
 
@@ -46,6 +70,9 @@ CAROUSEL_NEXT_ARROW_TEXT=Next Page
 #XFLD: Label of the container holding the colors
 COLORPALETTE_CONTAINER_LABEL=Color palette - Predefined colors
 
+#XFLD: Title of the popup holding the colors
+COLORPALETTE_POPOVER_TITLE=Color Palette
+
 #XFLD: Label of the color box
 COLORPALETTE_COLOR_LABEL=Color
 
@@ -112,15 +139,48 @@ LIST_ITEM_POSITION=List item {0} of {1}
 #XACT: ARIA announcement for the list item selection.
 LIST_ITEM_SELECTED=Selected
 
+#XACT: ARIA announcement for the list item selected=false state
+LIST_ITEM_NOT_SELECTED=Not Selected
+
 #XBUT: List Multi Selection Mode Checkbox aria-label text
 ARIA_LABEL_LIST_ITEM_CHECKBOX = Multiple Selection mode.
 
+#XBUT: List Single Selection Mode RadioButton aria-label text
+ARIA_LABEL_LIST_ITEM_RADIO_BUTTON=Item Selection.
+
+#XACT: ARIA announcement for the list which allows single selections
+ARIA_LABEL_LIST_SELECTABLE=Contains Selectable Items
+
+#XACT: ARIA announcement for the list which allows multiple selections
+ARIA_LABEL_LIST_MULTISELECTABLE=Contains Multi-Selectable Items
+
+#XACT: ARIA announcement for the list which has deletable items
+ARIA_LABEL_LIST_DELETABLE=Contains Deletable Items
+
 #XTOL: Tooltip of messgae strip close button
-MESSAGE_STRIP_CLOSE_BUTTON=Message Strip Close
+MESSAGE_STRIP_CLOSE_BUTTON=Information Bar Close
+
+#XACT: ARIA announcement for the MessageStrip's closable state
+MESSAGE_STRIP_CLOSABLE=Closable
+
+#XACT: ARIA announcement for the MessageStrip's "Error" state
+MESSAGE_STRIP_ERROR=Error Information Bar
+
+#XACT: ARIA announcement for the MessageStrip's "Warning" state
+MESSAGE_STRIP_WARNING=Warning Information Bar
+
+#XACT: ARIA announcement for the MessageStrip's "Success" state
+MESSAGE_STRIP_SUCCESS=Success Information Bar
+
+#XACT: ARIA announcement for the MessageStrip's "Information" state
+MESSAGE_STRIP_INFORMATION=Information Bar
 
 #XFLD: MultiComboBox dialog button
 MULTICOMBOBOX_DIALOG_OK_BUTTON=OK
 
+#XMSG: Text used for value state error message when an item is already selected
+VALUE_STATE_ERROR_ALREADY_SELECTED=This value is already selected.
+
 #XBUT: MultiInput aria-roledescription text
 MULTIINPUT_ROLEDESCRIPTION_TEXT=Multi Value Input
 
@@ -149,7 +209,13 @@ RATING_INDICATOR_TEXT=Rating Indicator
 RESPONSIVE_POPOVER_CLOSE_DIALOG_BUTTON=Decline
 
 #XACT: ARIA description for the segmented button
-SEGMENTEDBUTTON_ARIA_DESCRIPTION=Segmented button
+SEGMENTEDBUTTON_ARIA_DESCRIPTION=Segmented button group
+
+#XACT: ARIA described by for the segmented button
+SEGMENTEDBUTTON_ARIA_DESCRIBEDBY=Press SPACE or ENTER to select an item
+
+#XACT: ARIA description for the segmented button item
+SEGMENTEDBUTTONITEM_ARIA_DESCRIPTION=Segmented button
 
 #XACT: ARIA description for slider handle
 SLIDER_ARIA_DESCRIPTION=Slider handle
@@ -166,6 +232,12 @@ LOAD_MORE_TEXT=More
 #XTXT Table's header row text.
 TABLE_HEADER_ROW_TEXT=Header Row
 
+#XACT Table row's position
+TABLE_ROW_POSITION={0} of {1}
+
+#XACT Table group row's aria label
+TABLE_GROUP_ROW_ARIA_LABEL=Group header row.
+
 #XACT ARIA label for selection checkbox
 ARIA_LABEL_ROW_SELECTION=Item selection
 
@@ -181,6 +253,12 @@ TABCONTAINER_PREVIOUS_ICON_ACC_NAME=Previous
 #XACT: ACC overflow menu title in tab container
 TABCONTAINER_OVERFLOW_MENU_TITLE=Overflow Menu
 
+#XTXT Text for end overflow button in tab container
+TABCONTAINER_END_OVERFLOW=More
+
+#XBUT Text for cancel button, which closes the popover on mobile devices
+TABCONTAINER_POPOVER_CANCEL_BUTTON=Cancel
+
 #XTXT: Text for characters left
 TEXTAREA_CHARACTERS_LEFT={0} characters remaining
 
@@ -205,6 +283,12 @@ TIMEPICKER_SUBMIT_BUTTON=OK
 #XFLD: Timepicker popover button
 TIMEPICKER_CANCEL_BUTTON=Cancel
 
+#XACT: Aria information for the Time Picker
+TIMEPICKER_INPUT_DESCRIPTION=Time Input
+
+#XACT: Aria information for the Duration Picker
+DURATION_INPUT_DESCRIPTION=Duration Input
+
 #XFLD: DateTimePicker popover button
 DATETIME_PICKER_DATE_BUTTON=Date
 
@@ -270,3 +354,10 @@ STEPINPUT_DEC_ICON_TITLE=Decrease
 
 #XTOL: tooltip for increase button of the StepInput
 STEPINPUT_INC_ICON_TITLE=Increase
+
+#XACT: Aria information for the Split Button
+SPLIT_BUTTON_DESCRIPTION=Split Button
+
+#XACT: Aria hint for the keyboard handling support of the Split Button
+SPLIT_BUTTON_KEYBOARD_HINT=Press Space or Enter to trigger default action and Alt + Arrow Down or F4 to trigger arrow action
+