feat(ui5-filter-item, ui5-sort-item,..): add selected filterItems to ui5-confirm event details

packages/fiori/src/FilterItem.ts

@@ -45,6 +45,15 @@ class FilterItem extends UI5Element {
 	 */
 	@slot()
 	values!: Array<FilterItemOption>;
+
+	/**
+	 * Defines a unique identifier for the component.
+	 * @default undefined
+	 * @public
+	 * @since 2.3.0
+	 */
+	@property()
+	itemKey?: string;
 }
 
 FilterItem.define();

packages/fiori/src/FilterItemOption.ts

@@ -36,6 +36,15 @@ class FilterItemOption extends UI5Element {
 	 */
 	@property({ type: Boolean })
 	selected = false;
+
+	/**
+	 * Defines a unique identifier for the component.
+	 * @default undefined
+	 * @public
+	 * @since 2.3.0
+	 */
+	@property()
+	itemKey?: string;
 }
 
 FilterItemOption.define();

packages/fiori/src/SortItem.ts

@@ -36,6 +36,15 @@ class SortItem extends UI5Element {
 	 */
 	@property({ type: Boolean })
 	selected = false;
+
+	/**
+	 * Defines a unique identifier for the component.
+	 * @default undefined
+	 * @public
+	 * @since 2.3.0
+	 */
+	@property()
+	itemKey?: string;
 }
 
 SortItem.define();

packages/fiori/src/ViewSettingsDialog.ts

@@ -66,7 +66,7 @@ type ViewSettingsDialogCancelEventDetail = VSDSettings & {
 }
 
 // Common properties for several VSDInternalSettings fields
-type VSDItem = {text?: string, selected: boolean}
+type VSDItem = {text?: string, itemKey?: string, selected: boolean}
 
 // Used for the private properties _initialSettings, _confirmedSettings and _currentSettings
 type VSDInternalSettings = {
@@ -75,6 +75,13 @@ type VSDInternalSettings = {
 	filters: Array<VSDItem & {filterOptions: Array<VSDItem>}>,
 }
 
+type FilterSelection = {
+	filterItem: VSDItem & {
+		filterOptions: Array<VSDItem>;
+	};
+	filterItemSelectedOptions: VSDItem[];
+};
+
 /**
  * @class
  * ### Overview
@@ -447,10 +454,12 @@ class ViewSettingsDialog extends UI5Element {
 			filters: this.filterItems.map(item => {
 				return {
 					text: item.text || "",
+					itemKey: item.itemKey || "",
 					selected: false,
 					filterOptions: item.values.map(optionValue => {
 						return {
 							text: optionValue.text || "",
+							itemKey: optionValue.itemKey || "",
 							selected: optionValue.selected,
 						};
 					}),
@@ -624,6 +633,7 @@ class ViewSettingsDialog extends UI5Element {
 			sortBy,
 			sortByItem,
 			filters: this.selectedFilters,
+			filterItems: this.selectedFilterItems,
 		};
 	}
 
@@ -648,6 +658,31 @@ class ViewSettingsDialog extends UI5Element {
 		return result;
 	}
 
+	get selectedFilterItems() {
+		const result: Array<FilterSelection> = [];
+
+		this._currentSettings.filters.forEach(filter => {
+			const selectedOptions: Array<VSDItem> = [];
+
+			filter.filterOptions.forEach(option => {
+				if (option.selected) {
+					selectedOptions.push(option);
+				}
+			});
+
+			if (selectedOptions.length) {
+				const filterItemObject: FilterSelection = {
+					filterItem: filter,
+					filterItemSelectedOptions: selectedOptions,
+				};
+
+				result.push(filterItemObject);
+			}
+		});
+
+		return result;
+	}
+
 	/**
 	 * If the dialog is closed by [Escape] key, do the same as if the `Cancel` button is pressed.
 	 * @param evt

packages/fiori/test/pages/ViewSettingsDialog.html

@@ -93,7 +93,40 @@ <h3> ViewSettingsDialog</h3>
 	<ui5-input id="sortByItem" style="display: none"></ui5-input>
 	<ui5-input id="sortOrder" style="display: none"></ui5-input>
 
+	<h3>ViewSettingsDialog with item-keys</h3>
+
+	<ui5-button id="btnOpenDialogWithItemKey">Show ViewSettingsDialog</ui5-button>
+	<ui5-view-settings-dialog id="vsdWithItemKey">
+		<ui5-sort-item slot="sortItems" text="Name" item-key="sortName"></ui5-sort-item>
+		<ui5-sort-item slot="sortItems" text="Position" item-key="sortPosition"></ui5-sort-item>
+		<ui5-sort-item slot="sortItems" text="Company" item-key="sortCompany"></ui5-sort-item>
+
+		<ui5-filter-item slot="filterItems" text="Category" item-key="filterCategory">
+			<ui5-filter-item-option slot="values" text="Electronics" item-key="filterOptionElectronics"></ui5-filter-item-option>
+			<ui5-filter-item-option slot="values" text="Clothing" item-key="filterOptionClothing"></ui5-filter-item-option>
+		</ui5-filter-item>
+
+		<ui5-filter-item slot="filterItems" text="Color" item-key="filterColor">
+			<ui5-filter-item-option slot="values" text="Red" item-key="filterOptionRed"></ui5-filter-item-option>
+			<ui5-filter-item-option slot="values" text="Blue" item-key="filterOptionBlue"></ui5-filter-item-option>
+		</ui5-filter-item>
+
+	</ui5-view-settings-dialog>
+
 	<script>
+		btnOpenDialogWithItemKey.addEventListener("click", function () {
+			vsdWithItemKey.open = true;
+		});
+
+		vsdWithItemKey.addEventListener("ui5-confirm", function(e) {
+			const filters = e.detail.filters || [];
+			console.log("Selected Filters: ", filters);
+			console.log("First Filter Item Key: ", e.detail.filterItems[0].filterItem.itemKey);
+			console.log("First Selected Option Text: ", e.detail.filterItems[0].filterItemSelectedOptions[0].text);
+			console.log("First Selected Option Key: ", e.detail.filterItems[0].filterItemSelectedOptions[0].itemKey);
+			alert("OK button clicked, returned info is: " + JSON.stringify(e.detail));
+		});
+
 		btnOpenDialog.addEventListener("click", function () {
 			vsd.open = true;
 		});

packages/fiori/test/specs/ViewSettingsDialog.spec.js

@@ -139,7 +139,7 @@ describe("ViewSettingsDialog general interaction", () => {
 		await viewSettingsDialog.shadow$("ui5-dialog").$(".ui5-vsd-header").$("ui5-button").click();
 
 		const sortByLiText = await viewSettingsDialog.shadow$("[sort-by]").$("ui5-li").getText();
-		assert.include(sortByLiText, "Name", "sortBy should  have an option selected");
+		assert.include(sortByLiText, "Name", "sortBy should have an option selected");
 
 		await browser.keys("Escape");
 	});
@@ -176,4 +176,36 @@ describe("ViewSettingsDialog general interaction", () => {
 
 		await browser.keys("Escape");
 	});
+
+	it("should access the same sort item via item-key, after text being changed", async () => {
+		const btnOpenDialog = await browser.$("#btnOpenDialogWithItemKey");
+		const viewSettingsDialog = await browser.$("#vsdWithItemKey");
+
+		await btnOpenDialog.click();
+
+		// Access the sort item using item-key
+		const sortItem = await viewSettingsDialog.$(`[item-key="sortCompany"]`);
+		const secondSortItemLi = await viewSettingsDialog.shadow$("[sort-by]").$$("ui5-li")[1];
+
+		// Get the text of the list item
+		let sortItemLiText = await viewSettingsDialog.shadow$("[sort-by]").$$("ui5-li")[2].getText();
+		sortItemLiText = sortItemLiText.split("\n")[0]; // Trim the text because it returns 'Company\nNot Selected';
+
+		let sortItemText = await sortItem.getAttribute("text");
+
+		assert.strictEqual(sortItemLiText, sortItemText, "The sort item text is the same as the li text before update");
+
+		// Change the text of the item
+		await sortItem.setAttribute("text", "Cooperation");
+
+		await browser.keys("Escape");
+		await btnOpenDialog.click();
+		secondSortItemLi.click(); // Click on another item to re-render, so the text changes successfully.
+
+		sortItemLiText = await viewSettingsDialog.shadow$("[sort-by]").$$("ui5-li")[2].getText();
+		sortItemLiText = sortItemLiText.split("\n")[0];
+		sortItemText = await sortItem.getAttribute("text");
+
+		assert.strictEqual(sortItemLiText, sortItemText, "The sort item text is the same as the li text after update");
+	});
 });