@ui5/webcomponents 2.8.0-rc.2 → 2.8.0-rc.3

package/dist/custom-elements.json

@@ -1054,7 +1054,7 @@
           "slots": [
             {
               "name": "default",
-              "description": "Receives the desired `<img>` tag\n\n**Note:** If you experience flickering of the provided image, you can hide the component until it is being defined with the following CSS:"
+              "description": "Receives the desired `<img>` tag\n\n**Note:** If you experience flickering of the provided image, you can hide the component until it is defined with the following CSS:<br/>\n`ui5-avatar:not(:defined) {`<br/>\n&nbsp;&nbsp;&nbsp;&nbsp;`visibility: hidden;`<br/>\n`}`"
             },
             {
               "name": "badge",
@@ -16636,6 +16636,16 @@
               "default": "undefined",
               "privacy": "public"
             },
+            {
+              "kind": "field",
+              "name": "tooltip",
+              "type": {
+                "text": "string | undefined"
+              },
+              "description": "Defines the tooltip of the select.",
+              "default": "undefined",
+              "privacy": "public"
+            },
             {
               "kind": "field",
               "name": "value",
@@ -16773,6 +16783,15 @@
                 "text": "string | undefined"
               }
             },
+            {
+              "description": "Defines the tooltip of the select.",
+              "name": "tooltip",
+              "default": "undefined",
+              "fieldName": "tooltip",
+              "type": {
+                "text": "string | undefined"
+              }
+            },
             {
               "description": "Defines the value of the component:\n\n- when get - returns the value of the component, e.g. the `value` property of the selected option or its text content.\n\n- when set - selects the option with matching `value` property or text content.\n\n**Note:** If the given value does not match any existing option,\nthe first option will get selected.",
               "name": "value",
@@ -20024,10 +20043,10 @@
               "kind": "field",
               "name": "rowKey",
               "type": {
-                "text": "string"
+                "text": "string | undefined"
               },
-              "default": "\"\"",
-              "description": "Unique identifier of the row.",
+              "description": "Unique identifier of the row.\n\n**Note:** For selection features to work properly, this property is mandatory, and its value must not contain spaces.",
+              "default": "undefined",
               "privacy": "public"
             },
             {
@@ -20037,7 +20056,7 @@
                 "text": "number"
               },
               "default": "-1",
-              "description": "Defines the position of the row respect to the total number of rows within the table when the `ui5-table-virtualizer` feature is used.",
+              "description": "Defines the position of the row related to the total number of rows within the table when the `ui5-table-virtualizer` feature is used.",
               "privacy": "public"
             },
             {
@@ -20073,16 +20092,16 @@
           ],
           "attributes": [
             {
-              "description": "Unique identifier of the row.",
+              "description": "Unique identifier of the row.\n\n**Note:** For selection features to work properly, this property is mandatory, and its value must not contain spaces.",
               "name": "row-key",
-              "default": "\"\"",
+              "default": "undefined",
               "fieldName": "rowKey",
               "type": {
-                "text": "string"
+                "text": "string | undefined"
               }
             },
             {
-              "description": "Defines the position of the row respect to the total number of rows within the table when the `ui5-table-virtualizer` feature is used.",
+              "description": "Defines the position of the row related to the total number of rows within the table when the `ui5-table-virtualizer` feature is used.",
               "name": "position",
               "default": "-1",
               "fieldName": "position",
@@ -20152,7 +20171,7 @@
       "declarations": [
         {
           "kind": "class",
-          "description": "The `TableRowAction` class defines a row action for table rows.",
+          "description": "### Overview\n\nThe `ui5-table-row-action` component defines an action for table rows.\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents/dist/TableRowAction.js\";`",
           "name": "TableRowAction",
           "members": [
             {
@@ -20175,16 +20194,6 @@
               "description": "Defines the text of the row action.\n\n**Note:** For row actions to work properly, this property is mandatory.",
               "privacy": "public"
             },
-            {
-              "kind": "field",
-              "name": "disabled",
-              "type": {
-                "text": "boolean"
-              },
-              "default": "false",
-              "description": "Defines the disabled state of the row action.",
-              "privacy": "public"
-            },
             {
               "kind": "field",
               "name": "invisible",
@@ -20219,15 +20228,6 @@
                 "text": "string"
               }
             },
-            {
-              "description": "Defines the disabled state of the row action.",
-              "name": "disabled",
-              "default": "false",
-              "fieldName": "disabled",
-              "type": {
-                "text": "boolean"
-              }
-            },
             {
               "description": "Defines the visibility of the row action.\n\n**Note:** Invisible row actions still take up space, allowing to hide the action while maintaining its position.",
               "name": "invisible",
@@ -20439,7 +20439,7 @@
       "declarations": [
         {
           "kind": "class",
-          "description": "### Overview\n\nThe `ui5-table-selection` component is used inside the `ui5-table` ti add key-based selection capabilities to the `ui5-table`.\n\nThe component offers three selection modes:\n* Single - select a single row.\n* Multiple - select multiple rows.\n* None - no selection active.\n\nAs the selection is key-based, `ui5-table-row` components need to define a unique `row-key` property.\n\n### Usage\n\nThe `ui5-table-selection` component is only used inside the `ui5-table` component as a feature.\nIt has to be slotted inside the `ui5-table` in the `features` slot.\nThe component is not intended to be used as a standalone component.\n\n```html\n<ui5-table>\n\t<ui5-table-selection mode=\"Multiple\" slot=\"features\"></ui5-table-selection>\n</ui5-table>\n```\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents/dist/TableSelection.js\";`",
+          "description": "### Overview\n\nThe `ui5-table-selection` component is used inside the `ui5-table` to add key-based selection capabilities to the `ui5-table`.\n\nThe component offers three selection modes:\n* Single - select a single row.\n* Multiple - select multiple rows.\n* None - no selection active.\n\nAs the selection is key-based, `ui5-table-row` components need to define a unique `row-key` property.\n\n### Usage\n\nThe `ui5-table-selection` component is only used inside the `ui5-table` component as a feature.\nIt has to be slotted inside the `ui5-table` in the `features` slot.\nThe component is not intended to be used as a standalone component.\n\n```html\n<ui5-table>\n\t<ui5-table-selection mode=\"Multiple\" slot=\"features\"></ui5-table-selection>\n</ui5-table>\n```\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents/dist/TableSelection.js\";`",
           "name": "TableSelection",
           "members": [
             {
@@ -20476,7 +20476,7 @@
               "type": {
                 "text": "CustomEvent"
               },
-              "description": "Fired when selection is changed by user interaction."
+              "description": "Fired when the selection is changed by user interaction."
             }
           ],
           "attributes": [
@@ -20504,6 +20504,7 @@
             "package": "@ui5/webcomponents-base",
             "module": "dist/UI5Element.js"
           },
+          "deprecated": "This component is deprecated and will be removed in future releases. Use the `ui5-table-selection-single` or `ui5-table-selection-multi` components instead.",
           "tagName": "ui5-table-selection",
           "customElement": true
         }
@@ -20527,6 +20528,680 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "dist/TableSelectionBase.js",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "The `TableSelectionBase` class serves as a foundation for table selections.",
+          "name": "TableSelectionBase",
+          "members": [
+            {
+              "kind": "field",
+              "name": "selected",
+              "type": {
+                "text": "string | undefined"
+              },
+              "description": "Defines the selected elements of the component.",
+              "default": "undefined",
+              "privacy": "public"
+            },
+            {
+              "kind": "method",
+              "name": "getRowKey",
+              "return": {
+                "type": {
+                  "text": "string"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "row",
+                  "type": {
+                    "text": "TableRow",
+                    "references": [
+                      {
+                        "name": "TableRow",
+                        "package": "@ui5/webcomponents",
+                        "module": "dist/TableRow.js"
+                      }
+                    ]
+                  },
+                  "description": "The row instance"
+                }
+              ],
+              "description": "Returns the unique key associated with the table row.",
+              "privacy": "public"
+            },
+            {
+              "kind": "method",
+              "name": "getRowByKey",
+              "return": {
+                "type": {
+                  "text": "TableRow | undefined",
+                  "references": [
+                    {
+                      "name": "TableRow",
+                      "package": "@ui5/webcomponents",
+                      "module": "dist/TableRow.js"
+                    }
+                  ]
+                }
+              },
+              "parameters": [
+                {
+                  "name": "rowKey",
+                  "type": {
+                    "text": "string"
+                  },
+                  "description": "The row key"
+                }
+              ],
+              "description": "Returns the table row instance for the given row key.",
+              "privacy": "public"
+            },
+            {
+              "kind": "method",
+              "name": "isSelected",
+              "return": {
+                "type": {
+                  "text": "boolean"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "row",
+                  "type": {
+                    "text": "TableRowBase",
+                    "references": [
+                      {
+                        "name": "TableRowBase",
+                        "package": "@ui5/webcomponents",
+                        "module": "dist/TableRowBase.js"
+                      }
+                    ]
+                  },
+                  "description": "The row instance"
+                }
+              ],
+              "description": "Determines whether the specified table row is currently selected.",
+              "privacy": "public"
+            },
+            {
+              "kind": "method",
+              "name": "setSelected",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "row",
+                  "type": {
+                    "text": "TableRowBase",
+                    "references": [
+                      {
+                        "name": "TableRowBase",
+                        "package": "@ui5/webcomponents",
+                        "module": "dist/TableRowBase.js"
+                      }
+                    ]
+                  },
+                  "description": "The row instance"
+                },
+                {
+                  "name": "selected",
+                  "type": {
+                    "text": "boolean"
+                  },
+                  "description": "Whether the row is selected"
+                }
+              ],
+              "description": "Sets the selected state of the specified table row.",
+              "privacy": "public"
+            }
+          ],
+          "events": [
+            {
+              "name": "change",
+              "type": {
+                "text": "CustomEvent"
+              },
+              "description": "Fired when the selection is changed by user interaction."
+            }
+          ],
+          "attributes": [
+            {
+              "description": "Defines the selected elements of the component.",
+              "name": "selected",
+              "default": "undefined",
+              "fieldName": "selected",
+              "type": {
+                "text": "string | undefined"
+              }
+            }
+          ],
+          "superclass": {
+            "name": "UI5Element",
+            "package": "@ui5/webcomponents-base",
+            "module": "dist/UI5Element.js"
+          },
+          "customElement": true
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "default",
+          "declaration": {
+            "name": "TableSelectionBase",
+            "module": "dist/TableSelectionBase.js"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "dist/TableSelectionMulti.js",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "### Overview\n\nThe `ui5-table-selection-multi` component is used inside the `ui5-table` to add multi-selection capabilities to the `ui5-table`.\nSince selection is key-based, each `ui5-table-row` must define a unique `row-key` property.\n\n### Usage\n\nThe `ui5-table-selection-multi` component is a feature designed exclusively for use within the `ui5-table` component.\nIt must be placed inside the `features` slot of `ui5-table`.\nThis component is not intended for standalone use.\n\n```html\n<ui5-table>\n\t<ui5-table-selection-multi slot=\"features\" selected=\"Row1 Row3\"></ui5-table-selection-multi>\n</ui5-table>\n```\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents/dist/TableSelectionMulti.js\";`",
+          "name": "TableSelectionMulti",
+          "members": [
+            {
+              "kind": "field",
+              "name": "selected",
+              "type": {
+                "text": "string | undefined"
+              },
+              "description": "Defines the `row-key` values of selected rows, with each value separated by a space.",
+              "default": "undefined",
+              "privacy": "public",
+              "inheritedFrom": {
+                "name": "TableSelectionBase",
+                "module": "dist/TableSelectionBase.js"
+              }
+            },
+            {
+              "kind": "method",
+              "name": "getSelectedRows",
+              "return": {
+                "type": {
+                  "text": "Array<TableRow>",
+                  "references": [
+                    {
+                      "name": "TableRow",
+                      "package": "@ui5/webcomponents",
+                      "module": "dist/TableRow.js"
+                    }
+                  ]
+                }
+              },
+              "description": "Returns an array of the selected rows.",
+              "privacy": "public"
+            },
+            {
+              "kind": "method",
+              "name": "areAllRowsSelected",
+              "return": {
+                "type": {
+                  "text": "boolean"
+                }
+              },
+              "description": "Determines whether all rows are selected.",
+              "privacy": "public"
+            },
+            {
+              "kind": "method",
+              "name": "getSelectedAsSet",
+              "return": {
+                "type": {
+                  "text": "Set<string>"
+                }
+              },
+              "description": "Returns the `selected` property as a set of unique `row-key` values.",
+              "privacy": "public"
+            },
+            {
+              "kind": "method",
+              "name": "setSelectedAsSet",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "selectedSet",
+                  "type": {
+                    "text": "Set<string>"
+                  },
+                  "description": "A set of `row-key` values"
+                }
+              ],
+              "description": "Sets the `selected` property using the provided set of unique `row-key` values.",
+              "privacy": "public"
+            },
+            {
+              "kind": "method",
+              "name": "getRowKey",
+              "return": {
+                "type": {
+                  "text": "string"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "row",
+                  "type": {
+                    "text": "TableRow",
+                    "references": [
+                      {
+                        "name": "TableRow",
+                        "package": "@ui5/webcomponents",
+                        "module": "dist/TableRow.js"
+                      }
+                    ]
+                  },
+                  "description": "The row instance"
+                }
+              ],
+              "description": "Returns the unique key associated with the table row.",
+              "privacy": "public",
+              "inheritedFrom": {
+                "name": "TableSelectionBase",
+                "module": "dist/TableSelectionBase.js"
+              }
+            },
+            {
+              "kind": "method",
+              "name": "getRowByKey",
+              "return": {
+                "type": {
+                  "text": "TableRow | undefined",
+                  "references": [
+                    {
+                      "name": "TableRow",
+                      "package": "@ui5/webcomponents",
+                      "module": "dist/TableRow.js"
+                    }
+                  ]
+                }
+              },
+              "parameters": [
+                {
+                  "name": "rowKey",
+                  "type": {
+                    "text": "string"
+                  },
+                  "description": "The row key"
+                }
+              ],
+              "description": "Returns the table row instance for the given row key.",
+              "privacy": "public",
+              "inheritedFrom": {
+                "name": "TableSelectionBase",
+                "module": "dist/TableSelectionBase.js"
+              }
+            },
+            {
+              "kind": "method",
+              "name": "isSelected",
+              "return": {
+                "type": {
+                  "text": "boolean"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "row",
+                  "type": {
+                    "text": "TableRowBase",
+                    "references": [
+                      {
+                        "name": "TableRowBase",
+                        "package": "@ui5/webcomponents",
+                        "module": "dist/TableRowBase.js"
+                      }
+                    ]
+                  },
+                  "description": "The row instance"
+                }
+              ],
+              "description": "Determines whether the specified table row is currently selected.",
+              "privacy": "public",
+              "inheritedFrom": {
+                "name": "TableSelectionBase",
+                "module": "dist/TableSelectionBase.js"
+              }
+            },
+            {
+              "kind": "method",
+              "name": "setSelected",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "row",
+                  "type": {
+                    "text": "TableRowBase",
+                    "references": [
+                      {
+                        "name": "TableRowBase",
+                        "package": "@ui5/webcomponents",
+                        "module": "dist/TableRowBase.js"
+                      }
+                    ]
+                  },
+                  "description": "The row instance"
+                },
+                {
+                  "name": "selected",
+                  "type": {
+                    "text": "boolean"
+                  },
+                  "description": "Whether the row is selected"
+                }
+              ],
+              "description": "Sets the selected state of the specified table row.",
+              "privacy": "public",
+              "inheritedFrom": {
+                "name": "TableSelectionBase",
+                "module": "dist/TableSelectionBase.js"
+              }
+            }
+          ],
+          "attributes": [
+            {
+              "description": "Defines the `row-key` values of selected rows, with each value separated by a space.",
+              "name": "selected",
+              "default": "undefined",
+              "fieldName": "selected",
+              "type": {
+                "text": "string | undefined"
+              },
+              "inheritedFrom": {
+                "name": "TableSelectionBase",
+                "module": "dist/TableSelectionBase.js"
+              }
+            }
+          ],
+          "superclass": {
+            "name": "TableSelectionBase",
+            "package": "@ui5/webcomponents",
+            "module": "dist/TableSelectionBase.js"
+          },
+          "tagName": "ui5-table-selection-multi",
+          "customElement": true,
+          "events": [
+            {
+              "name": "change",
+              "type": {
+                "text": "CustomEvent"
+              },
+              "description": "Fired when the selection is changed by user interaction.",
+              "inheritedFrom": {
+                "name": "TableSelectionBase",
+                "module": "dist/TableSelectionBase.js"
+              }
+            }
+          ]
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "default",
+          "declaration": {
+            "name": "TableSelectionMulti",
+            "module": "dist/TableSelectionMulti.js"
+          }
+        },
+        {
+          "kind": "custom-element-definition",
+          "name": "ui5-table-selection-multi",
+          "declaration": {
+            "name": "TableSelectionMulti",
+            "module": "dist/TableSelectionMulti.js"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "dist/TableSelectionSingle.js",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "### Overview\n\nThe `ui5-table-selection-single` component is used inside the `ui5-table` to add single selection capabilities to the `ui5-table`.\nSince selection is key-based, each `ui5-table-row` must define a unique `row-key` property.\n\n### Usage\n\nThe `ui5-table-selection-single` component is a feature designed exclusively for use within the `ui5-table` component.\nIt must be placed inside the `features` slot of `ui5-table`.\nThis component is not intended for standalone use.\n\n```html\n<ui5-table>\n\t<ui5-table-selection-single slot=\"features\" selected=\"Row1\"></ui5-table-selection-single>\n</ui5-table>\n```\n\n### ES6 Module Import\n\n`import \"@ui5/webcomponents/dist/TableSelectionSingle.js\";`",
+          "name": "TableSelectionSingle",
+          "members": [
+            {
+              "kind": "field",
+              "name": "selected",
+              "type": {
+                "text": "string | undefined"
+              },
+              "description": "Defines the `row-key` value of the selected row.",
+              "default": "undefined",
+              "privacy": "public",
+              "inheritedFrom": {
+                "name": "TableSelectionBase",
+                "module": "dist/TableSelectionBase.js"
+              }
+            },
+            {
+              "kind": "method",
+              "name": "getSelectedRow",
+              "return": {
+                "type": {
+                  "text": "TableRow | undefined",
+                  "references": [
+                    {
+                      "name": "TableRow",
+                      "package": "@ui5/webcomponents",
+                      "module": "dist/TableRow.js"
+                    }
+                  ]
+                }
+              },
+              "description": "Returns the selected row.",
+              "privacy": "public"
+            },
+            {
+              "kind": "method",
+              "name": "getRowKey",
+              "return": {
+                "type": {
+                  "text": "string"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "row",
+                  "type": {
+                    "text": "TableRow",
+                    "references": [
+                      {
+                        "name": "TableRow",
+                        "package": "@ui5/webcomponents",
+                        "module": "dist/TableRow.js"
+                      }
+                    ]
+                  },
+                  "description": "The row instance"
+                }
+              ],
+              "description": "Returns the unique key associated with the table row.",
+              "privacy": "public",
+              "inheritedFrom": {
+                "name": "TableSelectionBase",
+                "module": "dist/TableSelectionBase.js"
+              }
+            },
+            {
+              "kind": "method",
+              "name": "getRowByKey",
+              "return": {
+                "type": {
+                  "text": "TableRow | undefined",
+                  "references": [
+                    {
+                      "name": "TableRow",
+                      "package": "@ui5/webcomponents",
+                      "module": "dist/TableRow.js"
+                    }
+                  ]
+                }
+              },
+              "parameters": [
+                {
+                  "name": "rowKey",
+                  "type": {
+                    "text": "string"
+                  },
+                  "description": "The row key"
+                }
+              ],
+              "description": "Returns the table row instance for the given row key.",
+              "privacy": "public",
+              "inheritedFrom": {
+                "name": "TableSelectionBase",
+                "module": "dist/TableSelectionBase.js"
+              }
+            },
+            {
+              "kind": "method",
+              "name": "isSelected",
+              "return": {
+                "type": {
+                  "text": "boolean"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "row",
+                  "type": {
+                    "text": "TableRowBase",
+                    "references": [
+                      {
+                        "name": "TableRowBase",
+                        "package": "@ui5/webcomponents",
+                        "module": "dist/TableRowBase.js"
+                      }
+                    ]
+                  },
+                  "description": "The row instance"
+                }
+              ],
+              "description": "Determines whether the specified table row is currently selected.",
+              "privacy": "public",
+              "inheritedFrom": {
+                "name": "TableSelectionBase",
+                "module": "dist/TableSelectionBase.js"
+              }
+            },
+            {
+              "kind": "method",
+              "name": "setSelected",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "row",
+                  "type": {
+                    "text": "TableRowBase",
+                    "references": [
+                      {
+                        "name": "TableRowBase",
+                        "package": "@ui5/webcomponents",
+                        "module": "dist/TableRowBase.js"
+                      }
+                    ]
+                  },
+                  "description": "The row instance"
+                },
+                {
+                  "name": "selected",
+                  "type": {
+                    "text": "boolean"
+                  },
+                  "description": "Whether the row is selected"
+                }
+              ],
+              "description": "Sets the selected state of the specified table row.",
+              "privacy": "public",
+              "inheritedFrom": {
+                "name": "TableSelectionBase",
+                "module": "dist/TableSelectionBase.js"
+              }
+            }
+          ],
+          "attributes": [
+            {
+              "description": "Defines the `row-key` value of the selected row.",
+              "name": "selected",
+              "default": "undefined",
+              "fieldName": "selected",
+              "type": {
+                "text": "string | undefined"
+              },
+              "inheritedFrom": {
+                "name": "TableSelectionBase",
+                "module": "dist/TableSelectionBase.js"
+              }
+            }
+          ],
+          "superclass": {
+            "name": "TableSelectionBase",
+            "package": "@ui5/webcomponents",
+            "module": "dist/TableSelectionBase.js"
+          },
+          "tagName": "ui5-table-selection-single",
+          "customElement": true,
+          "events": [
+            {
+              "name": "change",
+              "type": {
+                "text": "CustomEvent"
+              },
+              "description": "Fired when the selection is changed by user interaction.",
+              "inheritedFrom": {
+                "name": "TableSelectionBase",
+                "module": "dist/TableSelectionBase.js"
+              }
+            }
+          ]
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "default",
+          "declaration": {
+            "name": "TableSelectionSingle",
+            "module": "dist/TableSelectionSingle.js"
+          }
+        },
+        {
+          "kind": "custom-element-definition",
+          "name": "ui5-table-selection-single",
+          "declaration": {
+            "name": "TableSelectionSingle",
+            "module": "dist/TableSelectionSingle.js"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "dist/TableUtils.js",