@sapudex/web-components 0.117.1 → 0.127.6

package/dist/vscode.html-custom-data.json

@@ -24,7 +24,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.",
           "values": []
         },
         {
@@ -115,6 +115,12 @@
       ],
       "references": []
     },
+    {
+      "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\n---\n\n\n",
+      "attributes": [],
+      "references": []
+    },
     {
       "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\n\n\n\n### **Slots:**\n - **default** - Defines the content of the component.",
@@ -469,6 +475,11 @@
             { "name": "AlertDialog" }
           ]
         },
+        {
+          "name": "trigger-accessible-role",
+          "description": "Allows setting a custom role for dropdown trigger.",
+          "values": []
+        },
         {
           "name": "open",
           "description": "Indicates if the dropdown pane is open",
@@ -580,6 +591,11 @@
             { "name": "AlertDialog" }
           ]
         },
+        {
+          "name": "trigger-accessible-role",
+          "description": "Allows setting a custom role for dropdown trigger.",
+          "values": []
+        },
         {
           "name": "no-result-text",
           "description": "Defines the \"no result\" text of the component.",
@@ -819,6 +835,11 @@
       "name": "udex-footer",
       "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\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",
       "attributes": [
+        {
+          "name": "logo-title",
+          "description": "Defines the Logo default title",
+          "values": []
+        },
         {
           "name": "logo-url",
           "description": "Defines the Logo URL",
@@ -874,7 +895,12 @@
           "description": "List of the Social links and their icons",
           "values": []
         },
-        { "name": "logo-alt", "description": "Alt for Logo", "values": [] }
+        { "name": "logo-alt", "description": "Alt for Logo", "values": [] },
+        {
+          "name": "logo-aria-label",
+          "description": "Defines an aria label for the logo link",
+          "values": []
+        }
       ],
       "references": []
     },
@@ -1629,6 +1655,11 @@
           "description": "Defines the Logo image URL",
           "values": []
         },
+        {
+          "name": "logo-title",
+          "description": "Defines the Logo default title",
+          "values": []
+        },
         {
           "name": "site-label",
           "description": "Defines a site label. It will be displayed next to a logo.",
@@ -1881,11 +1912,6 @@
       "name": "udex-password-field",
       "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\n---\n\n\n",
       "attributes": [
-        {
-          "name": "type",
-          "description": "Defines supporting text under the input field.",
-          "values": []
-        },
         {
           "name": "disabled",
           "description": "Defines whether the component is in disabled state.\n<br><br>\n<b>Note:</b> A disabled component is completely noninteractive.",
@@ -1914,12 +1940,7 @@
         {
           "name": "value-state",
           "description": "Defines the value state of the component.",
-          "values": [
-            { "name": "Success" },
-            { "name": "Error" },
-            { "name": "Warning" },
-            { "name": "Standard" }
-          ]
+          "values": [{ "name": "ValueState" }]
         },
         {
           "name": "supporting-text",
@@ -2076,6 +2097,28 @@
       "attributes": [],
       "references": []
     },
+    {
+      "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\n---\n\n\n",
+      "attributes": [
+        {
+          "name": "rating",
+          "description": "Defines the associated rating.",
+          "values": []
+        },
+        {
+          "name": "percentage",
+          "description": "Defines the percentage.",
+          "values": []
+        },
+        {
+          "name": "show-percentage",
+          "description": "Defines wether the percentage is shown or not.",
+          "values": []
+        }
+      ],
+      "references": []
+    },
     {
       "name": "udex-rating-indicator",
       "description": "### Overview\n\n### ES6 Module Import\n\n`import @udex/web-components/dist/RatingIndicator.js\";`\n\n\n---\n\n\n",
@@ -2093,6 +2136,23 @@
       ],
       "references": []
     },
+    {
+      "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\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.",
+      "attributes": [
+        {
+          "name": "rating",
+          "description": "Defines the rating.",
+          "values": []
+        },
+        {
+          "name": "reviews",
+          "description": "Defines the total number of reviews.",
+          "values": []
+        }
+      ],
+      "references": []
+    },
     {
       "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\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.",
@@ -2162,6 +2222,31 @@
           "description": "Defines the accessible ARIA name of the component.",
           "values": []
         },
+        {
+          "name": "accessible-name-reset-icon",
+          "description": "Defines the accessible ARIA name of the reset icon.",
+          "values": []
+        },
+        {
+          "name": "accessible-name-search-icon",
+          "description": "Defines the accessible ARIA name of the search icon (applied just when \"nonInteractiveSubmitButton\" is active).",
+          "values": []
+        },
+        {
+          "name": "tooltip-reset-button",
+          "description": "Defines the tooltip of the clear button.",
+          "values": []
+        },
+        {
+          "name": "tooltip-voice-button",
+          "description": "Defines the tooltip of the voice button.",
+          "values": []
+        },
+        {
+          "name": "tooltip-submit-button",
+          "description": "Defines the tooltip of the submit button.",
+          "values": []
+        },
         {
           "name": "no-result-text",
           "description": "Defines the text if the suggestion list doesn't return results.",
@@ -2172,7 +2257,7 @@
     },
     {
       "name": "udex-searchable-list-base",
-      "description": "A class to serve as a foundation\nfor the <code>UDExFilterMenu</code> and <code>UDExSelectBox</code> classes.\n\n\n---\n\n\n\n\n### **Events:**\n - **selection-change** - \n- **select-all** - Fired event when the user clicks on the Select All header.\n- **submit-search** - Fired event when the user clicks on the submitted icon in the search.\n- **reset-search** - Fired event when the user clicks on the reset button in the search.\n- **change-search** - Fired event when the user submitted the value in the search.\n\n### **Slots:**\n - **default** - Slot for items.",
+      "description": "A class to serve as a foundation\nfor the <code>UDExFilterMenu</code> , <code>UDExSelectBox</code> and <code>UDExCountrySelector/code> classes.\n\n\n---\n\n\n\n\n### **Events:**\n - **selection-change** - \n- **select-all** - Fired event when the user clicks on the Select All header.\n- **submit-search** - Fired event when the user clicks on the submitted icon in the search.\n- **reset-search** - Fired event when the user clicks on the reset button in the search.\n- **change-search** - Fired event when the user submitted the value in the search.\n\n### **Slots:**\n - **default** - Slot for items.",
       "attributes": [
         {
           "name": "no-result-text",
@@ -2209,7 +2294,7 @@
     },
     {
       "name": "udex-secondary-navigation",
-      "description": "<h3 class=\"comment-api-title\">Overview</h3>\n\n\n<h3>Usage</h3>\n\nFor the <code>udex-secondary-navigation</code>\n<h3>ES6 Module Import</h3>\n\n<code>import \"@udex/web-components/dist/SecondaryNavigation.js\";</code>\n\n\n---\n\n\n\n\n### **Events:**\n - **item-click** - Fires when item is clicked\n- **sub-item-click** - Fires when sub item is clicked\n\n### **Slots:**\n - **breadcrumbs** - Slot for breadcrumbs.\n- **buttons** - Slot for action buttons.",
+      "description": "<h3 class=\"comment-api-title\">Overview</h3>\n\n\n<h3>Usage</h3>\n\nFor the <code>udex-secondary-navigation</code>\n<h3>ES6 Module Import</h3>\n\n<code>import \"@udex/web-components/dist/SecondaryNavigation.js\";</code>\n\n\n---\n\n\n\n\n### **Events:**\n - **item-click** - Fires when item is clicked\n\n### **Slots:**\n - **breadcrumbs** - Slot for breadcrumbs.\n- **buttons** - Slot for action buttons.",
       "attributes": [
         {
           "name": "mobile-menu-opener-aria-label",
@@ -2238,6 +2323,11 @@
       "name": "udex-secondary-navigation-item-base",
       "description": "A class to serve as a foundation\nfor the <code>UDExSecondaryNavigationItem</code> and <code>UDExSecondaryNavigationSubItem</code> classes.\n\n\n---\n\n\n",
       "attributes": [
+        {
+          "name": "mobile-link-title",
+          "description": "Defines an aria label for item",
+          "values": []
+        },
         {
           "name": "active",
           "description": "Defines active state for the item",
@@ -2251,7 +2341,7 @@
         {
           "name": "target",
           "description": "Defines target for the item",
-          "values": []
+          "values": [{ "name": "Target" }]
         },
         {
           "name": "sub-title",
@@ -2285,6 +2375,11 @@
           "description": "Defines back item.",
           "values": []
         },
+        {
+          "name": "mobile-link-title",
+          "description": "Defines an aria label for item",
+          "values": []
+        },
         {
           "name": "active",
           "description": "Defines active state for the item",
@@ -2298,7 +2393,7 @@
         {
           "name": "target",
           "description": "Defines target for the item",
-          "values": []
+          "values": [{ "name": "Target" }]
         },
         {
           "name": "sub-title",