@sap/ux-specification 1.144.2 → 1.144.3

package/dist/schemas/v4/BuildingBlocksConfig.json

@@ -12,7 +12,8 @@
       "sap.fe.macros.richtexteditor",
       "sap.fe.macros.share",
       "sap.fe.macros.table",
-      "sap.fe.macros.controls.section"
+      "sap.fe.macros.controls.section",
+      "sap.fe.macros.field.mixin"
     ]
   },
   "properties": {
@@ -60,6 +61,95 @@
         "defaultAggregation": "popoverContent"
       }
     },
+    "sap.fe.macros.AlwaysEditableField": {
+      "description": "Building block for creating an always-editable field based on metadata provided by OData V4.\n\nThis building block is designed for use with JSON model bindings in custom dialogs and popups,\nwhere the field must always be editable regardless of OData metadata or draft status.\n\nWhen creating an AlwaysEditableField building block, you must provide an ID.\nUsage example:\n\n<macros:AlwaysEditableField\nid=\"MyAlwaysEditableField\"\nmetaPath=\"MyProperty\"\nvalue=\"{myJSONModel>/myValue}\"\ndescription=\"{myJSONModel>/myDescription}\" />\n\n",
+      "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.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "description": {
+          "type": "string",
+          "description": "This is used to optionally provide an external description that comes from a different model than the oData model.\nThis must be used in conjunction with the value property.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "metaPath": {
+          "type": "string",
+          "description": "Defines the relative path of the property in the metamodel, based on the current contextPath.\nAlwaysEditableField only supports metadata paths with the Property type.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "value": {
+          "type": "string",
+          "description": "This is used to optionally provide an external value that comes from a different model than the OData model.\nTypically used with JSON models for custom popup scenarios.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "vhIdPrefix": {
+          "type": "string",
+          "description": "Prefix added to the generated ID of the value help used for the field.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "id": {
+          "type": "string",
+          "description": "Unique id of control",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "formatOptions": {
+          "type": "object",
+          "additionalProperties": {
+            "$ref": "#/definitions/sap.fe.macros.field.FieldFormatOptions"
+          },
+          "isViewNode": false,
+          "metadata": {
+            "path": [],
+            "type": "Aggregation",
+            "aggregationCardinality": "Single"
+          },
+          "description": "A set of options that can be configured."
+        },
+        "change": {
+          "type": "string",
+          "description": "An event containing details is triggered when the value of the field is changed.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Event"
+          }
+        },
+        "liveChange": {
+          "type": "string",
+          "description": "An event containing details is triggered when the value of the field is live changed.\n\nNote: Browsing autocomplete suggestions does not fire the event.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Event"
+          }
+        }
+      },
+      "additionalProperties": false,
+      "metadata": {
+        "path": [],
+        "type": "Control"
+      }
+    },
     "sap.fe.macros.Chart": {
       "description": "Building block used to create a chart based on the metadata provided by OData V4.\nOverview of Building Blocks\n\t\t\t\n\nUsually, a contextPath and metaPath is expected.\nUsage example:\n\n<macros:Chart id=\"MyChart\" contextPath=\"/RootEntity\" metaPath=\"@com.sap.vocabularies.UI.v1.Chart\" />\n\n",
       "isViewNode": true,
@@ -427,6 +517,110 @@
         "type": "Control"
       }
     },
+    "sap.fe.macros.FilterBar": {
+      "description": "Building block for creating a FilterBar based on the metadata provided by OData V4.\nOverview of Building Blocks\n\t\t\t\n\nUsually, a SelectionFields annotation is expected.\nUsage example:\n\n<macros:FilterBar id=\"MyFilterBar\" metaPath=\"@com.sap.vocabularies.UI.v1.SelectionFields\" />\n\n",
+      "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.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "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.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "navigationPropertiesForPersonalization": {
+          "$ref": "#/definitions/string[]",
+          "description": "Comma separated list of navigation properties which are considered for filtering.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "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"
+          }
+        },
+        "id": {
+          "type": "string",
+          "description": "Unique id of control",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "filterFields": {
+          "type": "object",
+          "additionalProperties": {
+            "$ref": "#/definitions/sap.fe.macros.filterBar.FilterField"
+          },
+          "isViewNode": true,
+          "metadata": {
+            "path": [],
+            "type": "Aggregation",
+            "aggregationCardinality": "Multiple"
+          }
+        },
+        "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 are used as filters.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Event"
+          }
+        },
+        "search": {
+          "type": "string",
+          "description": "This event is fired when the 'Go' button is pressed or after a condition change.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Event"
+          }
+        }
+      },
+      "additionalProperties": false,
+      "metadata": {
+        "path": [],
+        "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,
@@ -1441,6 +1635,14 @@
             "type": "Property"
           }
         },
+        "initialLoad": {
+          "type": "boolean",
+          "description": "Indicates if the table should load data when initialized.\nThis property is used only if a filter bar is associated with the table and doesn't use the liveMode.\nIf set to `true`, the table loads data on initialization if the filter bar has no mandatory filters or the mandatory filters are filled in.\nIf set to `false`, the table waits for the filter bar to be filled in before loading data.\nThe default value is `false`.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
         "isSearchable": {
           "type": "boolean",
           "description": "Defines whether to display the search action.",
@@ -1889,6 +2091,14 @@
             "type": "Property"
           }
         },
+        "initialLoad": {
+          "type": "boolean",
+          "description": "Indicates if the table should load data when initialized.\nThis property is used only if a filter bar is associated with the table and doesn't use the liveMode.\nIf set to `true`, the table loads data on initialization if the filter bar has no mandatory filters or the mandatory filters are filled in.\nIf set to `false`, the table waits for the filter bar to be filled in before loading data.\nThe default value is `false`.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
         "isCopyToPositionAllowed": {
           "type": "string",
           "description": "Defines the extension point to control whether a source node can be copied to a specific parent node.\n",
@@ -3026,7 +3236,7 @@
         },
         "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.\nThe default value is true.\n",
+          "description": "Defines if the date part of a date time with timezone field is shown. \n\nThe dateTimeOffset field must have a timezone annotation.\nThe default value is true.\n",
           "artifactType": "XMLProperty",
           "metadata": {
             "type": "Property"
@@ -3050,7 +3260,7 @@
         },
         "textExpandBehaviorDisplay": {
           "type": "string",
-          "description": "Defines how the full text will be displayed.\n\nAllowed values are \"InPlace\" and \"Popover\"\n",
+          "description": "Defines how the full text is displayed.\n\nAllowed values are \"InPlace\" and \"Popover\"\n",
           "artifactType": "XMLProperty",
           "metadata": {
             "type": "Property"
@@ -3061,32 +3271,32 @@
           ]
         },
         "textLinesEdit": {
-          "type": "number",
-          "description": "Maximum number of lines for multiline texts in edit mode.\n",
+          "type": "any",
+          "description": "Maximum number of lines for multiline texts in edit mode.\nSupports int and string type.\n",
           "artifactType": "XMLProperty",
           "metadata": {
             "type": "Property"
           }
         },
         "textMaxCharactersDisplay": {
-          "type": "number",
-          "description": "Maximum number of characters from the beginning of the text field that are shown initially.\n",
+          "type": "any",
+          "description": "Maximum number of characters from the beginning of the text field that are shown initially.\nSupports int and string type.\n",
           "artifactType": "XMLProperty",
           "metadata": {
             "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",
+          "type": "any",
+          "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.\nSupports int and string type.\n",
           "artifactType": "XMLProperty",
           "metadata": {
             "type": "Property"
           }
         },
         "textMaxLines": {
-          "type": "number",
-          "description": "Maximum number of lines that multiline texts in edit mode can grow to.\n",
+          "type": "any",
+          "description": "Maximum number of lines that multiline texts in edit mode can grow to.\nSupports int and string type.\n",
           "artifactType": "XMLProperty",
           "metadata": {
             "type": "Property"
@@ -3108,7 +3318,7 @@
       }
     },
     "sap.fe.macros.filterBar.FilterBar": {
-      "description": "Usage example:\n\nsap.ui.require([\"sap/fe/macros/filterBar/FilterBar\"], function(FilterBar) {\n\t ...\n\t new FilterBar(\"MyFilterBar\", {metaPath:\"@com.sap.vocabularies.UI.v1.SelectionFields\"})\n})\n\nThis is currently an experimental API because the structure of the generated content will change to come closer to the FilterBar that you get out of templates.\nThe public method and property will not change but the internal structure will so be careful on your usage.\n",
+      "description": "Usage example:\n\nsap.ui.require([\"sap/fe/macros/filterBar/FilterBar\"], function(FilterBar) {\n\t ...\n\t new FilterBar(\"MyFilterBar\", {metaPath:\"@com.sap.vocabularies.UI.v1.SelectionFields\"})\n})\n\nThis is an experimental API because the structure of the generated content has changed to be closer to the FilterBar that you get from the templates.\nThe public method and property has not changed but the internal structure has changed so be careful on your usage.\n",
       "isViewNode": true,
       "type": "object",
       "properties": {
@@ -3160,126 +3370,6 @@
             "type": "Property"
           }
         },
-        "visible": {
-          "type": "boolean",
-          "description": "Parameter which sets the visibility of the FilterBar building block",
-          "artifactType": "XMLProperty",
-          "metadata": {
-            "type": "Property"
-          }
-        },
-        "id": {
-          "type": "string",
-          "description": "Unique id of control",
-          "artifactType": "XMLProperty",
-          "metadata": {
-            "type": "Property"
-          }
-        },
-        "filterFields": {
-          "type": "object",
-          "additionalProperties": {
-            "$ref": "#/definitions/sap.fe.macros.filterBar.FilterField"
-          },
-          "isViewNode": true,
-          "metadata": {
-            "path": [],
-            "type": "Aggregation",
-            "aggregationCardinality": "Multiple"
-          }
-        },
-        "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 are used as filters.",
-          "artifactType": "XMLProperty",
-          "metadata": {
-            "type": "Event"
-          }
-        },
-        "search": {
-          "type": "string",
-          "description": "This event is fired when the 'Go' button is pressed or after a condition change.",
-          "artifactType": "XMLProperty",
-          "metadata": {
-            "type": "Event"
-          }
-        }
-      },
-      "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.\nOverview of Building Blocks\n\t\t\t\n\nUsually, a SelectionFields annotation is expected.\nUsage example:\n\n<macros:FilterBar id=\"MyFilterBar\" metaPath=\"@com.sap.vocabularies.UI.v1.SelectionFields\" />\n\n",
-      "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.",
-          "artifactType": "XMLProperty",
-          "metadata": {
-            "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.",
-          "artifactType": "XMLProperty",
-          "metadata": {
-            "type": "Property"
-          }
-        },
-        "navigationPropertiesForPersonalization": {
-          "$ref": "#/definitions/string[]",
-          "description": "Comma separated list of navigation properties which are considered for filtering.",
-          "artifactType": "XMLProperty",
-          "metadata": {
-            "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"
-          }
-        },
         "id": {
           "type": "string",
           "description": "Unique id of control",
@@ -4461,7 +4551,7 @@
       }
     },
     "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",
+      "description": "Definition of a custom column to be used inside the table.\nThe template for the column must be provided as the default aggregation\n",
       "isViewNode": true,
       "type": "object",
       "properties": {
@@ -4581,6 +4671,19 @@
           "metadata": {
             "type": "Property"
           }
+        },
+        "aiNotice": {
+          "type": "object",
+          "additionalProperties": {
+            "$ref": "#/definitions/sap.fe.macros.table.ColumnAINotice"
+          },
+          "isViewNode": false,
+          "metadata": {
+            "path": [],
+            "type": "Aggregation",
+            "aggregationCardinality": "Single"
+          },
+          "description": "Determines the AI notice for the column.\nThe AI notice is used to display information related to AI features. This information is rendered as an icon in the column header."
         }
       },
       "additionalProperties": false,
@@ -4589,6 +4692,40 @@
         "type": "Control"
       }
     },
+    "sap.fe.macros.table.ColumnAINotice": {
+      "description": "Definition of the  AINotice applied to a column within the table.",
+      "isViewNode": true,
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Unique id of control",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "content": {
+          "type": "object",
+          "additionalProperties": {
+            "$ref": "#/definitions/sap.ui.core.Control"
+          },
+          "isViewNode": false,
+          "metadata": {
+            "path": [],
+            "type": "Aggregation",
+            "aggregationCardinality": "Single"
+          },
+          "description": "Determines the pop-up content of the AINotice to be displayed"
+        }
+      },
+      "additionalProperties": false,
+      "metadata": {
+        "path": [],
+        "type": "Control",
+        "defaultAggregation": "content"
+      }
+    },
     "sap.fe.macros.table.ColumnExportSettings": {
       "description": "Definition of the export settings applied to a column within the table.",
       "isViewNode": true,
@@ -4704,7 +4841,7 @@
         },
         "disableExport": {
           "type": "boolean",
-          "description": "Determines if the column should be excluded from the export.",
+          "description": "Determines if the column is excluded from the export.",
           "artifactType": "XMLProperty",
           "metadata": {
             "type": "Property"
@@ -4758,6 +4895,19 @@
             "type": "Property"
           }
         },
+        "aiNotice": {
+          "type": "object",
+          "additionalProperties": {
+            "$ref": "#/definitions/sap.fe.macros.table.ColumnAINotice"
+          },
+          "isViewNode": false,
+          "metadata": {
+            "path": [],
+            "type": "Aggregation",
+            "aggregationCardinality": "Single"
+          },
+          "description": "Determines the AI notice for the column.\nThe AI notice is used to display information related to AI features. This information is rendered as an icon in the column header."
+        },
         "exportSettings": {
           "type": "object",
           "additionalProperties": {
@@ -5069,6 +5219,14 @@
             "type": "Property"
           }
         },
+        "initialLoad": {
+          "type": "boolean",
+          "description": "Indicates if the table should load data when initialized.\nThis property is used only if a filter bar is associated with the table and doesn't use the liveMode.\nIf set to `true`, the table loads data on initialization if the filter bar has no mandatory filters or the mandatory filters are filled in.\nIf set to `false`, the table waits for the filter bar to be filled in before loading data.\nThe default value is `false`.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
         "isSearchable": {
           "type": "boolean",
           "description": "Defines whether to display the search action.",
@@ -5582,6 +5740,14 @@
             "type": "Property"
           }
         },
+        "initialLoad": {
+          "type": "boolean",
+          "description": "Indicates if the table should load data when initialized.\nThis property is used only if a filter bar is associated with the table and doesn't use the liveMode.\nIf set to `true`, the table loads data on initialization if the filter bar has no mandatory filters or the mandatory filters are filled in.\nIf set to `false`, the table waits for the filter bar to be filled in before loading data.\nThe default value is `false`.",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        },
         "isCopyToPositionAllowed": {
           "type": "string",
           "description": "Defines the extension point to control whether a source node can be copied to a specific parent node.\n",
@@ -5956,6 +6122,26 @@
         "type": "Control"
       }
     },
+    "sap.fe.macros.field.mixin.FieldMixin": {
+      "description": "Mixin providing control access, value getter and setter, enabled state management, and message handling for field controls.\nThis mixin combines the following functionalities:\n1. FieldControlAccessor: access to the inner control of field-based building blocks\n2. FieldValueAccessor: value getter and setter and enablement getter and setter\n3. FieldMessageHandler: adding and managing validation messages\nThis mixin enables building blocks to programmatically read and write values, enabled state,\nand validation messages across different control types (CheckBox, Input, and MDC Field).\n",
+      "isViewNode": true,
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Unique id of control",
+          "artifactType": "XMLProperty",
+          "metadata": {
+            "type": "Property"
+          }
+        }
+      },
+      "additionalProperties": false,
+      "metadata": {
+        "path": [],
+        "type": "Control"
+      }
+    },
     "sap.fe.macros.ActionGroup": {
       "description": "Definition of a actions group to be used inside the table toolbar",
       "isViewNode": true,