@sap/ux-specification 1.144.0 → 1.144.2

package/dist/schemas/v4/BuildingBlocksConfig.json

@@ -7,6 +7,7 @@
       "sap.fe.macros.controls",
       "sap.fe.macros.field",
       "sap.fe.macros.filterBar",
+      "sap.fe.macros.form",
       "sap.fe.macros.microchart",
       "sap.fe.macros.richtexteditor",
       "sap.fe.macros.share",
@@ -400,7 +401,8 @@
             "path": [],
             "type": "Aggregation",
             "aggregationCardinality": "Single"
-          }
+          },
+          "description": "A set of options that can be configured."
         },
         "change": {
           "type": "string",
@@ -892,7 +894,8 @@
             "path": [],
             "type": "Aggregation",
             "aggregationCardinality": "Single"
-          }
+          },
+          "description": "Footer content (for example, toolbar with buttons)."
         },
         "headerContent": {
           "type": "object",
@@ -1008,7 +1011,7 @@
           }
         },
         "required": {
-          "type": "any",
+          "type": "boolean",
           "description": "Use the 'required' attribute to make sure that the editor is filled with some text.",
           "artifactType": "XMLProperty",
           "metadata": {
@@ -1016,7 +1019,7 @@
           }
         },
         "value": {
-          "type": "any",
+          "type": "string",
           "description": "The value contained in the editor. You can use this attribute to set a default value.",
           "artifactType": "XMLProperty",
           "metadata": {
@@ -1116,7 +1119,7 @@
           }
         },
         "required": {
-          "type": "any",
+          "type": "boolean",
           "description": "Use the 'required' attribute to make sure that the editor is filled with some text.",
           "artifactType": "XMLProperty",
           "metadata": {
@@ -1124,7 +1127,7 @@
           }
         },
         "value": {
-          "type": "any",
+          "type": "string",
           "description": "The value contained in the editor. You can use this attribute to set a default value.",
           "artifactType": "XMLProperty",
           "metadata": {
@@ -1180,12 +1183,13 @@
           "additionalProperties": {
             "$ref": "#/definitions/sap.fe.macros.share.ShareOptions"
           },
-          "isViewNode": true,
+          "isViewNode": false,
           "metadata": {
             "path": [],
             "type": "Aggregation",
             "aggregationCardinality": "Single"
-          }
+          },
+          "description": "Supported Share options sap.fe.macros.share.ShareOptions."
         }
       },
       "additionalProperties": false,
@@ -1647,7 +1651,8 @@
             "path": [],
             "type": "Aggregation",
             "aggregationCardinality": "Single"
-          }
+          },
+          "description": "A set of options that can be configured to control the aggregation behavior"
         },
         "columns": {
           "type": "object",
@@ -1661,6 +1666,32 @@
             "aggregationCardinality": "Multiple"
           }
         },
+        "massEdit": {
+          "type": "object",
+          "additionalProperties": {
+            "$ref": "#/definitions/sap.fe.macros.table.MassEdit"
+          },
+          "isViewNode": false,
+          "metadata": {
+            "path": [],
+            "type": "Aggregation",
+            "aggregationCardinality": "Single"
+          },
+          "description": "Aggregate mass edit of the table."
+        },
+        "quickVariantSelection": {
+          "type": "object",
+          "additionalProperties": {
+            "$ref": "#/definitions/sap.fe.macros.table.QuickVariantSelection"
+          },
+          "isViewNode": false,
+          "metadata": {
+            "path": [],
+            "type": "Aggregation",
+            "aggregationCardinality": "Single"
+          },
+          "description": "Aggregate quickVariantSelection of the table."
+        },
         "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`.\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",
@@ -2095,7 +2126,8 @@
             "path": [],
             "type": "Aggregation",
             "aggregationCardinality": "Single"
-          }
+          },
+          "description": "A set of options that can be configured to control the aggregation behavior"
         },
         "columns": {
           "type": "object",
@@ -2109,6 +2141,32 @@
             "aggregationCardinality": "Multiple"
           }
         },
+        "massEdit": {
+          "type": "object",
+          "additionalProperties": {
+            "$ref": "#/definitions/sap.fe.macros.table.MassEdit"
+          },
+          "isViewNode": false,
+          "metadata": {
+            "path": [],
+            "type": "Aggregation",
+            "aggregationCardinality": "Single"
+          },
+          "description": "Aggregate mass edit of the table."
+        },
+        "quickVariantSelection": {
+          "type": "object",
+          "additionalProperties": {
+            "$ref": "#/definitions/sap.fe.macros.table.QuickVariantSelection"
+          },
+          "isViewNode": false,
+          "metadata": {
+            "path": [],
+            "type": "Aggregation",
+            "aggregationCardinality": "Single"
+          },
+          "description": "Aggregate quickVariantSelection of the table."
+        },
         "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`.\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",
@@ -2274,7 +2332,7 @@
           }
         },
         "text": {
-          "type": "any",
+          "type": "string",
           "description": "The text that is to be displayed for this action",
           "artifactType": "XMLProperty",
           "metadata": {
@@ -2283,7 +2341,7 @@
           "i18nClassification": "BUT: Text of the action button"
         },
         "visible": {
-          "type": "any",
+          "type": "boolean",
           "description": "Determines whether the action is visible.",
           "artifactType": "XMLProperty",
           "metadata": {
@@ -2404,7 +2462,7 @@
           }
         },
         "visible": {
-          "type": "any",
+          "type": "boolean",
           "description": "Determines whether the action is visible.",
           "artifactType": "XMLProperty",
           "metadata": {
@@ -2666,7 +2724,7 @@
           }
         },
         "text": {
-          "type": "any",
+          "type": "string",
           "description": "The text that is to be displayed for this action",
           "artifactType": "XMLProperty",
           "metadata": {
@@ -2674,7 +2732,7 @@
           }
         },
         "visible": {
-          "type": "any",
+          "type": "boolean",
           "description": "Determines whether the action is visible.",
           "artifactType": "XMLProperty",
           "metadata": {
@@ -2827,7 +2885,8 @@
             "path": [],
             "type": "Aggregation",
             "aggregationCardinality": "Single"
-          }
+          },
+          "description": "A set of options that can be configured."
         },
         "change": {
           "type": "string",
@@ -2893,6 +2952,14 @@
             "ValueDescription"
           ]
         },
+        "enableEnlargeImage": {
+          "type": "boolean",
+          "description": "Property for defining if the avatar image can be enlarged.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
         "fieldEditStyle": {
           "type": "string",
           "description": "Determines how the field should be rendered, e.g. as radio buttons. \nIf not all prerequisites are met, the field will default back to the standard rendering.\n",
@@ -2994,7 +3061,7 @@
           ]
         },
         "textLinesEdit": {
-          "type": "any",
+          "type": "number",
           "description": "Maximum number of lines for multiline texts in edit mode.\n",
           "artifactType": "XMLProperty",
           "metadata": {
@@ -3002,7 +3069,7 @@
           }
         },
         "textMaxCharactersDisplay": {
-          "type": "any",
+          "type": "number",
           "description": "Maximum number of characters from the beginning of the text field that are shown initially.\n",
           "artifactType": "XMLProperty",
           "metadata": {
@@ -3010,7 +3077,7 @@
           }
         },
         "textMaxLength": {
-          "type": "any",
+          "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": {
@@ -3018,7 +3085,7 @@
           }
         },
         "textMaxLines": {
-          "type": "any",
+          "type": "number",
           "description": "Maximum number of lines that multiline texts in edit mode can grow to.\n",
           "artifactType": "XMLProperty",
           "metadata": {
@@ -3070,7 +3137,7 @@
           }
         },
         "navigationPropertiesForPersonalization": {
-          "type": "string",
+          "$ref": "#/definitions/string[]",
           "description": "Comma separated list of navigation properties which are considered for filtering.",
           "artifactType": "XMLProperty",
           "metadata": {
@@ -3131,7 +3198,7 @@
         },
         "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.",
+          "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 are used as filters.",
           "artifactType": "XMLProperty",
           "metadata": {
             "type": "Event"
@@ -3182,7 +3249,7 @@
           }
         },
         "navigationPropertiesForPersonalization": {
-          "type": "string",
+          "$ref": "#/definitions/string[]",
           "description": "Comma separated list of navigation properties which are considered for filtering.",
           "artifactType": "XMLProperty",
           "metadata": {
@@ -3243,7 +3310,7 @@
         },
         "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.",
+          "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 are used as filters.",
           "artifactType": "XMLProperty",
           "metadata": {
             "type": "Event"
@@ -3277,6 +3344,14 @@
             "type": "Property"
           }
         },
+        "availability": {
+          "type": "string",
+          "description": "The filter field availability.\nAllowed values are `Default`, `Adaptation`, and `Hidden`\n",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
         "key": {
           "type": "string",
           "description": "The property name of the FilterField",
@@ -3307,7 +3382,7 @@
         },
         "property": {
           "type": "string",
-          "description": "Defines which property will be influenced by the FilterField.\nThis must be a valid property of the entity as this can be used for SAP Companion integration\n",
+          "description": "Defines which property are influenced by the FilterField.\nThis must be a valid property of the entity as this can be used for SAP Companion integration\n",
           "artifactType": "XMLProperty",
           "metadata": {
             "type": "Property"
@@ -3423,11 +3498,16 @@
         },
         "layout": {
           "type": "object",
-          "description": "Defines the layout to be used within the form.\nIt defaults to the ColumnLayout, but you can also use a ResponsiveGridLayout.\nAll the properties of the ResponsiveGridLayout can be added to the configuration.",
-          "artifactType": "XMLProperty",
+          "additionalProperties": {
+            "$ref": "#/definitions/sap.fe.macros.form.FormLayoutOptions"
+          },
+          "isViewNode": false,
           "metadata": {
-            "type": "Property"
-          }
+            "path": [],
+            "type": "Aggregation",
+            "aggregationCardinality": "Single"
+          },
+          "description": "Defines the layout to be used within the form.\nIt defaults to the ColumnLayout, but you can also use a ResponsiveGridLayout.\nAll the properties of the ResponsiveGridLayout can be added to the configuration."
         },
         "metaPath": {
           "type": "string",
@@ -3462,6 +3542,203 @@
             "type": "Property"
           }
         },
+        "id": {
+          "type": "string",
+          "description": "Unique id of control",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "fields": {
+          "type": "object",
+          "additionalProperties": {
+            "$ref": "#/definitions/sap.fe.macros.FormElement"
+          },
+          "isViewNode": true,
+          "metadata": {
+            "path": [],
+            "type": "Aggregation",
+            "aggregationCardinality": "Multiple"
+          }
+        }
+      },
+      "additionalProperties": false,
+      "metadata": {
+        "path": [],
+        "type": "Control",
+        "defaultAggregation": "fields"
+      }
+    },
+    "sap.fe.macros.form.FormLayoutOptions": {
+      "description": "Configuration options for the Form layout",
+      "isViewNode": false,
+      "type": "object",
+      "properties": {
+        "adjustLabelSpan": {
+          "type": "boolean",
+          "description": "If set, the usage of `labelSpanL` and `labelSpanXL` is dependent on the size of the used column.\nIf the space is less than 600px (e.g., 2 columns are used), `labelSpanM` is used instead.\nApplicable for ResponsiveGridLayout type\n",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "backgroundDesign": {
+          "type": "string",
+          "description": "Defines the background color of the form",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "breakpointL": {
+          "type": "number",
+          "description": "The breakpoint (in pixels) between L size and XL size for the ResponsiveGridLayout\nApplicable for ResponsiveGridLayout type\n",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "breakpointM": {
+          "type": "number",
+          "description": "The breakpoint (in pixels) between M size and L size for the ResponsiveGridLayout\nApplicable for ResponsiveGridLayout type\n",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "breakpointXL": {
+          "type": "number",
+          "description": "The breakpoint (in pixels) between XL size and XXL size for the ResponsiveGridLayout\nApplicable for ResponsiveGridLayout type\n",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "columnsL": {
+          "type": "number",
+          "description": "Number of columns for L size\nApplicable for ColumnLayout type\n",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "columnsM": {
+          "type": "number",
+          "description": "Number of columns for M size\nApplicable for ColumnLayout type\n",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "columnsXL": {
+          "type": "number",
+          "description": "Number of columns for XL size\nApplicable for ColumnLayout type\n",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "emptyCellsLarge": {
+          "type": "number",
+          "description": "Number of grid cells that are empty at the end of a row in large screen size\nApplicable for ColumnLayout type\n",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "emptySpanL": {
+          "type": "number",
+          "description": "Number of empty grid cells that are added on the end of each line in L size\nApplicable for ResponsiveGridLayout type\n",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "emptySpanM": {
+          "type": "number",
+          "description": "Number of empty grid cells that are added on the end of each line in M size\nApplicable for ResponsiveGridLayout type\n",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "emptySpanS": {
+          "type": "number",
+          "description": "Number of empty grid cells that are added on the end of each line in S size\nApplicable for ResponsiveGridLayout type\n",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "emptySpanXL": {
+          "type": "number",
+          "description": "Number of empty grid cells that are added on the end of each line in XL size\nApplicable for ResponsiveGridLayout type\n",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "labelCellsLarge": {
+          "type": "number",
+          "description": "Number of grid cells that are reserved for the labels in large screen size\nApplicable for ColumnLayout type\n",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "labelSpanL": {
+          "type": "number",
+          "description": "Number of grid cells that are used for the labels in L size\nApplicable for ResponsiveGridLayout type\n",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "labelSpanM": {
+          "type": "number",
+          "description": "Number of grid cells that are used for the labels in M size\nApplicable for ResponsiveGridLayout type\n",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "labelSpanS": {
+          "type": "number",
+          "description": "Number of grid cells that are used for the labels in S size\nApplicable for ResponsiveGridLayout type\n",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "labelSpanXL": {
+          "type": "number",
+          "description": "Number of grid cells that are used for the labels in XL size\nApplicable for ResponsiveGridLayout type\n",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "singleContainerFullSize": {
+          "type": "boolean",
+          "description": "If set, a single container has the full size of the parent container.\nOtherwise, the container size is determined by the number of columns and the spacing between the columns.\nApplicable for ResponsiveGridLayout type\n",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "type": {
+          "type": "string",
+          "description": "The layout type to be used for the form",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          },
+          "enum": [
+            "ColumnLayout",
+            "ResponsiveGridLayout"
+          ]
+        },
         "id": {
           "type": "string",
           "description": "Unique id of control",
@@ -3712,6 +3989,14 @@
       "isViewNode": false,
       "type": "object",
       "properties": {
+        "showShareInWorkzone": {
+          "type": "boolean",
+          "description": "Controls visibility of the \"Share in SAP Build Work Zone\" option.\nThis option appears as either \"Share in SAP Jam\" or \"Share in SAP Build Work Zone\"\ndepending on the customer's deployment. Both labels refer to the same functionality.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
         "id": {
           "type": "string",
           "description": "Unique id of control",
@@ -3768,6 +4053,14 @@
             "type": "Property"
           }
         },
+        "visible": {
+          "type": "boolean",
+          "description": "Determines whether the action is visible.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
         "id": {
           "type": "string",
           "description": "Unique id of control",
@@ -3837,7 +4130,7 @@
           }
         },
         "text": {
-          "type": "any",
+          "type": "string",
           "description": "The text that is to be displayed for this action",
           "artifactType": "XMLProperty",
           "metadata": {
@@ -3845,14 +4138,6 @@
           },
           "i18nClassification": "BUT: Text of the action button"
         },
-        "visible": {
-          "type": "any",
-          "description": "Determines whether the action is visible.",
-          "artifactType": "XMLProperty",
-          "metadata": {
-            "type": "Property"
-          }
-        },
         "press": {
           "type": "string",
           "description": "Event handler to be called when the user chooses the action",
@@ -4483,7 +4768,8 @@
             "path": [],
             "type": "Aggregation",
             "aggregationCardinality": "Single"
-          }
+          },
+          "description": "Determines the export settings for the column."
         }
       },
       "additionalProperties": false,
@@ -4538,12 +4824,13 @@
           "additionalProperties": {
             "$ref": "#/definitions/sap.ui.layout.form.FormContainer"
           },
-          "isViewNode": true,
+          "isViewNode": false,
           "metadata": {
             "path": [],
             "type": "Aggregation",
             "aggregationCardinality": "Single"
-          }
+          },
+          "description": "The custom form container that can be displayed at the top of the mass edit dialog"
         }
       },
       "additionalProperties": false,
@@ -4991,7 +5278,8 @@
             "path": [],
             "type": "Aggregation",
             "aggregationCardinality": "Single"
-          }
+          },
+          "description": "A set of options that can be configured to control the aggregation behavior"
         },
         "columns": {
           "type": "object",
@@ -5005,6 +5293,32 @@
             "aggregationCardinality": "Multiple"
           }
         },
+        "massEdit": {
+          "type": "object",
+          "additionalProperties": {
+            "$ref": "#/definitions/sap.fe.macros.table.MassEdit"
+          },
+          "isViewNode": false,
+          "metadata": {
+            "path": [],
+            "type": "Aggregation",
+            "aggregationCardinality": "Single"
+          },
+          "description": "Aggregate mass edit of the table."
+        },
+        "quickVariantSelection": {
+          "type": "object",
+          "additionalProperties": {
+            "$ref": "#/definitions/sap.fe.macros.table.QuickVariantSelection"
+          },
+          "isViewNode": false,
+          "metadata": {
+            "path": [],
+            "type": "Aggregation",
+            "aggregationCardinality": "Single"
+          },
+          "description": "Aggregate quickVariantSelection of the table."
+        },
         "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`.\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",
@@ -5505,7 +5819,8 @@
             "path": [],
             "type": "Aggregation",
             "aggregationCardinality": "Single"
-          }
+          },
+          "description": "A set of options that can be configured to control the aggregation behavior"
         },
         "columns": {
           "type": "object",
@@ -5519,6 +5834,32 @@
             "aggregationCardinality": "Multiple"
           }
         },
+        "massEdit": {
+          "type": "object",
+          "additionalProperties": {
+            "$ref": "#/definitions/sap.fe.macros.table.MassEdit"
+          },
+          "isViewNode": false,
+          "metadata": {
+            "path": [],
+            "type": "Aggregation",
+            "aggregationCardinality": "Single"
+          },
+          "description": "Aggregate mass edit of the table."
+        },
+        "quickVariantSelection": {
+          "type": "object",
+          "additionalProperties": {
+            "$ref": "#/definitions/sap.fe.macros.table.QuickVariantSelection"
+          },
+          "isViewNode": false,
+          "metadata": {
+            "path": [],
+            "type": "Aggregation",
+            "aggregationCardinality": "Single"
+          },
+          "description": "Aggregate quickVariantSelection of the table."
+        },
         "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`.\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",