@sapudex/web-components 0.114.2 → 0.127.6

package/dist/web-types.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json",
   "name": "@sapudex/web-components",
-  "version": "0.114.2",
+  "version": "0.127.6",
   "description-markup": "markdown",
   "contributions": {
     "html": {
@@ -54,7 +54,7 @@
             },
             {
               "name": "title",
-              "description": "Defines the title of the accordion item component.",
+              "description": "Defines the title of the accordion item component.\nTODO: With transition to UI5 2.x, change \"title\" attribute name.\nTitle property is also valid HTML attribute that results in showing hover tooltip and is read by screen readers.",
               "value": { "type": "string", "default": "\"\"" }
             },
             {
@@ -89,7 +89,7 @@
               },
               {
                 "name": "title",
-                "description": "Defines the title of the accordion item component.",
+                "description": "Defines the title of the accordion item component.\nTODO: With transition to UI5 2.x, change \"title\" attribute name.\nTitle property is also valid HTML attribute that results in showing hover tooltip and is read by screen readers.",
                 "value": { "type": "string" }
               },
               {
@@ -164,11 +164,16 @@
             },
             {
               "name": "size",
-              "description": "Controls id of the element that label the component",
+              "description": "Defines predefined size of the component.",
               "value": {
                 "type": "\"XS\" | \"S\" | \"M\" | \"L\" | \"XL\"",
                 "default": "\"S\""
               }
+            },
+            {
+              "name": "show-attention-badge",
+              "description": "Defines the displaying attention badge.",
+              "value": { "type": "boolean", "default": "false" }
             }
           ],
           "slots": [
@@ -228,13 +233,26 @@
               },
               {
                 "name": "size",
-                "description": "Controls id of the element that label the component",
+                "description": "Defines predefined size of the component.",
                 "value": { "type": "\"XS\" | \"S\" | \"M\" | \"L\" | \"XL\"" }
+              },
+              {
+                "name": "show-attention-badge",
+                "description": "Defines the displaying attention badge.",
+                "value": { "type": "boolean" }
               }
             ],
             "events": []
           }
         },
+        {
+          "name": "udex-avatar-group",
+          "description": "<h3 class=\"comment-api-title\">Overview</h3>\n\n\n<h3>Usage</h3>\n\nFor the <code>udex-avatar-group</code>\n<h3>ES6 Module Import</h3>\n\n<code>import \"@udex/web-components/dist/AvatarGroup.js\";</code>\n---\n",
+          "doc-url": "",
+          "attributes": [],
+          "events": [],
+          "js": { "properties": [], "events": [] }
+        },
         {
           "name": "udex-badge",
           "description": "<h3 class=\"comment-api-title\">Overview</h3>\n\n\n<h3>Usage</h3>\n\nFor the <code>udex-badge</code>\n<h3>ES6 Module Import</h3>\n\n<code>import \"@udex/web-components/dist/Badge.js\";</code>\n---\n\n\n### **Slots:**\n - **default** - Defines the content of the component.",
@@ -965,9 +983,14 @@
               "description": "Allows setting a custom role.",
               "value": {
                 "type": "\"None\" | \"Dialog\" | \"AlertDialog\"",
-                "default": "\"Dialog\""
+                "default": "\"None\""
               }
             },
+            {
+              "name": "trigger-accessible-role",
+              "description": "Allows setting a custom role for dropdown trigger.",
+              "value": { "type": "string", "default": "\"combobox\"" }
+            },
             {
               "name": "open",
               "description": "Indicates if the dropdown pane is open",
@@ -1050,6 +1073,11 @@
                 "description": "Allows setting a custom role.",
                 "value": { "type": "\"None\" | \"Dialog\" | \"AlertDialog\"" }
               },
+              {
+                "name": "trigger-accessible-role",
+                "description": "Allows setting a custom role for dropdown trigger.",
+                "value": { "type": "string" }
+              },
               {
                 "name": "open",
                 "description": "Indicates if the dropdown pane is open",
@@ -1174,9 +1202,14 @@
               "description": "Allows setting a custom role.",
               "value": {
                 "type": "\"None\" | \"Dialog\" | \"AlertDialog\"",
-                "default": "\"Dialog\""
+                "default": "\"None\""
               }
             },
+            {
+              "name": "trigger-accessible-role",
+              "description": "Allows setting a custom role for dropdown trigger.",
+              "value": { "type": "string", "default": "\"combobox\"" }
+            },
             {
               "name": "no-result-text",
               "description": "Defines the \"no result\" text of the component.",
@@ -1324,6 +1357,11 @@
                 "description": "Allows setting a custom role.",
                 "value": { "type": "\"None\" | \"Dialog\" | \"AlertDialog\"" }
               },
+              {
+                "name": "trigger-accessible-role",
+                "description": "Allows setting a custom role for dropdown trigger.",
+                "value": { "type": "string" }
+              },
               {
                 "name": "no-result-text",
                 "description": "Defines the \"no result\" text of the component.",
@@ -1792,6 +1830,11 @@
           "description": "<h3 class=\"comment-api-title\">Overview</h3>\n\n\n<h3>Usage</h3>\n\nFor the <code>udex-footer</code>\n<h3>ES6 Module Import</h3>\n\n<code>import @udex/web-components/dist/Footer.js\";</code>\n---\n\n\n### **Events:**\n - **logo-click** - Triggered on click interaction with logo in footer\n- **back-to-top-click** - Triggered on click interaction with \"Back to Top\" button\n- **contact-phone-click** - Triggered on click interaction with phone number link in footer\n- **contact-phone-local-numbers-click** - Triggered on click interaction with local country numbers list link\n- **contact-email-click** - Triggered on click interaction with \"Contact us by email\" link\n- **contact-chat-click** - Triggered on click interaction with \"Contact us by chat\" link\n- **quick-links-click** - Triggered on click interaction with a link within \"Quick Links\" category\n- **trending-click** - Triggered on click interaction with a link within \"Trending\" category\n- **about-sap-click** - Triggered on click interaction with a link within \"About SAP\" category\n- **site-information-click** - Triggered on click interaction with a link within \"Site Information\" category\n- **social-media-link-click** - Triggered on click interaction with any of the social media links within footer",
           "doc-url": "",
           "attributes": [
+            {
+              "name": "logo-title",
+              "description": "Defines the Logo default title",
+              "value": { "type": "string", "default": "\"\"" }
+            },
             {
               "name": "logo-url",
               "description": "Defines the Logo URL",
@@ -1851,6 +1894,11 @@
               "name": "logo-alt",
               "description": "Alt for Logo",
               "value": { "type": "string", "default": "\"\"" }
+            },
+            {
+              "name": "logo-aria-label",
+              "description": "Defines an aria label for the logo link",
+              "value": { "type": "string" }
             }
           ],
           "events": [
@@ -1901,6 +1949,11 @@
           ],
           "js": {
             "properties": [
+              {
+                "name": "logo-title",
+                "description": "Defines the Logo default title",
+                "value": { "type": "string" }
+              },
               {
                 "name": "logo-url",
                 "description": "Defines the Logo URL",
@@ -1960,6 +2013,11 @@
                 "name": "logo-alt",
                 "description": "Alt for Logo",
                 "value": { "type": "string" }
+              },
+              {
+                "name": "logo-aria-label",
+                "description": "Defines an aria label for the logo link",
+                "value": { "type": "string" }
               }
             ],
             "events": [
@@ -3222,6 +3280,11 @@
               "description": "Defines the Logo image URL",
               "value": { "type": "string", "default": "\"\"" }
             },
+            {
+              "name": "logo-title",
+              "description": "Defines the Logo default title",
+              "value": { "type": "string", "default": "\"\"" }
+            },
             {
               "name": "site-label",
               "description": "Defines a site label. It will be displayed next to a logo.",
@@ -3303,6 +3366,11 @@
                 "description": "Defines the Logo image URL",
                 "value": { "type": "string" }
               },
+              {
+                "name": "logo-title",
+                "description": "Defines the Logo default title",
+                "value": { "type": "string" }
+              },
               {
                 "name": "site-label",
                 "description": "Defines a site label. It will be displayed next to a logo.",
@@ -3901,11 +3969,6 @@
           "description": "<h3 class=\"comment-api-title\">Overview</h3>\n\n\n<h3>Usage</h3>\n\nFor the <code>udex-password-field</code>\n<h3>ES6 Module Import</h3>\n\n<code>import \"@udex/web-components/dist/UDExPasswordField.js\";</code>\n---\n",
           "doc-url": "",
           "attributes": [
-            {
-              "name": "type",
-              "description": "Defines supporting text under the input field.",
-              "value": { "type": "string", "default": "\"\"" }
-            },
             {
               "name": "disabled",
               "description": "Defines whether the component is in disabled state.\n<br><br>\n<b>Note:</b> A disabled component is completely noninteractive.",
@@ -3934,10 +3997,7 @@
             {
               "name": "value-state",
               "description": "Defines the value state of the component.",
-              "value": {
-                "type": "\"Success\" | \"Error\" | \"Warning\" | \"Standard\"",
-                "default": "\"Standard\""
-              }
+              "value": { "type": "ValueState", "default": "\"Standard\"" }
             },
             {
               "name": "supporting-text",
@@ -3978,11 +4038,6 @@
           "events": [],
           "js": {
             "properties": [
-              {
-                "name": "type",
-                "description": "Defines supporting text under the input field.",
-                "value": { "type": "string" }
-              },
               {
                 "name": "disabled",
                 "description": "Defines whether the component is in disabled state.\n<br><br>\n<b>Note:</b> A disabled component is completely noninteractive.",
@@ -4011,9 +4066,7 @@
               {
                 "name": "value-state",
                 "description": "Defines the value state of the component.",
-                "value": {
-                  "type": "\"Success\" | \"Error\" | \"Warning\" | \"Standard\""
-                }
+                "value": { "type": "ValueState" }
               },
               {
                 "name": "supporting-text",
@@ -4311,6 +4364,49 @@
           "events": [],
           "js": { "properties": [], "events": [] }
         },
+        {
+          "name": "udex-rating-bar",
+          "description": "<h3 class=\"comment-api-title\">Overview</h3>\n\n\n<h3>Usage</h3>\n\nFor the <code>udex-rating-bar</code>\n<h3>ES6 Module Import</h3>\n\n<code>import \"@udex/web-components/dist/RatingBar.js\";</code>\n---\n",
+          "doc-url": "",
+          "attributes": [
+            {
+              "name": "rating",
+              "description": "Defines the associated rating.",
+              "value": { "type": "number", "default": "0" }
+            },
+            {
+              "name": "percentage",
+              "description": "Defines the percentage.",
+              "value": { "type": "number", "default": "0" }
+            },
+            {
+              "name": "show-percentage",
+              "description": "Defines wether the percentage is shown or not.",
+              "value": { "type": "boolean", "default": "false" }
+            }
+          ],
+          "events": [],
+          "js": {
+            "properties": [
+              {
+                "name": "rating",
+                "description": "Defines the associated rating.",
+                "value": { "type": "number" }
+              },
+              {
+                "name": "percentage",
+                "description": "Defines the percentage.",
+                "value": { "type": "number" }
+              },
+              {
+                "name": "show-percentage",
+                "description": "Defines wether the percentage is shown or not.",
+                "value": { "type": "boolean" }
+              }
+            ],
+            "events": []
+          }
+        },
         {
           "name": "udex-rating-indicator",
           "description": "### Overview\n\n### ES6 Module Import\n\n`import @udex/web-components/dist/RatingIndicator.js\";`\n---\n",
@@ -4347,9 +4443,53 @@
             "events": []
           }
         },
+        {
+          "name": "udex-review",
+          "description": "<h3 class=\"comment-api-title\">Overview</h3>\n\n\n<h3>Usage</h3>\n\nFor the <code>udex-review</code>\n<h3>ES6 Module Import</h3>\n\n<code>import \"@udex/web-components/dist/Review.js\";</code>\n---\n\n\n### **Slots:**\n - **reviewButton** - Slot for a button for writing a review.\n- **defaultText** - Slot for the default text when there are no reviews or rating.\n- **default** - Slot for rating bars.",
+          "doc-url": "",
+          "attributes": [
+            {
+              "name": "rating",
+              "description": "Defines the rating.",
+              "value": { "type": "number", "default": "0" }
+            },
+            {
+              "name": "reviews",
+              "description": "Defines the total number of reviews.",
+              "value": { "type": "number", "default": "0" }
+            }
+          ],
+          "slots": [
+            {
+              "name": "reviewButton",
+              "description": "Slot for a button for writing a review."
+            },
+            {
+              "name": "defaultText",
+              "description": "Slot for the default text when there are no reviews or rating."
+            },
+            { "name": "default", "description": "Slot for rating bars." }
+          ],
+          "events": [],
+          "js": {
+            "properties": [
+              {
+                "name": "rating",
+                "description": "Defines the rating.",
+                "value": { "type": "number" }
+              },
+              {
+                "name": "reviews",
+                "description": "Defines the total number of reviews.",
+                "value": { "type": "number" }
+              }
+            ],
+            "events": []
+          }
+        },
         {
           "name": "udex-search",
-          "description": "<h3 class=\"comment-api-title\">Overview</h3>\n\n\n<h3>Usage</h3>\n\nFor the <code>udex-search</code>\n<h3>ES6 Module Import</h3>\n\n<code>import @udex/web-components/dist/Search.js\";</code>\n---\n\n\n### **Events:**\n - **submit-search-value** - Fired event when the user submitted the value.\n- **handle-value-search** - Fired event when the user typed to search field.\n- **handle-value-reset** - Fired event when the user clicks on the reset button.\n- **dropdown-item-click** - Fired event when the user clicks on the item inside the popover.\n- **prefix-item-click** - Fired event when the user clicks on the intem inside the prefix dropdown.\n\n### **Slots:**\n - **default** - Defines the prefix dropdown of the Search component.",
+          "description": "<h3 class=\"comment-api-title\">Overview</h3>\n\n\n<h3>Usage</h3>\n\nFor the <code>udex-search</code>\n<h3>ES6 Module Import</h3>\n\n<code>import @udex/web-components/dist/Search.js\";</code>\n---\n\n\n### **Events:**\n - **submit-search-value** - Fired event when the user submitted the value.\n- **handle-value-search** - Fired event when the user typed to search field.\n- **handle-value-reset** - Fired event when the user clicks on the reset button.\n- **handle-close-search** - Fired event when the user presses escape in search field.\n- **dropdown-item-click** - Fired event when the user clicks on the item inside the popover.\n- **prefix-item-click** - Fired event when the user clicks on the intem inside the prefix dropdown.\n\n### **Slots:**\n - **default** - Defines the prefix dropdown of the Search component.",
           "doc-url": "",
           "attributes": [
             {
@@ -4417,6 +4557,31 @@
               "description": "Defines the accessible ARIA name of the component.",
               "value": { "type": "string", "default": "\"\"" }
             },
+            {
+              "name": "accessible-name-reset-icon",
+              "description": "Defines the accessible ARIA name of the reset icon.",
+              "value": { "type": "string", "default": "\"Clear\"" }
+            },
+            {
+              "name": "accessible-name-search-icon",
+              "description": "Defines the accessible ARIA name of the search icon (applied just when \"nonInteractiveSubmitButton\" is active).",
+              "value": { "type": "string", "default": "\"Search\"" }
+            },
+            {
+              "name": "tooltip-reset-button",
+              "description": "Defines the tooltip of the clear button.",
+              "value": { "type": "string", "default": "\"Clear\"" }
+            },
+            {
+              "name": "tooltip-voice-button",
+              "description": "Defines the tooltip of the voice button.",
+              "value": { "type": "string", "default": "\"Voice\"" }
+            },
+            {
+              "name": "tooltip-submit-button",
+              "description": "Defines the tooltip of the submit button.",
+              "value": { "type": "string", "default": "\"Search\"" }
+            },
             {
               "name": "no-result-text",
               "description": "Defines the text if the suggestion list doesn't return results.",
@@ -4442,6 +4607,10 @@
               "name": "handle-value-reset",
               "description": "Fired event when the user clicks on the reset button."
             },
+            {
+              "name": "handle-close-search",
+              "description": "Fired event when the user presses escape in search field."
+            },
             {
               "name": "dropdown-item-click",
               "description": "Fired event when the user clicks on the item inside the popover."
@@ -4518,6 +4687,31 @@
                 "description": "Defines the accessible ARIA name of the component.",
                 "value": { "type": "string" }
               },
+              {
+                "name": "accessible-name-reset-icon",
+                "description": "Defines the accessible ARIA name of the reset icon.",
+                "value": { "type": "string" }
+              },
+              {
+                "name": "accessible-name-search-icon",
+                "description": "Defines the accessible ARIA name of the search icon (applied just when \"nonInteractiveSubmitButton\" is active).",
+                "value": { "type": "string" }
+              },
+              {
+                "name": "tooltip-reset-button",
+                "description": "Defines the tooltip of the clear button.",
+                "value": { "type": "string" }
+              },
+              {
+                "name": "tooltip-voice-button",
+                "description": "Defines the tooltip of the voice button.",
+                "value": { "type": "string" }
+              },
+              {
+                "name": "tooltip-submit-button",
+                "description": "Defines the tooltip of the submit button.",
+                "value": { "type": "string" }
+              },
               {
                 "name": "no-result-text",
                 "description": "Defines the text if the suggestion list doesn't return results.",
@@ -4537,6 +4731,10 @@
                 "name": "handle-value-reset",
                 "description": "Fired event when the user clicks on the reset button."
               },
+              {
+                "name": "handle-close-search",
+                "description": "Fired event when the user presses escape in search field."
+              },
               {
                 "name": "dropdown-item-click",
                 "description": "Fired event when the user clicks on the item inside the popover."
@@ -4567,6 +4765,11 @@
               "name": "title",
               "description": "Defines the title of the component.",
               "value": { "type": "string", "default": "\"\"" }
+            },
+            {
+              "name": "title-href",
+              "description": "Defines the href of the title.",
+              "value": { "type": "string", "default": "\"\"" }
             }
           ],
           "slots": [
@@ -4595,6 +4798,11 @@
                 "name": "title",
                 "description": "Defines the title of the component.",
                 "value": { "type": "string" }
+              },
+              {
+                "name": "title-href",
+                "description": "Defines the href of the title.",
+                "value": { "type": "string" }
               }
             ],
             "events": [
@@ -4605,6 +4813,127 @@
             ]
           }
         },
+        {
+          "name": "udex-secondary-navigation-sub-item",
+          "description": "<h3 class=\"comment-api-title\">Overview</h3>\n\n\n<h3>Usage</h3>\n\nFor the <code>udex-secondary-navigation-sub-item</code>\n<h3>ES6 Module Import</h3>\n\n<code>import \"@udex/web-components/dist/SecondaryNavigationSubItem.js\";</code>\n---\n\n\n### **Events:**\n - **sub-item-click** - Fires when item is clicked\n- **back-item-click** - Fires when back item is clicked",
+          "doc-url": "",
+          "attributes": [
+            {
+              "name": "is-active",
+              "description": "Defines active item.",
+              "value": { "type": "boolean", "default": "false" }
+            },
+            {
+              "name": "is-back",
+              "description": "Defines back item.",
+              "value": { "type": "boolean", "default": "false" }
+            },
+            {
+              "name": "mobile-link-title",
+              "description": "Defines an aria label for item",
+              "value": { "type": "string" }
+            },
+            {
+              "name": "active",
+              "description": "Defines active state for the item",
+              "value": { "type": "boolean" }
+            },
+            {
+              "name": "path",
+              "description": "Defines path for the item",
+              "value": { "type": "string" }
+            },
+            {
+              "name": "target",
+              "description": "Defines target for the item",
+              "value": { "type": "Target" }
+            },
+            {
+              "name": "sub-title",
+              "description": "Defines subTitle for the item",
+              "value": { "type": "string" }
+            },
+            {
+              "name": "label",
+              "description": "Defines label for the item",
+              "value": { "type": "string" }
+            },
+            {
+              "name": "index",
+              "description": "Defines the index for the item.",
+              "value": { "type": "number" }
+            }
+          ],
+          "events": [
+            {
+              "name": "sub-item-click",
+              "description": "Fires when item is clicked"
+            },
+            {
+              "name": "back-item-click",
+              "description": "Fires when back item is clicked"
+            }
+          ],
+          "js": {
+            "properties": [
+              {
+                "name": "is-active",
+                "description": "Defines active item.",
+                "value": { "type": "boolean" }
+              },
+              {
+                "name": "is-back",
+                "description": "Defines back item.",
+                "value": { "type": "boolean" }
+              },
+              {
+                "name": "mobile-link-title",
+                "description": "Defines an aria label for item",
+                "value": { "type": "string" }
+              },
+              {
+                "name": "active",
+                "description": "Defines active state for the item",
+                "value": { "type": "boolean" }
+              },
+              {
+                "name": "path",
+                "description": "Defines path for the item",
+                "value": { "type": "string" }
+              },
+              {
+                "name": "target",
+                "description": "Defines target for the item",
+                "value": { "type": "Target" }
+              },
+              {
+                "name": "sub-title",
+                "description": "Defines subTitle for the item",
+                "value": { "type": "string" }
+              },
+              {
+                "name": "label",
+                "description": "Defines label for the item",
+                "value": { "type": "string" }
+              },
+              {
+                "name": "index",
+                "description": "Defines the index for the item.",
+                "value": { "type": "number" }
+              }
+            ],
+            "events": [
+              {
+                "name": "sub-item-click",
+                "description": "Fires when item is clicked"
+              },
+              {
+                "name": "back-item-click",
+                "description": "Fires when back item is clicked"
+              }
+            ]
+          }
+        },
         {
           "name": "udex-segmented-button",
           "description": "<h3 class=\"comment-api-title\">Overview</h3>\n\n\n<h3>Usage</h3>\n\nFor the <code>udex-segmented-button</code>\n<h3>ES6 Module Import</h3>\n\n<code>import \"@udex/web-components/dist/SegmentedButton.js\";</code>\n---\n",
@@ -5375,6 +5704,57 @@
           "events": [],
           "js": { "properties": [], "events": [] }
         },
+        {
+          "name": "udex-status-badge",
+          "description": "<h3 class=\"comment-api-title\">Overview</h3>\n\n\n<h3>Usage</h3>\n\nFor the <code>udex-status-badge</code>\n<h3>ES6 Module Import</h3>\n\n<code>import \"@udex/web-components/dist/StatusBadge.js\";</code>\n---\n",
+          "doc-url": "",
+          "attributes": [
+            {
+              "name": "value-state",
+              "description": "Defines the value state of the component.",
+              "value": {
+                "type": "\"Success\" | \"Error\" | \"Warning\" | \"Information\" | \"Edit\"",
+                "default": "\"Information\""
+              }
+            },
+            {
+              "name": "size",
+              "description": "Defines predefined size of the component.",
+              "value": {
+                "type": "\"XS\" | \"S\" | \"M\" | \"L\" | \"XL\"",
+                "default": "\"S\""
+              }
+            },
+            {
+              "name": "accessible-name",
+              "description": "Defines the text alternative of the component.",
+              "value": { "type": "string", "default": "\"\"" }
+            }
+          ],
+          "events": [],
+          "js": {
+            "properties": [
+              {
+                "name": "value-state",
+                "description": "Defines the value state of the component.",
+                "value": {
+                  "type": "\"Success\" | \"Error\" | \"Warning\" | \"Information\" | \"Edit\""
+                }
+              },
+              {
+                "name": "size",
+                "description": "Defines predefined size of the component.",
+                "value": { "type": "\"XS\" | \"S\" | \"M\" | \"L\" | \"XL\"" }
+              },
+              {
+                "name": "accessible-name",
+                "description": "Defines the text alternative of the component.",
+                "value": { "type": "string" }
+              }
+            ],
+            "events": []
+          }
+        },
         {
           "name": "udex-status-message",
           "description": "<h3 class=\"comment-api-title\">Overview</h3>\n\n\n<h3>Usage</h3>\n\nFor the <code>udex-status-message</code>\n<h3>ES6 Module Import</h3>\n\n<code>import \"@udex/web-components/dist/StatusMessage.js\";</code>\n---\n",