@sap/ux-specification 1.108.10 → 1.108.12

package/dist/schemas/v4/BuildingBlocksConfig.json

@@ -1,5 +1,13 @@
 {
   "type": "object",
+  "metadata": {
+    "namespaces": [
+      "sap.fe.macros",
+      "sap.fe.macros.chart",
+      "sap.fe.macros.field",
+      "sap.fe.macros.table"
+    ]
+  },
   "properties": {
     "$filePath": {
       "type": "string",
@@ -12,52 +20,8 @@
   },
   "additionalProperties": false,
   "definitions": {
-    "sap.fe.macros.FlexibleColumnLayoutActions": {
-      "description": "Building block used specifically in an app using the flexible column layout to add the ‘expand’, ‘reduce’, and ‘close’ action buttons.Usage example: \n<f:DynamicPageTitle id=\"incidentProcessFlowDynamicPageTitle\">\n\t <f:navigationActions>\n\t   <macros:FlexibleColumnLayoutActions />\n\t </f:navigationActions>\n</f:DynamicPageTitle>\n<macro:FlexibleColumnLayoutActions />\n",
-      "isViewNode": true,
-      "type": "object",
-      "properties": {},
-      "additionalProperties": false,
-      "metadata": {
-        "path": [],
-        "type": "Control"
-      }
-    },
-    "sap.fe.macros.MicroChart": {
-      "description": "Building block used to create a MicroChart based on the metadata provided by OData V4.",
-      "isViewNode": true,
-      "type": "object",
-      "properties": {},
-      "additionalProperties": false,
-      "metadata": {
-        "path": [],
-        "type": "Control"
-      }
-    },
-    "sap.fe.macros.Paginator": {
-      "description": "Building block used to create a paginator control.Usage example: \n<macro:Paginator />\n",
-      "isViewNode": true,
-      "type": "object",
-      "properties": {},
-      "additionalProperties": false,
-      "metadata": {
-        "path": [],
-        "type": "Control"
-      }
-    },
-    "sap.fe.macros.Share": {
-      "description": "Building block used to create the ‘Share’ functionality.  Please note that the 'Share in SAP Jam' option is only available on platforms that are integrated with SAP Jam.  If you are consuming this macro in an environment where the SAP Fiori launchpad is not available, then the 'Save as Tile' option is not visible.Usage example: \n<macro:Share\n\tid=\"someID\"\n\tvisible=\"true\"\n/>\n",
-      "isViewNode": true,
-      "type": "object",
-      "properties": {},
-      "additionalProperties": false,
-      "metadata": {
-        "path": [],
-        "type": "Control"
-      }
-    },
     "sap.fe.macros.MacroAPI": {
-      "description": "Base API control for macros.",
+      "description": "Base API control for building blocks.",
       "isViewNode": true,
       "type": "object",
       "properties": {
@@ -105,6 +69,22 @@
             "type": "Property"
           }
         },
+        "header": {
+          "type": "string",
+          "description": "Specifies the header text that is shown in the chart",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "headerVisible": {
+          "type": "boolean",
+          "description": "Controls if the header text should be shown or not",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
         "id": {
           "type": "string",
           "description": "ID of the chart",
@@ -115,7 +95,7 @@
         },
         "metaPath": {
           "type": "string",
-          "description": "Metadata path to the presentation (UI.Chart w or w/o qualifier)",
+          "description": "Metadata path to the presentation context (UI.Chart with or without a qualifier)",
           "artifactType": "XMLProperty",
           "metadata": {
             "type": "Property"
@@ -124,26 +104,46 @@
         "personalization": {
           "anyOf": [
             {
-              "type": "boolean"
+              "$ref": "#/definitions/boolean "
             },
             {
-              "type": "string"
+              "$ref": "#/definitions/ string"
             }
           ],
-          "description": "Parameter which sets the personalization of the MDC chart",
+          "description": "personalization",
           "artifactType": "XMLProperty",
+          "isViewNode": true,
           "metadata": {
             "type": "Property"
           }
         },
         "selectionMode": {
           "type": "string",
-          "description": "Specifies the selection mode",
+          "description": "Defines the selection mode to be used by the chart.\nAllowed values are `None`, `Single` or `Multiple`\n",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "variantManagement": {
+          "type": "string",
+          "description": "Controls the kind of variant management that should be enabled for the chart.\nAllowed value is `Control`.\n\nIf set with value `Control`, a variant management control is seen within the chart and the chart is linked to this.\n\nIf not set with any value, variant management control is not available for this chart.\n",
           "artifactType": "XMLProperty",
           "metadata": {
             "type": "Property"
           }
         },
+        "actions": {
+          "type": "object",
+          "additionalProperties": {
+            "$ref": "#/definitions/sap.fe.macros.chart.Action"
+          },
+          "isViewNode": true,
+          "metadata": {
+            "path": [],
+            "type": "Aggregation"
+          }
+        },
         "selectionChange": {
           "type": "string",
           "description": "An event triggered when chart selections are changed. The event contains information about the data selected/deselected and the Boolean flag that indicates whether data is selected or deselected.",
@@ -228,6 +228,17 @@
         "type": "Control"
       }
     },
+    "sap.fe.macros.field.TextAreaEx": {
+      "description": "Extension of the TextArea control to add a check for the maximum length when setting the value.",
+      "isViewNode": true,
+      "type": "object",
+      "properties": {},
+      "additionalProperties": false,
+      "metadata": {
+        "path": [],
+        "type": "Control"
+      }
+    },
     "sap.fe.macros.FilterBar": {
       "description": "Building block for creating a FilterBar based on the metadata provided by OData V4.\n\nUsually, a SelectionFields annotation is expected.\nUsage example:\n\n<macro:FilterBar id=\"MyFilterBar\" metaPath=\"@com.sap.vocabularies.UI.v1.SelectionFields\" />\n\n",
       "isViewNode": true,
@@ -249,6 +260,14 @@
             "type": "Property"
           }
         },
+        "liveMode": {
+          "type": "boolean",
+          "description": "If true, the search is triggered automatically when a filter value is changed.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
         "metaPath": {
           "type": "string",
           "description": "Defines the relative path of the property in the metamodel, based on the current contextPath.",
@@ -257,6 +276,30 @@
             "type": "Property"
           }
         },
+        "showClearButton": {
+          "type": "boolean",
+          "description": "Handles the visibility of the 'Clear' button on the FilterBar.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "showMessages": {
+          "type": "boolean",
+          "description": "Displays possible errors during the search in a message box",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "visible": {
+          "type": "boolean",
+          "description": "Parameter which sets the visibility of the FilterBar building block",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
         "filterFields": {
           "type": "object",
           "additionalProperties": {
@@ -268,6 +311,14 @@
             "type": "Aggregation"
           }
         },
+        "afterClear": {
+          "type": "string",
+          "description": "This event is fired when the 'Clear' button is pressed. This is only possible when the 'Clear' button is enabled.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Event"
+          }
+        },
         "filterChanged": {
           "type": "string",
           "description": "This event is fired after either a filter value or the visibility of a filter item has been changed. The event contains conditions that will be used as filters.",
@@ -297,9 +348,10 @@
       "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.",
+          "$ref": "#/definitions/sap.ui.model.Context",
+          "description": "contextPath",
           "artifactType": "XMLProperty",
+          "isViewNode": true,
           "metadata": {
             "type": "Property"
           }
@@ -313,9 +365,10 @@
           }
         },
         "metaPath": {
-          "type": "string",
-          "description": "Defines the relative path of the property in the metamodel, based on the current contextPath.",
+          "$ref": "#/definitions/sap.ui.model.Context",
+          "description": "metaPath",
           "artifactType": "XMLProperty",
+          "isViewNode": true,
           "metadata": {
             "type": "Property"
           }
@@ -335,6 +388,102 @@
         "type": "Control"
       }
     },
+    "sap.fe.macros.FormElement": {
+      "description": "Building block used to create a form element based on the metadata provided by OData V4.",
+      "isViewNode": true,
+      "type": "object",
+      "properties": {
+        "contextPath": {
+          "$ref": "#/definitions/sap.ui.model.Context",
+          "description": "contextPath",
+          "artifactType": "XMLProperty",
+          "isViewNode": true,
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "id": {
+          "type": "string",
+          "description": "The identifier of the FormElement building block.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "label": {
+          "type": "string",
+          "description": "Label shown for the field. If not set, the label from the annotations will be shown.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "metaPath": {
+          "$ref": "#/definitions/sap.ui.model.Context",
+          "description": "metaPath",
+          "artifactType": "XMLProperty",
+          "isViewNode": true,
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "visible": {
+          "type": "boolean",
+          "description": "If set to false, the FormElement is not rendered.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "fields": {
+          "type": "object",
+          "additionalProperties": {
+            "$ref": "#/definitions/sap.ui.core.Control"
+          },
+          "isViewNode": true,
+          "metadata": {
+            "path": [],
+            "type": "Aggregation"
+          }
+        }
+      },
+      "additionalProperties": false,
+      "metadata": {
+        "path": [],
+        "type": "Control"
+      }
+    },
+    "sap.fe.macros.MicroChart": {
+      "description": "Building block used to create a MicroChart based on the metadata provided by OData V4.",
+      "isViewNode": true,
+      "type": "object",
+      "properties": {},
+      "additionalProperties": false,
+      "metadata": {
+        "path": [],
+        "type": "Control"
+      }
+    },
+    "sap.fe.macros.Paginator": {
+      "description": "Building block used to create a paginator control.\nUsage example:\n\n<macro:Paginator />\n\n",
+      "isViewNode": true,
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "The identifier of the Paginator control.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        }
+      },
+      "additionalProperties": false,
+      "metadata": {
+        "path": [],
+        "type": "Control"
+      }
+    },
     "sap.fe.macros.Table": {
       "description": "Building block used to create a table based on the metadata provided by OData V4.\n\nUsually, a LineItem or PresentationVariant annotation is expected, but the Table building block can also be used to display an EntitySet.\nUsage example:\n\n<macro:Table id=\"MyTable\" metaPath=\"@com.sap.vocabularies.UI.v1.LineItem\" />\n\n",
       "isViewNode": true,
@@ -358,7 +507,7 @@
         },
         "enableAutoColumnWidth": {
           "type": "boolean",
-          "description": "Specifies the header text that is shown in the table.",
+          "description": "Specifies if the column width is automatically calculated.",
           "artifactType": "XMLProperty",
           "metadata": {
             "type": "Property"
@@ -396,6 +545,14 @@
             "type": "Property"
           }
         },
+        "frozenColumnCount": {
+          "type": "number",
+          "description": "Number of columns that are fixed on the left. Only columns which are not fixed can be scrolled horizontally.\nThis property is not relevant for Responsive tables\n",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
         "header": {
           "type": "string",
           "description": "Specifies the header text that is shown in the table.",
@@ -447,14 +604,15 @@
         "personalization": {
           "anyOf": [
             {
-              "type": "boolean"
+              "$ref": "#/definitions/boolean "
             },
             {
-              "type": "string"
+              "$ref": "#/definitions/ string"
             }
           ],
-          "description": "Controls which options should be enabled for the table personalization dialog.\nIf it is set to `true`, all possible options for this kind of table are enabled.\n\nIf it is set to `false`, personalization is disabled.\n\n\n\nYou can also provide a more granular control for the personalization by providing a comma-separated list with the options you want to be available.\n\nAvailable options are:\n\n - Sort\n\n - Column\n\n - Filter\n\n",
+          "description": "personalization",
           "artifactType": "XMLProperty",
+          "isViewNode": true,
           "metadata": {
             "type": "Property"
           }
@@ -469,7 +627,7 @@
         },
         "selectionMode": {
           "type": "string",
-          "description": "Defines the selection mode to be used by the table.\nAllowed values are `None`, `Single`, `Multi` or `Auto`\n",
+          "description": "Defines the selection mode to be used by the table.\nAllowed values are `None`, `Single`, `Multi` or `Auto`. If not set to 'None', SAP Fiori elements hooks into the standard lifecycle to determine the consistent selection mode.\n",
           "artifactType": "XMLProperty",
           "metadata": {
             "type": "Property"
@@ -485,7 +643,7 @@
         },
         "variantManagement": {
           "type": "string",
-          "description": "Controls the kind of variant management that should be enabled for the table.\nAllowed values are `Page`, `Control` and `None`.\n\nIf the table is used within a SAP Fiori elements template, the default value will be taken from the current page variant management.\n\nOtherwise it's `None`.\n",
+          "description": "Controls the kind of variant management that should be enabled for the table.\nAllowed value is `Control`.\n\nIf set with value `Control`, a variant management control is seen within the table and the table is linked to this.\n\nIf not set with any value, control level variant management is not available for this table.\n",
           "artifactType": "XMLProperty",
           "metadata": {
             "type": "Property"
@@ -523,7 +681,7 @@
         },
         "rowPress": {
           "type": "string",
-          "description": "An event triggered when the user chooses a row; the event contains information about which row was chosen.\nYou can set this in order to handle the navigation manually.\n",
+          "description": "An event is triggered when the user chooses a row; the event contains information about which row is chosen.\nYou can set this in order to handle the navigation manually.\n",
           "artifactType": "XMLProperty",
           "metadata": {
             "type": "Event"
@@ -541,7 +699,8 @@
       "additionalProperties": false,
       "metadata": {
         "path": [],
-        "type": "Control"
+        "type": "Control",
+        "defaultAggregation": "columns"
       }
     },
     "sap.fe.macros.ActionGroup": {
@@ -586,6 +745,128 @@
         }
       },
       "additionalProperties": false,
+      "metadata": {
+        "path": [],
+        "type": "Control",
+        "defaultAggregation": "actions"
+      }
+    },
+    "sap.fe.macros.chart.Action": {
+      "description": "Definition of a custom action to be used inside the chart toolbar",
+      "isViewNode": true,
+      "type": "object",
+      "properties": {
+        "anchor": {
+          "type": "string",
+          "description": "Reference to the key of another action already displayed in the toolbar to properly place this one",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "enabled": {
+          "type": "boolean",
+          "description": "Enables or disables the action",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "key": {
+          "type": "string",
+          "description": "Unique identifier of the action",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "placement": {
+          "type": "string",
+          "description": "Defines where this action should be placed relative to the defined anchor\nAllowed values are `Before` and `After`\n",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "press": {
+          "type": "string",
+          "description": "Event handler to be called when the user chooses the action",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "requiresSelection": {
+          "type": "boolean",
+          "description": "Defines if the action requires a selection.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "text": {
+          "type": "string",
+          "description": "The text that will be displayed for this action",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        }
+      },
+      "additionalProperties": false,
+      "metadata": {
+        "path": [],
+        "type": "Control"
+      }
+    },
+    "sap.fe.macros.chart.ActionGroup": {
+      "description": "Definition of a custom action group to be used inside the chart toolbar",
+      "isViewNode": true,
+      "type": "object",
+      "properties": {
+        "actions": {
+          "$ref": "#/definitions/undefined[]",
+          "description": "actions",
+          "artifactType": "XMLProperty",
+          "isViewNode": true,
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "anchor": {
+          "type": "string",
+          "description": "Reference to the key of another action or action group already displayed in the toolbar to properly place this one",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "key": {
+          "type": "string",
+          "description": "Unique identifier of the action",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "placement": {
+          "type": "string",
+          "description": "Defines where this action group should be placed relative to the defined anchor\nAllowed values are `Before` and `After`\n",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "text": {
+          "type": "string",
+          "description": "The text that will be displayed for this action group",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        }
+      },
+      "additionalProperties": false,
       "metadata": {
         "path": [],
         "type": "Control"
@@ -598,7 +879,7 @@
       "properties": {
         "displayMode": {
           "type": "string",
-          "description": " Defines how the field value and associated text will be displayed together.\n\n Allowed values are \"Value\", \"Description\", \"ValueDescription\" and \"DescriptionValue\"\n",
+          "description": " Defines how the field value and associated text will be displayed together.\n\n Allowed values are \"Value\", \"Description\", \"DescriptionValue\" and \"ValueDescription\"\n",
           "artifactType": "XMLProperty",
           "metadata": {
             "type": "Property"
@@ -612,6 +893,30 @@
             "type": "Property"
           }
         },
+        "showDate": {
+          "type": "boolean",
+          "description": "Defines if the date part of a date time with timezone field should be shown. \n\nThe dateTimeOffset field must have a timezone annotation.The default value is true.\n",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "showTime": {
+          "type": "boolean",
+          "description": "Defines if the time part of a date time with timezone field should be shown. \n\nThe dateTimeOffset field must have a timezone annotation.The default value is true.\n",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "showTimezone": {
+          "type": "boolean",
+          "description": "Defines if the timezone part of a date time with timezone field should be shown. \n\nThe dateTimeOffset field must have a timezone annotation.The default value is true.\n",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
         "textExpandBehaviorDisplay": {
           "type": "string",
           "description": "Defines how the full text will be displayed.\n\nAllowed values are \"InPlace\" and \"Popover\"\n",
@@ -636,6 +941,14 @@
             "type": "Property"
           }
         },
+        "textMaxLength": {
+          "type": "number",
+          "description": "Defines the maximum number of characters for the multiline text value.\n\nIf a multiline text exceeds the maximum number of allowed characters, the counter below the input field displays the exact number.\n",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
         "textMaxLines": {
           "type": "number",
           "description": "Maximum number of lines that multiline texts in edit mode can grow to.\n",
@@ -680,14 +993,6 @@
             "type": "Property"
           }
         },
-        "liveMode": {
-          "type": "boolean",
-          "description": "If set, the search is triggered automatically when a filter value is changed.",
-          "artifactType": "XMLProperty",
-          "metadata": {
-            "type": "Property"
-          }
-        },
         "placement": {
           "type": "string",
           "description": "Defines where this filter should be placed relative to the defined anchor\nAllowed values are `Before` and `After`\n",
@@ -707,14 +1012,6 @@
           "metadata": {
             "type": "Property"
           }
-        },
-        "visible": {
-          "type": "boolean",
-          "description": "Parameter which sets the visibility of the FilterBar building block",
-          "artifactType": "XMLProperty",
-          "metadata": {
-            "type": "Property"
-          }
         }
       },
       "additionalProperties": false,
@@ -795,6 +1092,59 @@
         "type": "Control"
       }
     },
+    "sap.fe.macros.table.ActionGroup": {
+      "description": "Definition of a custom ActionGroup to be used inside the table toolbar",
+      "isViewNode": true,
+      "type": "object",
+      "properties": {
+        "actions": {
+          "$ref": "#/definitions/undefined[]",
+          "description": "actions",
+          "artifactType": "XMLProperty",
+          "isViewNode": true,
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "anchor": {
+          "type": "string",
+          "description": "Reference to the key of another action or action group already displayed in the toolbar to properly place this one",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "key": {
+          "type": "string",
+          "description": "Unique identifier of the ActionGroup",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "placement": {
+          "type": "string",
+          "description": "Defines where this action group should be placed relative to the defined anchor\nAllowed values are `Before` and `After`\n",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "text": {
+          "type": "string",
+          "description": "The text that will be displayed for this action group",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        }
+      },
+      "additionalProperties": false,
+      "metadata": {
+        "path": [],
+        "type": "Control"
+      }
+    },
     "sap.fe.macros.table.Column": {
       "description": "Definition of a custom column to be used inside the table.\nThe template for the column has to be provided as the default aggregation\n",
       "isViewNode": true,
@@ -816,9 +1166,18 @@
             "type": "Property"
           }
         },
+        "horizontalAlign": {
+          "$ref": "#/definitions/sap.fe.core.converters.ManifestSettings.HorizontalAlign",
+          "description": "horizontalAlign",
+          "artifactType": "XMLProperty",
+          "isViewNode": true,
+          "metadata": {
+            "type": "Property"
+          }
+        },
         "importance": {
           "type": "string",
-          "description": "Defines the column importance\nYou can define which columns should be automatically moved to the pop-in area based on their importance\n",
+          "description": "Defines the column importance.\nYou can define which columns should be automatically moved to the pop-in area based on their importance\n",
           "artifactType": "XMLProperty",
           "metadata": {
             "type": "Property"
@@ -843,6 +1202,14 @@
             "After",
             "Before"
           ]
+        },
+        "width": {
+          "type": "string",
+          "description": "Defines the column's width.\nAllowed values are `auto`, `value` and `inherit` according to sap.ui.core.CSSSize\n",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
         }
       },
       "additionalProperties": false,