@sap/ux-specification 1.139.0 → 1.139.2

package/dist/schemas/v2/ListReportNewConfig.json

@@ -15,6 +15,10 @@
       "$ref": "#/definitions/ListReportFilterBar",
       "description": "Filter Bar"
     },
+    "footer": {
+      "$ref": "#/definitions/Toolbar",
+      "description": "Footer"
+    },
     "$schema": {
       "type": "string"
     }
@@ -413,6 +417,81 @@
         "YESTERDAY"
       ],
       "type": "string"
+    },
+    "Toolbar": {
+      "description": "Toolbar",
+      "isViewNode": true,
+      "type": "object",
+      "properties": {
+        "actions": {
+          "$ref": "#/definitions/Actions"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "actions"
+      ]
+    },
+    "Actions": {
+      "description": "Actions",
+      "isViewNode": true,
+      "type": "object",
+      "additionalProperties": {
+        "$ref": "#/definitions/Action"
+      }
+    },
+    "Action": {
+      "description": "Action",
+      "isViewNode": true,
+      "type": "object",
+      "properties": {
+        "tooltip": {
+          "description": "The text of the button tooltip, preferably as an i18n key.",
+          "i18nClassification": "ACT: Text for tooltip of button.",
+          "type": "string",
+          "artifactType": "FlexChange",
+          "controlType": "sap.m.Button"
+        },
+        "icon": {
+          "description": "An icon to be displayed as a graphical element within the button.\nThis can be an image or an icon from the Icon Explorer (https://ui5.sap.com/test-resources/sap/m/demokit/iconExplorer/webapp/index.html#/overview/SAP-icons), represented as RFC 3986 conformant URI.",
+          "type": "string",
+          "artifactType": "FlexChange",
+          "controlType": "sap.m.Button"
+        },
+        "activeIcon": {
+          "description": "An alternative icon for the active (depressed) state of the button.\nThis can be an image or an icon from the Icon Explorer (https://ui5.sap.com/test-resources/sap/m/demokit/iconExplorer/webapp/index.html#/overview/SAP-icons), represented as RFC 3986 conformant URI.",
+          "type": "string",
+          "artifactType": "FlexChange",
+          "controlType": "sap.m.Button"
+        },
+        "type": {
+          "$ref": "#/definitions/ButtonType",
+          "description": "Defines the Button type.",
+          "artifactType": "FlexChange",
+          "controlType": "sap.m.Button"
+        }
+      },
+      "additionalProperties": false
+    },
+    "ButtonType": {
+      "description": "Different predefined button types for the {@link sap.m.Button sap.m.Button}.\n\nThis enum is part of the 'sap/m/library' module export and must be accessed by the property 'ButtonType'.",
+      "enum": [
+        "Accept",
+        "Attention",
+        "Back",
+        "Critical",
+        "Default",
+        "Emphasized",
+        "Ghost",
+        "Negative",
+        "Neutral",
+        "Reject",
+        "Success",
+        "Transparent",
+        "Unstyled",
+        "Up"
+      ],
+      "type": "string"
     }
   },
   "$schema": "http://json-schema.org/draft-07/schema#"

package/dist/schemas/v4/BuildingBlocksConfig.json

@@ -137,6 +137,58 @@
         "type": "Control"
       }
     },
+    "sap.fe.macros.CollaborativeDraftHandler": {
+      "description": "A BuildingBlock to watch the lock status of a property and to react on changes.",
+      "isViewNode": true,
+      "type": "object",
+      "properties": {
+        "contextPath": {
+          "type": "string",
+          "description": "Defines the path of the context used in the current page or block.\nThis setting is defined by the framework, and can be overwritten.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "metaPath": {
+          "type": "string",
+          "description": "Defines the relative path of the property in the metamodel, based on the current contextPath.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "showAvatar": {
+          "type": "boolean",
+          "description": "If set to true, the standard Avatar control is displayed to indicate the lock status.\nIf set to false, nothing is displayed.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "id": {
+          "type": "string",
+          "description": "Unique id of control",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "lockChange": {
+          "type": "string",
+          "description": "Event fired when the lock status changes.\nParameters:\n- isLocked : true if the property is locked, false otherwise\n- lockingUserID: the ID of the user locking the property (undefined if not locked)\n- lockingUserName: the name of the user locking the property (undefined if not locked)\n- lockingUserInitials: the initials of the user locking the property (undefined if not locked)\n- lockingUserColor: the color associated to the user locking the property (undefined if not locked)\n",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Event"
+          }
+        }
+      },
+      "additionalProperties": false,
+      "metadata": {
+        "path": [],
+        "type": "Control"
+      }
+    },
     "sap.fe.macros.CollectionBindingInfo": {
       "description": "API to add parameters to the collection binding info.",
       "isViewNode": true,
@@ -157,6 +209,79 @@
         "type": "Control"
       }
     },
+    "sap.fe.macros.ConditionalSwitch": {
+      "description": "Defines a conditional template that renders content based on the evaluation of a set of switchProperties.\nThe switchProperties are defined using the sap.fe.macros.ConditionalSwitchProperty building block.",
+      "isViewNode": true,
+      "type": "object",
+      "properties": {
+        "factory": {
+          "$ref": "#/definitions/function",
+          "description": "factory",
+          "artifactType": "XMLProperty",
+          "isViewNode": true,
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "id": {
+          "type": "string",
+          "description": "Unique id of control",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        }
+      },
+      "additionalProperties": false,
+      "metadata": {
+        "path": [],
+        "type": "Control"
+      }
+    },
+    "sap.fe.macros.ConditionalSwitchProperty": {
+      "description": "Defines a property with a key and a value that can be used in conditional templates.\nWhen the value is changed, a `valueChanged` event is fired.",
+      "isViewNode": true,
+      "type": "object",
+      "properties": {
+        "key": {
+          "type": "string",
+          "description": "The key of the property.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "value": {
+          "type": "any",
+          "description": "The value of the property.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "id": {
+          "type": "string",
+          "description": "Unique id of control",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "valueChanged": {
+          "type": "string",
+          "description": "Event fired when the value of the property is changed.\nThis is used internally by the `ConditionalTemplate` control to react to changes in the property value.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Event"
+          }
+        }
+      },
+      "additionalProperties": false,
+      "metadata": {
+        "path": [],
+        "type": "Control"
+      }
+    },
     "sap.fe.macros.Field": {
       "description": "Building block for creating a field based on the metadata provided by OData V4.\n\nUsually, a DataField or DataPoint annotation is expected, but the field can also be used to display a property from the entity type.\nWhen creating a Field building block, you must provide an ID to ensure everything works correctly.\nUsage example:\n\n<macros:Field id=\"MyField\" metaPath=\"MyProperty\" />\n\nOverview of Building Blocks\n",
       "isViewNode": true,
@@ -570,13 +695,13 @@
       }
     },
     "sap.fe.macros.Page": {
-      "description": "Provides a Page building block that can be used to create a page with a title and content\nBy default, the page comes with an ObjectTitle",
+      "description": "Building block used to create a custom page with a title and the content. By default, the page includes a title.",
       "isViewNode": true,
       "type": "object",
       "properties": {
         "avatarSrc": {
           "type": "string",
-          "description": "Avatar source of the page. It is considered only if the title property is specified.",
+          "description": "Source of the avatar image. This property is considered only if the title property is defined.",
           "artifactType": "XMLProperty",
           "metadata": {
             "type": "Property"
@@ -584,7 +709,7 @@
         },
         "description": {
           "type": "string",
-          "description": "Description of the page. It is considered only if the title property is specified.",
+          "description": "Provides additional details of the page. This property is considered only if the title property is defined.",
           "artifactType": "XMLProperty",
           "metadata": {
             "type": "Property"
@@ -592,7 +717,7 @@
         },
         "title": {
           "type": "string",
-          "description": "Title of the page\nIf title is not given, then we will add a title, avatar and description based on the unqualified HeaderInfo associated to the entity",
+          "description": "Title of the page. If no title is provided, the title, avatar, and description are derived from the unqualified HeaderInfo annotation associated with the entity.",
           "artifactType": "XMLProperty",
           "metadata": {
             "type": "Property"
@@ -789,6 +914,79 @@
         }
       },
       "additionalProperties": false,
+      "metadata": {
+        "path": [],
+        "type": "Control",
+        "defaultAggregation": "shareOptions"
+      }
+    },
+    "sap.fe.macros.Status": {
+      "description": "Building block to display a status and criticality.",
+      "isViewNode": true,
+      "type": "object",
+      "properties": {
+        "contextPath": {
+          "type": "string",
+          "description": "Context path for the binding context.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "inverted": {
+          "type": "boolean",
+          "description": "Determines whether the background color reflects the set state of the ObjectStatus instead of the control's text.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "largeDesign": {
+          "type": "boolean",
+          "description": "Indicates whether the ObjectStatus should be displayed in large design mode.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "metaPath": {
+          "type": "string",
+          "description": "Metadata path to the DataField annotation or property.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "reactiveAreaMode": {
+          "type": "string",
+          "description": "When the Status is clickable, it defines the size of the reactive area of the clickable element:\n- ReactiveAreaMode.Inline - The Status is displayed as part of a sentence.\n- ReactiveAreaMode.Overlay - The Status is displayed as an overlay on top of other interactive parts of the page.\nNote: It is designed to make the clickable element easier to activate and helps meet the WCAG 2.2 Target Size requirement. It is applicable only for the SAP Horizon themes. Note: The size of the reactive area is sufficiently large to help users avoid accidentally selecting (clicking or tapping) unintended UI elements. UI elements positioned over other parts of the page may need an invisible active touch area. This ensures that no elements beneath are activated accidentally when the user tries to interact with the overlay element.\n",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          },
+          "enum": [
+            "Inline",
+            "Overlay"
+          ]
+        },
+        "id": {
+          "type": "string",
+          "description": "Unique id of control",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "press": {
+          "type": "string",
+          "description": "Press event fired when the ObjectStatus is clicked.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Event"
+          }
+        }
+      },
+      "additionalProperties": false,
       "metadata": {
         "path": [],
         "type": "Control"
@@ -985,7 +1183,8 @@
       "additionalProperties": false,
       "metadata": {
         "path": [],
-        "type": "Control"
+        "type": "Control",
+        "defaultAggregation": "actions"
       }
     },
     "sap.fe.macros.chart.Chart": {
@@ -2116,7 +2315,8 @@
       "additionalProperties": false,
       "metadata": {
         "path": [],
-        "type": "Control"
+        "type": "Control",
+        "defaultAggregation": "actions"
       }
     },
     "sap.fe.macros.table.ActionGroupOverride": {
@@ -2175,7 +2375,8 @@
       "additionalProperties": false,
       "metadata": {
         "path": [],
-        "type": "Control"
+        "type": "Control",
+        "defaultAggregation": "actions"
       }
     },
     "sap.fe.macros.table.ActionOverride": {
@@ -2343,6 +2544,14 @@
             "type": "Property"
           }
         },
+        "disableExport": {
+          "type": "boolean",
+          "description": "Determines if the column should be excluded from the export.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
         "header": {
           "type": "string",
           "description": "The text that will be displayed for this column header",
@@ -2449,6 +2658,22 @@
       "isViewNode": true,
       "type": "object",
       "properties": {
+        "falseValue": {
+          "type": "string",
+          "description": "Determines the text associated to a Boolean type with 'false' as value.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "label": {
+          "type": "string",
+          "description": "Determines the column header text.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
         "property": {
           "$ref": "#/definitions/string[]",
           "description": "property",
@@ -2466,6 +2691,22 @@
             "type": "Property"
           }
         },
+        "textAlign": {
+          "type": "string",
+          "description": "Determines the alignment of the column of the cell contents.\nAvailable options are:\n- Left\n- Right\n- Center\n- Begin\n- End\n\n",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "trueValue": {
+          "type": "string",
+          "description": "Determines the text associated to a Boolean type with 'true' as value.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
         "type": {
           "type": "string",
           "description": "Determines the data type of the field",
@@ -2474,6 +2715,14 @@
             "type": "Property"
           }
         },
+        "valueMap": {
+          "type": "object",
+          "description": "Determines the mapping object holding the values associated with a specific key.\nEnumeration type must be used when valueMap is provided.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
         "width": {
           "type": "number",
           "description": "Determines the width of the column in characters",
@@ -2518,6 +2767,14 @@
             "type": "Property"
           }
         },
+        "disableExport": {
+          "type": "boolean",
+          "description": "Determines if the column should be excluded from the export.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
         "horizontalAlign": {
           "type": "string",
           "description": "Aligns the header as well as the content horizontally",
@@ -2642,7 +2899,8 @@
       "additionalProperties": false,
       "metadata": {
         "path": [],
-        "type": "Control"
+        "type": "Control",
+        "defaultAggregation": "customContent"
       }
     },
     "sap.fe.macros.table.QuickVariantSelection": {
@@ -2784,6 +3042,14 @@
             "type": "Property"
           }
         },
+        "exportFileName": {
+          "type": "string",
+          "description": "Configures the file name of exported table.\nIt's limited to 31 characters. If the name is longer, it will be truncated.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
         "exportRequestSize": {
           "type": "number",
           "description": "Maximum allowed number of records to be exported in one request.",
@@ -2792,6 +3058,14 @@
             "type": "Property"
           }
         },
+        "exportSheetName": {
+          "type": "string",
+          "description": "Configures the sheet name of exported table.\nIt's limited to 31 characters. If the name is longer, it will be truncated.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
         "filterBar": {
           "type": "string",
           "description": "ID of the FilterBar building block associated with the table.",
@@ -3047,7 +3321,7 @@
         },
         "beforeRebindTable": {
           "type": "string",
-          "description": "Before a table rebind, an event is triggered that contains information about the binding.\nThe event contains a parameter, `collectionBindingInfo`, which is an instance of `CollectionBindingInfoAPI`.\nThis allows you to manipulate the table's list binding.\nYou can use this event to attach event handlers to the table's list binding.\nYou can use this event to add selects, and add or read the sorters and filters.\n",
+          "description": "Before a table rebind, an event is triggered that contains information about the binding.\nThe event contains a parameter, `collectionBindingInfo`, which is an instance of `CollectionBindingInfoAPI`.\nIt can also contain an optional parameter, `quickFilterKey`, which indicates what is the quick filter key (if any) being processed for the table.\nThis allows you to manipulate the table's list binding.\nYou can use this event to attach event handlers to the table's list binding.\nYou can use this event to add selects, and add or read the sorters and filters.\n",
           "artifactType": "XMLProperty",
           "metadata": {
             "type": "Event"
@@ -3179,6 +3453,14 @@
             "type": "Property"
           }
         },
+        "exportFileName": {
+          "type": "string",
+          "description": "Configures the file name of exported table.\nIt's limited to 31 characters. If the name is longer, it will be truncated.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
         "exportRequestSize": {
           "type": "number",
           "description": "Maximum allowed number of records to be exported in one request.",
@@ -3187,6 +3469,14 @@
             "type": "Property"
           }
         },
+        "exportSheetName": {
+          "type": "string",
+          "description": "Configures the sheet name of exported table.\nIt's limited to 31 characters. If the name is longer, it will be truncated.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
         "filterBar": {
           "type": "string",
           "description": "ID of the FilterBar building block associated with the table.",
@@ -3437,7 +3727,7 @@
         },
         "beforeRebindTable": {
           "type": "string",
-          "description": "Before a table rebind, an event is triggered that contains information about the binding.\nThe event contains a parameter, `collectionBindingInfo`, which is an instance of `CollectionBindingInfoAPI`.\nThis allows you to manipulate the table's list binding.\nYou can use this event to attach event handlers to the table's list binding.\nYou can use this event to add selects, and add or read the sorters and filters.\n",
+          "description": "Before a table rebind, an event is triggered that contains information about the binding.\nThe event contains a parameter, `collectionBindingInfo`, which is an instance of `CollectionBindingInfoAPI`.\nIt can also contain an optional parameter, `quickFilterKey`, which indicates what is the quick filter key (if any) being processed for the table.\nThis allows you to manipulate the table's list binding.\nYou can use this event to attach event handlers to the table's list binding.\nYou can use this event to add selects, and add or read the sorters and filters.\n",
           "artifactType": "XMLProperty",
           "metadata": {
             "type": "Event"
@@ -3635,6 +3925,14 @@
             "type": "Property"
           }
         },
+        "exportFileName": {
+          "type": "string",
+          "description": "Configures the file name of exported table.\nIt's limited to 31 characters. If the name is longer, it will be truncated.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
         "exportRequestSize": {
           "type": "number",
           "description": "Maximum allowed number of records to be exported in one request.",
@@ -3643,6 +3941,14 @@
             "type": "Property"
           }
         },
+        "exportSheetName": {
+          "type": "string",
+          "description": "Configures the sheet name of exported table.\nIt's limited to 31 characters. If the name is longer, it will be truncated.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
         "filterBar": {
           "type": "string",
           "description": "ID of the FilterBar building block associated with the table.",
@@ -3929,7 +4235,7 @@
         },
         "beforeRebindTable": {
           "type": "string",
-          "description": "Before a table rebind, an event is triggered that contains information about the binding.\nThe event contains a parameter, `collectionBindingInfo`, which is an instance of `CollectionBindingInfoAPI`.\nThis allows you to manipulate the table's list binding.\nYou can use this event to attach event handlers to the table's list binding.\nYou can use this event to add selects, and add or read the sorters and filters.\n",
+          "description": "Before a table rebind, an event is triggered that contains information about the binding.\nThe event contains a parameter, `collectionBindingInfo`, which is an instance of `CollectionBindingInfoAPI`.\nIt can also contain an optional parameter, `quickFilterKey`, which indicates what is the quick filter key (if any) being processed for the table.\nThis allows you to manipulate the table's list binding.\nYou can use this event to attach event handlers to the table's list binding.\nYou can use this event to add selects, and add or read the sorters and filters.\n",
           "artifactType": "XMLProperty",
           "metadata": {
             "type": "Event"
@@ -4060,6 +4366,14 @@
             "type": "Property"
           }
         },
+        "exportFileName": {
+          "type": "string",
+          "description": "Configures the file name of exported table.\nIt's limited to 31 characters. If the name is longer, it will be truncated.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
         "exportRequestSize": {
           "type": "number",
           "description": "Maximum allowed number of records to be exported in one request.",
@@ -4068,6 +4382,14 @@
             "type": "Property"
           }
         },
+        "exportSheetName": {
+          "type": "string",
+          "description": "Configures the sheet name of exported table.\nIt's limited to 31 characters. If the name is longer, it will be truncated.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
         "filterBar": {
           "type": "string",
           "description": "ID of the FilterBar building block associated with the table.",
@@ -4354,7 +4676,7 @@
         },
         "beforeRebindTable": {
           "type": "string",
-          "description": "Before a table rebind, an event is triggered that contains information about the binding.\nThe event contains a parameter, `collectionBindingInfo`, which is an instance of `CollectionBindingInfoAPI`.\nThis allows you to manipulate the table's list binding.\nYou can use this event to attach event handlers to the table's list binding.\nYou can use this event to add selects, and add or read the sorters and filters.\n",
+          "description": "Before a table rebind, an event is triggered that contains information about the binding.\nThe event contains a parameter, `collectionBindingInfo`, which is an instance of `CollectionBindingInfoAPI`.\nIt can also contain an optional parameter, `quickFilterKey`, which indicates what is the quick filter key (if any) being processed for the table.\nThis allows you to manipulate the table's list binding.\nYou can use this event to attach event handlers to the table's list binding.\nYou can use this event to add selects, and add or read the sorters and filters.\n",
           "artifactType": "XMLProperty",
           "metadata": {
             "type": "Event"