@sapui5/sap.fe.macros 1.141.0 → 1.142.0

package/src/sap/fe/macros/table/Table.block.tsx

@@ -27,6 +27,7 @@ import type {
 	HorizontalAlign,
 	Importance,
 	ManifestAction,
+	OverflowGroupsConfiguration,
 	TableManifestConfiguration
 } from "sap/fe/core/converters/ManifestSettings";
 import { CreationMode, VisualizationType } from "sap/fe/core/converters/ManifestSettings";
@@ -45,21 +46,24 @@ import { generate } from "sap/fe/core/helpers/StableIdHelper";
 import { isAnnotationOfTerm } from "sap/fe/core/helpers/TypeGuards";
 import type { DataModelObjectPath } from "sap/fe/core/templating/DataModelPathHelper";
 import { getContextRelativeTargetObjectPath } from "sap/fe/core/templating/DataModelPathHelper";
+import type CollectionBindingInfoAPI from "sap/fe/macros/CollectionBindingInfo";
 import MacroAPI from "sap/fe/macros/MacroAPI";
 import type Action from "sap/fe/macros/table/Action";
 import type ActionGroup from "sap/fe/macros/table/ActionGroup";
 import type Column from "sap/fe/macros/table/Column";
 import type { TableBlockProperties } from "sap/fe/macros/table/MdcTableTemplate";
 import { getMDCTableTemplate } from "sap/fe/macros/table/MdcTableTemplate";
+import type OverflowGroup from "sap/fe/macros/table/OverflowGroups";
 import TableAPI from "sap/fe/macros/table/TableAPI";
 import TableCreationOptions from "sap/fe/macros/table/TableCreationOptions";
-import FlexItemData from "sap/m/FlexItemData";
 import type { OverflowToolbarPriority } from "sap/m/library";
+import type UI5Event from "sap/ui/base/Event";
 import { type TitleLevel } from "sap/ui/core/library";
-import type { ExportSettings } from "sap/ui/mdc/Table";
+import type { ExportSettings, Table$SelectionChangeEventParameters } from "sap/ui/mdc/Table";
+import type { RowActionItem$PressEventParameters } from "sap/ui/mdc/table/RowActionItem";
 import type Context from "sap/ui/model/Context";
 import type ODataMetaModel from "sap/ui/model/odata/v4/ODataMetaModel";
-import { createCustomData } from "../TSXUtils";
+import type { EventHandler } from "types/extension_types";
 import type ActionGroupOverride from "./ActionGroupOverride";
 import type ActionOverride from "./ActionOverride";
 import type AnalyticalConfiguration from "./AnalyticalConfiguration";
@@ -101,6 +105,7 @@ type CommonCustomAction = {
 	isAIOperation?: boolean;
 	priority?: OverflowToolbarPriority;
 	group?: number;
+	overflowGroup?: number;
 	_type: "Action" | "ActionOverride";
 };
 function safeGetAttribute(node: Element, name: string): string | undefined {
@@ -189,6 +194,10 @@ function getCommonCustomActionProperties(actionNode: Element): CommonCustomActio
 		action["group"] = Number.parseInt(safeGetAttribute(actionNode, "group") ?? "", 10);
 	}
 
+	if (actionNode?.getAttribute("overflowGroup")) {
+		action["overflowGroup"] = Number.parseInt(safeGetAttribute(actionNode, "overflowGroup") ?? "", 10);
+	}
+
 	return action;
 }
 
@@ -241,6 +250,13 @@ const setQuickVariantSelection = function (quickVariantSelection: Element): Bloc
 	};
 };
 
+const setCustomActionOverflowGroupProperties = function (overFlowGroup: Element): PropertiesOf<OverflowGroup> {
+	return {
+		overflowGroup: Number.parseInt(overFlowGroup.getAttribute("overflowGroup") as string, 10),
+		showSeparator: overFlowGroup.getAttribute("showSeparator") === "true"
+	};
+};
+
 /**
  * Parses the common custom properties of the action groups from the XML node.
  * @param actionNode The action group node
@@ -919,6 +935,21 @@ export default class TableBlock extends BuildingBlockTemplatingBase {
 	})
 	quickVariantSelection?: Record<string, BlockQuickVariantSelection>;
 
+	/**
+	 * Aggregate overflowGroups of the table.
+	 * @public
+	 */
+	@blockAggregation({
+		type: "sap.fe.macros.table.OverflowGroup",
+		isPublic: true,
+		multiple: true,
+		hasVirtualNode: true,
+		skipKey: true,
+		reallySkipKey: true,
+		processAggregations: setCustomActionOverflowGroupProperties
+	})
+	actionOverflowGroups?: Record<string, OverflowGroup>;
+
 	convertedMetadata: ConvertedMetadata;
 
 	contextObjectPath: DataModelObjectPath<LineItem | PresentationVariant | SelectionPresentationVariant>;
@@ -934,16 +965,18 @@ export default class TableBlock extends BuildingBlockTemplatingBase {
 	 * @public
 	 */
 	@blockEvent()
-	private readonly beforeRebindTable?: string;
+	private readonly beforeRebindTable?: EventHandler<
+		UI5Event<{ collectionBindingInfo: CollectionBindingInfoAPI; quickFilterKey?: string }, TableAPI>
+	>;
 
 	/**
-	 * An event is triggered when the user chooses a row; the event contains information about which row is chosen.
+	 * An event is triggered when the user chooses a row. The event contains information about which row is chosen.
 	 *
-	 * You can set this in order to handle the navigation manually.
+	 * You can set this to handle the navigation manually.
 	 * @public
 	 */
 	@blockEvent()
-	rowPress?: string;
+	rowPress?: EventHandler<UI5Event<RowActionItem$PressEventParameters, TableAPI>>;
 
 	/**
 	 * Event handler to react to the change event of the table's list binding.
@@ -967,7 +1000,9 @@ export default class TableBlock extends BuildingBlockTemplatingBase {
 	 * @public
 	 */
 	@blockEvent()
-	private readonly selectionChange?: string;
+	private readonly selectionChange?: EventHandler<
+		UI5Event<Table$SelectionChangeEventParameters & { selectedContext: Context[] }, TableAPI>
+	>;
 
 	@blockEvent()
 	variantSelected?: string;
@@ -1165,6 +1200,7 @@ export default class TableBlock extends BuildingBlockTemplatingBase {
 
 		const tableSettings = table.getTableSettings();
 		const extraManifestSettings: TableManifestConfiguration = {
+			overflowGroups: TableBlock.createActionOverflowGroups(table),
 			actions: TableBlock.createActionsFromManifest(table),
 			columns: TableBlock.createColumnsForManifest(table),
 			tableSettings
@@ -1229,7 +1265,8 @@ export default class TableBlock extends BuildingBlockTemplatingBase {
 				enabled: action.enabled,
 				isAIOperation: action.isAIOperation,
 				priority: action.priority,
-				group: action.group
+				group: action.group,
+				overflowGroup: action.overflowGroup
 			};
 			if (action._type === "Action") {
 				actionsSettings[key] = {
@@ -1283,10 +1320,28 @@ export default class TableBlock extends BuildingBlockTemplatingBase {
 		return actionsSettings;
 	}
 
+	/**
+	 * Creates the manifest overflowGroups for the table.
+	 * @param table The table block
+	 * @returns The manifest overflowGroups for the table
+	 */
+	static createActionOverflowGroups(table: TableBlock): OverflowGroupsConfiguration {
+		const overflowGroupsSettings: OverflowGroupsConfiguration = {};
+		if (table.actionOverflowGroups) {
+			Object.values(table.actionOverflowGroups).forEach((overFlowGroup) => {
+				overflowGroupsSettings[overFlowGroup.overflowGroup] = {
+					showSeparator: overFlowGroup.showSeparator
+				};
+			});
+		}
+
+		return overflowGroupsSettings;
+	}
+
 	/**
 	 * Creates the manifest columns for the table.
 	 * @param table The table block
-	 * @returns The manifest actions for the table
+	 * @returns The manifest columns for the table
 	 */
 	static createColumnsForManifest(table: TableBlock): Record<string, CustomDefinedTableColumn | CustomDefinedTableColumnForOverride> {
 		const isBlockColumn = (block: BlockColumn | BlockColumnOverride): block is BlockColumn => {
@@ -1450,9 +1505,7 @@ export default class TableBlock extends BuildingBlockTemplatingBase {
 				condensedTableLayout={this.condensedTableLayout}
 			>
 				{{
-					customData: createCustomData("tableAPILocalId", this._apiId),
 					creationMode,
-					layoutData: <FlexItemData maxWidth="100%" />,
 					content: getMDCTableTemplate(tableProps, {
 						metaPath: this.metaPath,
 						convertedMetadata: this.convertedMetadata,